mail

Documentation

Index

• Constants
• type Mailer
  • func NewMailer(apiKey string, emailSender string, enabled bool) *Mailer
  • func (m *Mailer) AddEmailTemplate(templateName string, subject string, isHTML bool, body string)
  • func (m *Mailer) SendAccountNameReminderEmail(to string, accountName string) error
  • func (m *Mailer) SendAccountRemovedEmail(to string, accountName string) error
  • func (m *Mailer) SendAccountResetPasswordEmail(to string, accountName string, token string, address string) error
  • func (m *Mailer) SendAccountVerificationEmail(to string, accountName string, token string, url string) error
  • func (m *Mailer) SendAccountVerifiedEmail(to string, accountName string) error
  • func (m *Mailer) SendMail(to string, subject string, isHTML bool, body string) error
  • func (m *Mailer) SendOrganizationCreatedEmail(to string, organization string) error
  • func (m *Mailer) SendOrganizationRemovedEmail(to string, organization string) error
  • func (m *Mailer) SendTeamCreatedEmail(to string, team string) error
  • func (m *Mailer) SendTeamRemovedEmail(to string, team string) error
  • func (m *Mailer) SendTemplateEmail(to string, templateEmailName string, variableMap map[string]string) error
  • func (m *Mailer) SendUserAddedInOrganizationEmail(to string, organization string, user string) error
  • func (m *Mailer) SendUserAddedInTeamEmail(to string, team string, user string) error
  • func (m *Mailer) SendUserRemovedFromOrganizationEmail(to string, organization string, user string) error
  • func (m *Mailer) SendUserRemovedFromTeamEmail(to string, team string, user string) error

Constants

const (
	// DefaultSender default email sender
	DefaultSender = "none@example.com"
)

Types

type Mailer

type Mailer struct {
	// contains filtered or unexported fields
}

Mailer main mailer struct

func NewMailer

func NewMailer(apiKey string, emailSender string, enabled bool) *Mailer

NewMailer to get a Mailer instance

func (*Mailer) AddEmailTemplate

func (m *Mailer) AddEmailTemplate(templateName string, subject string, isHTML bool, body string)

AddEmailTemplate add template in the map

func (*Mailer) SendAccountNameReminderEmail

func (m *Mailer) SendAccountNameReminderEmail(to string, accountName string) error

SendAccountNameReminderEmail send a AccountNameReminder email template

func (*Mailer) SendAccountRemovedEmail

func (m *Mailer) SendAccountRemovedEmail(to string, accountName string) error

SendAccountRemovedEmail send mail

func (*Mailer) SendAccountResetPasswordEmail

func (m *Mailer) SendAccountResetPasswordEmail(to string, accountName string, token string, address string) error

SendAccountResetPasswordEmail send a AccountResetPassword email template

func (*Mailer) SendAccountVerificationEmail

func (m *Mailer) SendAccountVerificationEmail(to string, accountName string, token string, url string) error

SendAccountVerificationEmail send mail

func (*Mailer) SendAccountVerifiedEmail

func (m *Mailer) SendAccountVerifiedEmail(to string, accountName string) error

SendAccountVerifiedEmail send mail

func (*Mailer) SendMail

func (m *Mailer) SendMail(to string, subject string, isHTML bool, body string) error

SendMail send an email to "to" with subject and body, use configuration

func (*Mailer) SendOrganizationCreatedEmail

func (m *Mailer) SendOrganizationCreatedEmail(to string, organization string) error

SendOrganizationCreatedEmail send mail

func (*Mailer) SendOrganizationRemovedEmail

func (m *Mailer) SendOrganizationRemovedEmail(to string, organization string) error

SendOrganizationRemovedEmail send mail

func (*Mailer) SendTeamCreatedEmail

func (m *Mailer) SendTeamCreatedEmail(to string, team string) error

SendTeamCreatedEmail send mail

func (*Mailer) SendTeamRemovedEmail

func (m *Mailer) SendTeamRemovedEmail(to string, team string) error

SendTeamRemovedEmail send mail

func (*Mailer) SendTemplateEmail

func (m *Mailer) SendTemplateEmail(to string, templateEmailName string, variableMap map[string]string) error

SendTemplateEmail send a tempalte email

func (*Mailer) SendUserAddedInOrganizationEmail

func (m *Mailer) SendUserAddedInOrganizationEmail(to string, organization string, user string) error

SendUserAddedInOrganizationEmail send mail

func (*Mailer) SendUserAddedInTeamEmail

func (m *Mailer) SendUserAddedInTeamEmail(to string, team string, user string) error

SendUserAddedInTeamEmail send mail

func (*Mailer) SendUserRemovedFromOrganizationEmail

func (m *Mailer) SendUserRemovedFromOrganizationEmail(to string, organization string, user string) error

SendUserRemovedFromOrganizationEmail send mail

func (*Mailer) SendUserRemovedFromTeamEmail

func (m *Mailer) SendUserRemovedFromTeamEmail(to string, team string, user string) error

SendUserRemovedFromTeamEmail send mail