Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

emails

package

Go to main page

Versions in this module

v0

v0.2.1

Sep 19, 2024

v0.2.0

Sep 13, 2024

v0.1.5

Aug 29, 2024

v0.1.4

Aug 29, 2024

v0.1.3

Aug 29, 2024

v0.1.2

Aug 27, 2024

Changes in this version

+ const DateFormat

+ const InviteBeenAccepted

+ const InviteRE

+ const PasswordResetRequestRE

+ const PasswordResetSuccessRE

+ const Subscribed

+ const UnknownDate

+ const VerifyEmailRE

+ const WelcomeRE

+ var ErrAdminEmailNotParsable = 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 ErrEmailNotParsable = errors.New("invalid configuration: from email is unparsable")

+ var ErrEmailUnparsable = 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 ResetSuccessData) (message *mail.SGMailV3, err error)

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

+ func SubscribeEmail(data SubscriberEmailData) (message *mail.SGMailV3, 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

+ ConsoleURLConfig ConsoleURLConfig

+ FromEmail string

+ ListID string

+ MarketingURLConfig MarketingURLConfig

+ SendGridAPIKey string

+ Testing bool

+ type ConsoleURLConfig struct

+ ConsoleBase string

+ Invite string

+ Reset string

+ Verify string

+ func (c ConsoleURLConfig) Validate() error

+ 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 *sendgrid.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) GetFromEmail() string

+ func (m *EmailManager) GetListID() string

+ func (m *EmailManager) GetSendGridAPIKey() string

+ func (m *EmailManager) GetTesting() bool

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

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

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

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

+ 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) SetFromEmail(email string)

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

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

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

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

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

+ func (m *EmailManager) VerifyURL(token string) (string, 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 MarketingURLConfig struct

+ MarketingBase string

+ SubscriberVerify string

+ func (c MarketingURLConfig) Validate() error

+ type MissingRequiredFieldError struct

+ RequiredField string

+ func (e *MissingRequiredFieldError) Error() string

+ type ResetRequestData struct

+ ResetURL string

+ type ResetSuccessData struct

+ type SendGridClient interface

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

+ type SubscriberEmailData struct

+ OrgName string

+ VerifySubscriberURL string

+ type VerifyEmailData struct

+ FullName string

+ VerifyURL string

+ type WelcomeData struct

+ Domain string

+ Email string

+ FirstName string

+ LastName string

+ Organization string

v0.1.1

Aug 27, 2024

v0.1.0

Aug 25, 2024