rfc

Documentation

Index

• func Build(mail Mail, opts ...Option) string
• type Attachment
• type Clock
• type ClockFunc
  • func (c ClockFunc) Now() time.Time
• type IDGenerator
  • func UUIDGenerator(domain string) IDGenerator
• type IDGeneratorFunc
  • func (gen IDGeneratorFunc) GenerateID(m Mail) string
• type Mail
• type Option
  • func WithClock(c Clock) Option
  • func WithIDGenerator(gen IDGenerator) Option

Functions

func Build

func Build(mail Mail, opts ...Option) string

Build the mail according to RFC 5322.

Types

type Attachment

type Attachment struct {
	Filename string
	Content  []byte
	Header   textproto.MIMEHeader
}

Attachment is a mail attachment.

type Clock

type Clock interface {
	Now() time.Time
}

A Clock provides the current time.

type ClockFunc

type ClockFunc func() time.Time

ClockFunc allows a function to be used as a Clock.

func (ClockFunc) Now

func (c ClockFunc) Now() time.Time

Now returns the current time.

type IDGenerator

type IDGenerator interface {
	GenerateID(Mail) string
}

IDGenerator generates Message-IDs.

func UUIDGenerator

func UUIDGenerator(domain string) IDGenerator

UUIDGenerator returns a Message-ID generator using UUIDs. If domain is an empty string, GenerateID() just returns a UUID. Otherwise the generated IDs have the following format: <UUID@DOMAIN>

type IDGeneratorFunc

type IDGeneratorFunc func(Mail) string

IDGeneratorFunc allows a function to be used as an IDGenerator.

func (IDGeneratorFunc) GenerateID

func (gen IDGeneratorFunc) GenerateID(m Mail) string

GenerateID generates a Message-ID.

type Mail

type Mail struct {
	Subject     string
	From        mail.Address
	To          []mail.Address
	CC          []mail.Address
	BCC         []mail.Address
	ReplyTo     []mail.Address
	Text        string
	HTML        string
	Attachments []Attachment
}

Mail contains the data of a mail.

type Option

type Option func(*builder)

Option is a builder option.

func WithClock

func WithClock(c Clock) Option

WithClock returns an Option that overrides the used Clock.

func WithIDGenerator

func WithIDGenerator(gen IDGenerator) Option

WithIDGenerator returns an Option that overrides the used IDGenerator.