module

package

Go to main page

Versions in this module

v0

v0.28.4

Mar 17, 2026

Changes in this version

+ func GetGlobalSetting(key string) (string, bool, error)

+ func GetOutboundMessages() int64

+ func GetReceivedMessages() int64

+ func GetSentMessages() int64

+ func IncrementOutboundMessages()

+ func IncrementReceivedMessages()

+ func IncrementSentMessages()

+ func IsLocalOnly(key string) bool

+ func RegisterSettingsProvider(fn func(key string) (string, bool, error))

+ func RegisterSettingsProviderInstance(instName string)

+ func SetOutboundMessages(n int64)

+ func SetReceivedMessages(n int64)

+ func SetSentMessages(n int64)

+ type AccountInfo struct

+ CreatedAt int64

+ FirstLoginAt int64

+ LastLoginAt int64

+ type BlockedUserEntry struct

+ BlockedAt time.Time

+ Reason string

+ Username string

+ type GORMProvider interface

+ GetGORMDB func() *gorm.DB

type ManageableStorage

+ BlockUser func(username, reason string) error

+ DeleteAccount func(username, reason string) error

+ GetAllAccountInfo func() (map[string]AccountInfo, error)

+ GetAllUsedStorage func() (map[string]int64, error)

+ IsBlocked func(username string) (bool, error)

+ ListBlockedUsers func() ([]BlockedUserEntry, error)

+ PruneUnreadIMAPMsgs func(retention time.Duration) error

+ PurgeAllIMAPMsgs func() error

+ PurgeReadIMAPMsgs func() error

+ UnblockUser func(username string) error

type PlainUserDB

+ DeleteSetting func(key string) error

+ GetSetting func(key string) (string, bool, error)

+ SetSetting func(key, value string) error

v0.12.1

Jan 24, 2026

Changes in this version

+ const AuthCommonDomain

+ const AuthDNSSEC

+ const AuthDisabled

+ const AuthMTASTS

+ const UnknownBlobSize

+ var ErrNoSuchBlob = errors.New("blob_store: no such object")

+ var ErrUnknownCredentials = errors.New("unknown credentials")

+ var Initialized = make(map[string]bool)

+ var NoRun = false

+ func GenerateMsgID() (string, error)

+ func HasInstance(name string) bool

+ func Register(name string, factory FuncNewModule)

+ func RegisterAlias(aliasName, instName string)

+ func RegisterDeprecated(name, newName string, factory FuncNewModule)

+ func RegisterEndpoint(name string, factory FuncNewEndpoint)

+ func RegisterInstance(inst Module, cfg *config.Map)

+ type Blob interface

+ Sync func() error

+ type BlobStore interface

+ Create func(ctx context.Context, key string, blobSize int64) (Blob, error)

+ Delete func(ctx context.Context, keys []string) error

+ Open func(ctx context.Context, key string) (io.ReadCloser, error)

+ type Check interface

+ CheckStateForMsg func(ctx context.Context, msgMeta *MsgMetadata) (CheckState, error)

+ type CheckResult struct

+ AuthResult []authres.Result

+ Header textproto.Header

+ Quarantine bool

+ Reason error

+ Reject bool

+ type CheckState interface

+ CheckBody func(ctx context.Context, header textproto.Header, body buffer.Buffer) CheckResult

+ CheckConnection func(ctx context.Context) CheckResult

+ CheckRcpt func(ctx context.Context, rcptTo string) CheckResult

+ CheckSender func(ctx context.Context, mailFrom string) CheckResult

+ Close func() error

+ type ConnState struct

+ AuthPassword string

+ AuthUser string

+ Hostname string

+ LocalAddr net.Addr

+ ModData ModSpecificData

+ Proto string

+ RDNSName *future.Future

+ RemoteAddr net.Addr

+ TLS tls.ConnectionState

+ type Delivery interface

+ Abort func(ctx context.Context) error

+ AddRcpt func(ctx context.Context, rcptTo string, opts smtp.RcptOptions) error

+ Body func(ctx context.Context, header textproto.Header, body buffer.Buffer) error

+ Commit func(ctx context.Context) error

+ type DeliveryMXAuthPolicy interface

+ CheckConn func(ctx context.Context, mxLevel MXLevel, tlsLevel TLSLevel, domain, mx string, ...) (TLSLevel, error)

+ CheckMX func(ctx context.Context, mxLevel MXLevel, domain, mx string, dnssec bool) (MXLevel, error)

+ PrepareConn func(ctx context.Context, mx string)

+ PrepareDomain func(ctx context.Context, domain string)

+ Reset func(newMsg *MsgMetadata)

+ type DeliveryTarget interface

+ Start func(ctx context.Context, msgMeta *MsgMetadata, mailFrom string) (Delivery, error)

+ type Dummy struct

+ func (d *Dummy) AuthPlain(username, _ string) error

+ func (d *Dummy) Init(_ *config.Map) error

+ func (d *Dummy) InstanceName() string

+ func (d *Dummy) Lookup(_ context.Context, _ string) (string, bool, error)

+ func (d *Dummy) LookupMulti(_ context.Context, _ string) ([]string, error)

+ func (d *Dummy) Name() string

+ func (d *Dummy) Start(ctx context.Context, msgMeta *MsgMetadata, mailFrom string) (Delivery, error)

+ type EarlyCheck interface

+ CheckConnection func(ctx context.Context, state *ConnState) error

+ type FuncNewEndpoint func(modName string, addrs []string) (Module, error)

+ func GetEndpoint(name string) FuncNewEndpoint

+ type FuncNewModule func(modName, instName string, aliases, inlineArgs []string) (Module, error)

+ func Get(name string) FuncNewModule

+ type IMAPFilter interface

+ IMAPFilter func(accountName string, rcptTo string, meta *MsgMetadata, hdr textproto.Header, ...) (folder string, flags []string, err error)

+ type MXAuthPolicy interface

+ Start func(*MsgMetadata) DeliveryMXAuthPolicy

+ Weight func() int

+ type MXLevel int

+ const MXNone

+ const MX_DNSSEC

+ const MX_MTASTS

+ func (l MXLevel) String() string

+ type ManageableStorage interface

+ CreateIMAPAcct func(username string) error

+ DeleteIMAPAcct func(username string) error

+ GetAccountDate func(username string) (created int64, err error)

+ GetDefaultQuota func() int64

+ GetQuota func(username string) (used, max int64, isDefault bool, err error)

+ GetStat func() (totalStorage int64, accountsCount int, err error)

+ ListIMAPAccts func() ([]string, error)

+ PruneUnusedAccounts func(retention time.Duration) error

+ PurgeIMAPMsgs func(username string) error

+ ResetQuota func(username string) error

+ SetDefaultQuota func(max int64) error

+ SetQuota func(username string, max int64) error

+ UpdateFirstLogin func(username string) error

+ type ModSpecificData struct

+ func (msd *ModSpecificData) Get(m Module, perInstance bool) interface{}

+ func (msd *ModSpecificData) MarshalJSON() ([]byte, error)

+ func (msd *ModSpecificData) Set(m Module, perInstance bool, value interface{})

+ func (msd *ModSpecificData) UnmarshalJSON(b []byte) error

+ type Modifier interface

+ ModStateForMsg func(ctx context.Context, msgMeta *MsgMetadata) (ModifierState, error)

+ type ModifierState interface

+ Close func() error

+ RewriteBody func(ctx context.Context, h *textproto.Header, body buffer.Buffer) error

+ RewriteRcpt func(ctx context.Context, rcptTo string) ([]string, error)

+ RewriteSender func(ctx context.Context, mailFrom string) (string, error)

+ type Module interface

+ Init func(*config.Map) error

+ InstanceName func() string

+ Name func() string

+ func GetInstance(name string) (Module, error)

+ type MsgMetadata struct

+ Conn *ConnState

+ DontTraceSender bool

+ ID string

+ OriginalFrom string

+ OriginalRcpts map[string]string

+ Quarantine bool

+ SMTPOpts smtp.MailOptions

+ TLSRequireOverride bool

+ func (msgMeta *MsgMetadata) DeepCopy() *MsgMetadata

+ type MultiTable interface

+ LookupMulti func(ctx context.Context, s string) ([]string, error)

+ type MutableTable interface

+ Keys func() ([]string, error)

+ RemoveKey func(k string) error

+ SetKey func(k, v string) error

+ type PartialDelivery interface

+ BodyNonAtomic func(ctx context.Context, c StatusCollector, header textproto.Header, ...)

+ type PlainAuth interface

+ AuthPlain func(username, password string) error

+ type PlainUserDB interface

+ CreateUser func(username, password string) error

+ DeleteUser func(username string) error

+ IsJitRegistrationEnabled func() (bool, error)

+ IsLoggingDisabled func() (bool, error)

+ IsRegistrationOpen func() (bool, error)

+ IsTurnEnabled func() (bool, error)

+ ListUsers func() ([]string, error)

+ SetJitRegistrationEnabled func(enabled bool) error

+ SetLoggingDisabled func(disabled bool) error

+ SetRegistrationOpen func(open bool) error

+ SetTurnEnabled func(enabled bool) error

+ SetUserPassword func(username, password string) error

+ type StatusCollector interface

+ SetStatus func(rcptTo string, err error)

+ type Storage interface

+ GetIMAPAcct func(username string) (imapbackend.User, error)

+ GetOrCreateIMAPAcct func(username string) (imapbackend.User, error)

+ IMAPExtensions func() []string

+ type TLSLevel int

+ const TLSAuthenticated

+ const TLSEncrypted

+ const TLSNone

+ func (l TLSLevel) String() string

+ type TLSLoader interface

+ ConfigureTLS func(c *tls.Config) error

+ type Table interface

+ Lookup func(ctx context.Context, s string) (string, bool, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL