mailman

Documentation

Index

• type Client
  • func New(topic *pubsub.Topic, domain, sender, environmentName string) *Client
  • func (c *Client) NewEmail(subject string, recipients ...string) *email
  • func (c *Client) Send(ctx context.Context, email *email) (msgID string, err error)

Types

type Client

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

Client allows sending emails to a recipient.

func New

func New(topic *pubsub.Topic, domain, sender, environmentName string) *Client

New creates a new Client client to send emails.

func (*Client) NewEmail

func (c *Client) NewEmail(subject string, recipients ...string) *email

NewEmail creates a new *email struct. nolint: revive // Intended to force builder pattern

func (*Client) Send

func (c *Client) Send(
	ctx context.Context,
	email *email) (msgID string, err error)

Send publishes a new email message to the `emails` topic which is being subscribed by the Mailman Google Cloud Function.