Documentation
¶
Index ¶
- Constants
- type CustomerIOMailer
- func (m *CustomerIOMailer) ConfirmationMail(user *models.User, referrerURL string) error
- func (m *CustomerIOMailer) EmailChangeMail(user *models.User, referrerURL string) error
- func (m *CustomerIOMailer) InviteMail(user *models.User, referrerURL string) error
- func (m CustomerIOMailer) RecoveryMail(user *models.User, referrerURL string) error
- func (m CustomerIOMailer) Send(user *models.User, subject, body string, data map[string]interface{}) error
- func (m *CustomerIOMailer) TigrisInviteMail(email string, invitedByName string, code string, invitedOrgCode string, ...) error
- func (m CustomerIOMailer) ValidateEmail(email string) error
- type Mailer
- type TemplateMailer
- func (m *TemplateMailer) ConfirmationMail(user *models.User, referrerURL string) error
- func (m *TemplateMailer) EmailChangeMail(user *models.User, referrerURL string) error
- func (m *TemplateMailer) InviteMail(user *models.User, referrerURL string) error
- func (m *TemplateMailer) RecoveryMail(user *models.User, referrerURL string) error
- func (m TemplateMailer) Send(user *models.User, subject, body string, data map[string]interface{}) error
- func (m *TemplateMailer) TigrisInviteMail(email string, invitedByName string, code string, invitedOrgCode string, ...) error
- func (m TemplateMailer) ValidateEmail(email string) error
Constants ¶
View Source
const ( CustomerIOMailerType = "customerio" TemplateMailerType = "template" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CustomerIOMailer ¶
type CustomerIOMailer struct {
Config *conf.Configuration
// contains filtered or unexported fields
}
func (*CustomerIOMailer) ConfirmationMail ¶
func (m *CustomerIOMailer) ConfirmationMail(user *models.User, referrerURL string) error
func (*CustomerIOMailer) EmailChangeMail ¶
func (m *CustomerIOMailer) EmailChangeMail(user *models.User, referrerURL string) error
func (*CustomerIOMailer) InviteMail ¶
func (m *CustomerIOMailer) InviteMail(user *models.User, referrerURL string) error
func (CustomerIOMailer) RecoveryMail ¶
func (m CustomerIOMailer) RecoveryMail(user *models.User, referrerURL string) error
func (*CustomerIOMailer) TigrisInviteMail ¶
func (CustomerIOMailer) ValidateEmail ¶
func (m CustomerIOMailer) ValidateEmail(email string) error
type Mailer ¶
type Mailer interface {
Send(user *models.User, subject, body string, data map[string]interface{}) error
// not used by tigris
InviteMail(user *models.User, referrerURL string) error
// used by tigris
TigrisInviteMail(email string, invitedByName string, code string, invitedOrgCode string, invitedOrgName string, role string, expirationTime int64) error
ConfirmationMail(user *models.User, referrerURL string) error
RecoveryMail(user *models.User, referrerURL string) error
EmailChangeMail(user *models.User, referrerURL string) error
ValidateEmail(email string) error
}
Mailer defines the interface a mailer must implement.
func NewMailer ¶
func NewMailer(instanceConfig *conf.Configuration) Mailer
NewMailer returns a new gotrue mailer
type TemplateMailer ¶
type TemplateMailer struct {
SiteURL string
Config *conf.Configuration
Mailer *mailme.Mailer
}
TemplateMailer will send mail and use templates from the site for easy mail styling
func (*TemplateMailer) ConfirmationMail ¶
func (m *TemplateMailer) ConfirmationMail(user *models.User, referrerURL string) error
ConfirmationMail sends a signup confirmation mail to a new user
func (*TemplateMailer) EmailChangeMail ¶
func (m *TemplateMailer) EmailChangeMail(user *models.User, referrerURL string) error
EmailChangeMail sends an email change confirmation mail to a user
func (*TemplateMailer) InviteMail ¶
func (m *TemplateMailer) InviteMail(user *models.User, referrerURL string) error
InviteMail sends a invite mail to a new user
func (*TemplateMailer) RecoveryMail ¶
func (m *TemplateMailer) RecoveryMail(user *models.User, referrerURL string) error
RecoveryMail sends a password recovery mail
func (TemplateMailer) Send ¶
func (m TemplateMailer) Send(user *models.User, subject, body string, data map[string]interface{}) error
Send can be used to send one-off emails to users
func (*TemplateMailer) TigrisInviteMail ¶
func (m *TemplateMailer) TigrisInviteMail(email string, invitedByName string, code string, invitedOrgCode string, invitedOrgName string, role string, expirationTime int64) error
TigrisInviteMail sends a invite mail to the invited user
func (TemplateMailer) ValidateEmail ¶
func (m TemplateMailer) ValidateEmail(email string) error
ValidateEmail returns nil if the email is valid, otherwise an error indicating the reason it is invalid
Source Files
Click to show internal directories.
Click to hide internal directories.