mail

Documentation

Index

• type BrevoEmail
• type BrevoEmailRequest
• type BrevoMailClient
  • func NewBrevoMailClient(httpClient *http.Client, apiKey, apiURL string) *BrevoMailClient
  • func (b *BrevoMailClient) SendEmail(ctx context.Context, email *EmailBuilder) error
• type BrevoMessageVersion
• type EmailBuilder
  • func NewEmail() *EmailBuilder
  • func (e *EmailBuilder) AddMessages(msgs []*MessageBuilder) *EmailBuilder
  • func (b *EmailBuilder) Build() (*BrevoEmailRequest, error)
  • func (b *EmailBuilder) Sender(email, name string) *EmailBuilder
  • func (b *EmailBuilder) SetParam(key string, value any) *EmailBuilder
  • func (b *EmailBuilder) Subject(subject string) *EmailBuilder
  • func (b *EmailBuilder) TemplateID(id int) *EmailBuilder
  • func (b *EmailBuilder) To(email, name string) *EmailBuilder
• type MessageBuilder
  • func NewMessage() *MessageBuilder
  • func (m *MessageBuilder) Build() BrevoMessageVersion
  • func (m *MessageBuilder) Param(key string, value any) *MessageBuilder
  • func (m *MessageBuilder) Params(params map[string]any) *MessageBuilder
  • func (m *MessageBuilder) Subject(subject string) *MessageBuilder
  • func (m *MessageBuilder) To(email, name string) *MessageBuilder
• type Recipient
• type Sender

Types

type BrevoEmail

type BrevoEmail struct {
	Email string `json:"email"`
	Name  string `json:"name,omitempty"`
}

type BrevoEmailRequest

type BrevoEmailRequest struct {
	Identifier      int                   `json:"-"`
	Sender          BrevoEmail            `json:"sender"`
	ReplyTo         *BrevoEmail           `json:"replyTo,omitempty"`
	To              []BrevoEmail          `json:"to,omitempty"`
	TemplateID      int                   `json:"templateId"`
	Params          map[string]any        `json:"params,omitempty"`
	MessageVersions []BrevoMessageVersion `json:"messageVersions,omitempty"`
	Subject         string                `json:"subject,omitempty"`
}

type BrevoMailClient

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

func NewBrevoMailClient

func NewBrevoMailClient(httpClient *http.Client, apiKey, apiURL string) *BrevoMailClient

func (*BrevoMailClient) SendEmail

func (b *BrevoMailClient) SendEmail(ctx context.Context, email *EmailBuilder) error

type BrevoMessageVersion

type BrevoMessageVersion struct {
	To      []BrevoEmail   `json:"to"`
	Params  map[string]any `json:"params,omitempty"`
	Subject string         `json:"subject,omitempty"`
}

type EmailBuilder

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

func NewEmail

func NewEmail() *EmailBuilder

func (*EmailBuilder) AddMessages

func (e *EmailBuilder) AddMessages(msgs []*MessageBuilder) *EmailBuilder

func (*EmailBuilder) Build

func (b *EmailBuilder) Build() (*BrevoEmailRequest, error)

func (*EmailBuilder) Sender

func (b *EmailBuilder) Sender(email, name string) *EmailBuilder

func (*EmailBuilder) SetParam

func (b *EmailBuilder) SetParam(key string, value any) *EmailBuilder

func (*EmailBuilder) Subject

func (b *EmailBuilder) Subject(subject string) *EmailBuilder

func (*EmailBuilder) TemplateID

func (b *EmailBuilder) TemplateID(id int) *EmailBuilder

func (*EmailBuilder) To

func (b *EmailBuilder) To(email, name string) *EmailBuilder

type MessageBuilder

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

func NewMessage

func NewMessage() *MessageBuilder

func (*MessageBuilder) Build

func (m *MessageBuilder) Build() BrevoMessageVersion

func (*MessageBuilder) Param

func (m *MessageBuilder) Param(key string, value any) *MessageBuilder

func (*MessageBuilder) Params

func (m *MessageBuilder) Params(params map[string]any) *MessageBuilder

func (*MessageBuilder) Subject

func (m *MessageBuilder) Subject(subject string) *MessageBuilder

func (*MessageBuilder) To

func (m *MessageBuilder) To(email, name string) *MessageBuilder

type Recipient

type Recipient struct {
	Email string
	Name  string
}

type Sender

type Sender struct {
	Email string
	Name  string
}