emails

Apr 18, 2024

Changes in this version

+ var ErrEmailUnparsable = errors.New("could not parse email address")

Mar 26, 2024

Changes in this version

type Config

+ ConsoleURLConfig ConsoleURLConfig

+ MarketingURLConfig MarketingURLConfig

+ type ConsoleURLConfig struct

+ ConsoleBase string

+ Invite string

+ Reset string

+ Verify string

+ func (c ConsoleURLConfig) Validate() error

type EmailManager

+ func (m *EmailManager) InviteURL(token string) (string, error)

+ func (m *EmailManager) ResetURL(token string) (string, error)

+ func (m *EmailManager) SubscriberVerifyURL(token string) (string, error)

+ func (m *EmailManager) VerifyURL(token string) (string, error)

+ type MarketingURLConfig struct

+ DefaultSubscriptionOrg string

+ MarketingBase string

+ SubscriberVerify string

+ func (c MarketingURLConfig) Validate() error

+ type ResetSuccessData struct

Mar 17, 2024

Changes in this version

+ const Subscribed

+ func SubscribeEmail(data SubscriberEmailData) (message *mail.SGMailV3, err error)

+ type SubscriberEmailData struct

+ OrgName string

+ VerifySubscriberURL string

type URLConfig

+ DefaultSubscriptionOrg string

+ SubscriberVerify string

+ func (c URLConfig) SubscriberVerifyURL(token string) (string, error)

Mar 8, 2024

Changes in this version

type Config

+ URLConfig URLConfig

Mar 1, 2024

Changes in this version

+ const DateFormat

+ const InviteBeenAccepted

+ const InviteRE

+ const PasswordResetRequestRE

+ const PasswordResetSuccessRE

+ const UnknownDate

+ const VerifyEmailRE

+ const WelcomeRE

+ var ErrAdminEmailNotParseable = errors.New("invalid configuration: admin email is unparsable")

+ var ErrBothAdminAndFromRequired = errors.New(...)

+ var ErrEmailArchiveOnlyInTestMode = errors.New("invalid configuration: email archiving is only supported in testing mode")

+ var ErrEmailNotParseable = errors.New("invalid configuration: from email is unparsable")

+ var ErrEmailUnparseable = errors.New("could not parse email address")

+ var ErrFailedToCreateEmailClient = errors.New("cannot create email client without API key")

+ var ErrMissingRecipient = errors.New("missing email recipient")

+ var ErrMissingSender = errors.New("missing email sender")

+ var ErrMissingSubject = errors.New("missing email subject")

+ var ErrSendgridNotEnabled = errors.New("sendgrid is not enabled, cannot add contact")

+ func AttachCSV(message *mail.SGMailV3, data []byte, filename string) (err error)

+ func AttachData(message *mail.SGMailV3, data []byte, filename, mimetype string) error

+ func AttachJSON(message *mail.SGMailV3, data []byte, filename string) (err error)

+ func InviteAccepted(data InviteData) (message *mail.SGMailV3, err error)

+ func InviteEmail(data InviteData) (message *mail.SGMailV3, err error)

+ func LoadAttachment(message *mail.SGMailV3, attachmentPath string) (err error)

+ func PasswordResetRequestEmail(data ResetRequestData) (message *mail.SGMailV3, err error)

+ func PasswordResetSuccessEmail(data EmailData) (message *mail.SGMailV3, err error)

+ func Render(name string, data interface{}) (text, html string, err error)

+ func VerifyEmail(data VerifyEmailData) (message *mail.SGMailV3, err error)

+ func WelcomeEmail(data WelcomeData) (message *mail.SGMailV3, err error)

+ type Config struct

+ AdminEmail string

+ Archive string

+ DatumListID string

+ FromEmail string

+ SendGridAPIKey string

+ Testing bool

+ type EmailData struct

+ Recipient sendgrid.Contact

+ Sender sendgrid.Contact

+ Subject string

+ func (e EmailData) Build(text, html string) (msg *mail.SGMailV3, err error)

+ func (e EmailData) Validate() error

+ type EmailManager struct

+ func New(conf Config) (m *EmailManager, err error)

+ func (m *EmailManager) AddContact(contact *sg.Contact, listIDs ...string) (err error)

+ func (m *EmailManager) AdminContact() (sendgrid.Contact, error)

+ func (m *EmailManager) Enabled() bool

+ func (m *EmailManager) FromContact() (sendgrid.Contact, error)

+ func (m *EmailManager) GetAdminEmail() string

+ func (m *EmailManager) GetArchive() string

+ func (m *EmailManager) GetDatumListID() string

+ func (m *EmailManager) GetFromEmail() string

+ func (m *EmailManager) GetSendGridAPIKey() string

+ func (m *EmailManager) GetTesting() bool

+ func (m *EmailManager) MustAdminContact() sendgrid.Contact

+ func (m *EmailManager) MustFromContact() sendgrid.Contact

+ func (m *EmailManager) Send(message *sgmail.SGMailV3) (err error)

+ func (m *EmailManager) SendAddedtoOrgEmail(i *Invite) error

+ func (m *EmailManager) SendOrgInvitationEmail(i *Invite) error

+ func (m *EmailManager) SetAdminEmail(email string)

+ func (m *EmailManager) SetArchive(archive string)

+ func (m *EmailManager) SetDatumListID(id string)

+ func (m *EmailManager) SetFromEmail(email string)

+ func (m *EmailManager) SetSendGridAPIKey(key string)

+ func (m *EmailManager) SetTesting(testing bool)

+ func (m *EmailManager) Validate() (err error)

+ type InvalidEmailConfigError struct

+ RequiredField string

+ func (e *InvalidEmailConfigError) Error() string

+ type Invite struct

+ OrgName string

+ Recipient string

+ Requestor string

+ Role string

+ Token string

+ type InviteData struct

+ Email string

+ InviteURL string

+ InviterName string

+ OrgName string

+ Role string

+ type MissingRequiredFieldError struct

+ RequiredField string

+ func (e *MissingRequiredFieldError) Error() string

+ type ResetRequestData struct

+ ResetURL string

+ type SendGridClient interface

+ Send func(email *sgmail.SGMailV3) (*rest.Response, error)

+ type URLConfig struct

+ Base string

+ Invite string

+ Reset string

+ Verify string

+ func (c URLConfig) InviteURL(token string) (string, error)

+ func (c URLConfig) ResetURL(token string) (string, error)

+ func (c URLConfig) Validate() error

+ func (c URLConfig) VerifyURL(token string) (string, error)

+ type VerifyEmailData struct

+ FullName string

+ VerifyURL string

+ type WelcomeData struct

+ Domain string

+ Email string

+ FirstName string

+ LastName string

+ Organization string