model

Documentation

Index

• type Alias
• type Aliases
• type Identities
• type Identity
• type Mailbox
• type Mailboxes
• type RewriteRule
• type RewriteRules

Types

type Alias

type Alias struct {
	LocalPart        string   `json:"local_part"`
	DomainName       string   `json:"domain_name"`
	Address          string   `json:"address"`
	Destinations     []string `json:"destinations"`
	IsInternal       bool     `json:"is_internal"`
	Expirable        bool     `json:"expireable"`
	ExpiresOn        string   `json:"expires_on"`
	RemoveUponExpiry bool     `json:"remove_upon_expiry"`
}

Alias is the data model for a single alias

type Aliases

type Aliases struct {
	Aliases []Alias `json:"address_aliases"`
}

Aliases is the data model that wraps multiple aliases

type Identities

type Identities struct {
	Identities []Identity `json:"identities"`
}

Identities is the data model that wraps multiple identities

type Identity

type Identity struct {
	LocalPart            string `json:"local_part"`
	DomainName           string `json:"domain_name"`
	Address              string `json:"address"`
	Name                 string `json:"name"`
	MaySend              bool   `json:"may_send"`
	MayReceive           bool   `json:"may_receive"`
	MayAccessImap        bool   `json:"may_access_imap"`
	MayAccessPop3        bool   `json:"may_access_pop3"`
	MayAccessManageSieve bool   `json:"may_access_managesieve"`
	Password             string `json:"password"`
	PasswordUse          string `json:"password_use"`
	FooterActive         bool   `json:"footer_active"`
	FooterPlainBody      string `json:"footer_plain_body"`
	FooterHtmlBody       string `json:"footer_html_body"`
}

Identity is the data model for a single identity

type Mailbox

type Mailbox struct {
	LocalPart             string     `json:"local_part"`
	DomainName            string     `json:"domain_name"`
	Address               string     `json:"address"`
	Name                  string     `json:"name"`
	IsInternal            bool       `json:"is_internal"`
	MaySend               bool       `json:"may_send"`
	MayReceive            bool       `json:"may_receive"`
	MayAccessImap         bool       `json:"may_access_imap"`
	MayAccessPop3         bool       `json:"may_access_pop3"`
	MayAccessManageSieve  bool       `json:"may_access_managesieve"`
	PasswordMethod        string     `json:"password_method"`
	Password              string     `json:"password"`
	PasswordRecoveryEmail string     `json:"password_recovery_email"`
	SpamAction            string     `json:"spam_action"`
	SpamAggressiveness    string     `json:"spam_aggressiveness"`
	Expirable             bool       `json:"expireable"`
	ExpiresOn             string     `json:"expires_on"`
	RemoveUponExpiry      bool       `json:"remove_upon_expiry"`
	SenderDenyList        []string   `json:"sender_denylist"`
	SenderAllowList       []string   `json:"sender_allowlist"`
	RecipientDenyList     []string   `json:"recipient_denylist"`
	AutoRespondActive     bool       `json:"autorespond_active"`
	AutoRespondSubject    string     `json:"autorespond_subject"`
	AutoRespondBody       string     `json:"autorespond_body"`
	AutoRespondExpiresOn  string     `json:"autorespond_expires_on"`
	FooterActive          bool       `json:"footer_active"`
	FooterPlainBody       string     `json:"footer_plain_body"`
	FooterHtmlBody        string     `json:"footer_html_body"`
	StorageUsage          float64    `json:"storage_usage"`
	Delegations           []string   `json:"delegations"`
	Identities            []Identity `json:"identities"`
}

Mailbox is the data model for a single mailbox

type Mailboxes

type Mailboxes struct {
	Mailboxes []Mailbox `json:"mailboxes"`
}

Mailboxes is the data model that wraps multiple mailboxes

type RewriteRule

type RewriteRule struct {
	DomainName    string   `json:"domain_name"`
	Name          string   `json:"name"`
	LocalPartRule string   `json:"local_part_rule"`
	OrderNum      int64    `json:"order_num"`
	Destinations  []string `json:"destinations"`
}

RewriteRule is the data model for a single rewrite rule

type RewriteRules

type RewriteRules struct {
	RewriteRules []RewriteRule `json:"rewrites"`
}

RewriteRules is the data model that wraps multiple rewrite rules