mail

type Account struct {
	Name string `json:"name"`
	// Disabled is true while the engine refuses logins for the account.
	Disabled bool `json:"disabled"`
}

type AccountDetail struct {
	Name           string   `json:"name"`
	Addresses      []string `json:"addresses"`
	LoginDisabled  bool     `json:"login_disabled"`
	DiskUsageBytes int64    `json:"disk_usage_bytes"`
}

type AccountSpec struct {
	Name     string
	Address  string
	Password string
	// SendCapPerHour is advisory data for a later enforcement slice; 0 means
	// use DefaultSendCapPerHour.
	SendCapPerHour int
}

type Alias struct {
	Address string   `json:"address"`
	Targets []string `json:"targets"`
}

type CredentialSource interface {
	AdminPassword(ctx context.Context) (string, error)
}

type DKIMKey struct {
	Selector  string `json:"selector"`
	PublicKey string `json:"public_key"`
	TXT       string `json:"txt"`
}

type DNSRecord struct {
	Name  string `json:"name"`
	TTL   int    `json:"ttl,omitempty"`
	Type  string `json:"type"`
	Value string `json:"value"`
}

type Domain struct {
	Name string `json:"name"`
}

type DomainSpec struct {
	Name      string
	Account   string
	Localpart string
}

type Engine interface {
	Domains(ctx context.Context) ([]Domain, error)
	AddDomain(ctx context.Context, d DomainSpec) error
	RemoveDomain(ctx context.Context, name string) error
	DNSRecords(ctx context.Context, domain string) ([]DNSRecord, error)
	DKIMKeys(ctx context.Context, domain string) ([]DKIMKey, error)
	Accounts(ctx context.Context) ([]Account, error)
	AddAccount(ctx context.Context, a AccountSpec) error
	RemoveAccount(ctx context.Context, name string) error
	AddAddress(ctx context.Context, address, account string) error
	SetPassword(ctx context.Context, account, password string) error
	SetQuota(ctx context.Context, account string, q Quota) error
	AddAlias(ctx context.Context, a Alias) error
	RemoveAlias(ctx context.Context, address string) error
	// Aliases lists the aliases of one domain.
	Aliases(ctx context.Context, domain string) ([]Alias, error)
	// AccountDetail reads one account's addresses, login state and disk usage.
	AccountDetail(ctx context.Context, name string) (AccountDetail, error)
	// SetLoginDisabled refuses logins with message as the reason; "" allows them again.
	SetLoginDisabled(ctx context.Context, account, message string) error
	QueueList(ctx context.Context, limit int) ([]QueueEntry, error)
	// HoldMessages sets hold on the listed queue ids and returns how many changed.
	HoldMessages(ctx context.Context, ids []int64, hold bool) (int, error)
	QueueStats(ctx context.Context) (QueueStats, error)
	// HoldQueue pauses delivery of every queued message; ReleaseQueue resumes it.
	HoldQueue(ctx context.Context) error
	ReleaseQueue(ctx context.Context) error
	Health(ctx context.Context) error
}

type Error struct {
	Kind    error
	Code    string
	Message string
}

type QueueEntry struct {
	ID              int64     `json:"id"`
	Queued          time.Time `json:"queued"`
	Hold            bool      `json:"hold"`
	SenderAccount   string    `json:"sender_account"`
	RecipientDomain string    `json:"recipient_domain"`
	Attempts        int       `json:"attempts"`
	NextAttempt     time.Time `json:"next_attempt"`
	LastError       string    `json:"last_error,omitempty"`
}

type QueueStats struct {
	Queued  int `json:"queued"`
	Failing int `json:"failing"`
}

type Quota struct {
	MaxBytes int64
}