rfc

Documentation

Index

• func Build(mail Mail, opts ...Option) string
• func BuildConfig(mail Mail, cfg Config) string
• type Attachment
• type Clock
• type ClockFunc
  • func (c ClockFunc) Now() time.Time
• type Config
• type Mail
• type MessageIDFactory
  • func UUIDGenerator(domain string) MessageIDFactory
• type MessageIDFunc
  • func (id MessageIDFunc) GenerateID(m Mail) string
• type Option
  • func WithClock(c Clock) Option
  • func WithMessageID(id string) Option
  • func WithMessageIDFactory(id MessageIDFactory) Option

Functions

func Build

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

Build the mail according to RFC 5322.

func BuildConfig

func BuildConfig(mail Mail, cfg Config) string

BuildConfig 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 Config

type Config struct {
	Clock     Clock
	MessageID MessageIDFactory
}

Config is the builder config.

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 MessageIDFactory

type MessageIDFactory interface {
	GenerateID(Mail) string
}

MessageIDFactory generates Message-IDs.

func UUIDGenerator

func UUIDGenerator(domain string) MessageIDFactory

UUIDGenerator returns a Message-ID factory using UUIDs. If domain is an empty string, it is set to "localhost". The generated IDs have the following format: <UUID@DOMAIN>

type MessageIDFunc

type MessageIDFunc func(Mail) string

MessageIDFunc allows a function to be used as an MessageIDFactory.

func (MessageIDFunc) GenerateID

func (id MessageIDFunc) GenerateID(m Mail) string

GenerateID generates a Message-ID.

type Option

type Option func(*Config)

Option is a builder option.

func WithClock

func WithClock(c Clock) Option

WithClock returns an Option that overrides the used Clock.

func WithMessageID

func WithMessageID(id string) Option

WithMessageID returns an Option that sets the Message-ID of the mail.

func WithMessageIDFactory

func WithMessageIDFactory(id MessageIDFactory) Option

WithMessageIDFactory returns an Option that specifies the used MessageIDFactory.