msmtpd

type AuthenticatorFunc func(transaction *Transaction, username, password string) error

type CheckerFunc func(transaction *Transaction) error

type CloseHandler CheckerFunc

type ConnectionChecker CheckerFunc

type DataChecker CheckerFunc

type DataHandler CheckerFunc

type DefaultLogger struct {
	*log.Logger
	Level LoggerLevel
}

type ErrorSMTP struct {
	Code    int    // The integer error code
	Message string // The error message
}

type HelloChecker CheckerFunc

type Logger interface {
	Tracef(transaction *Transaction, format string, args ...any)
	Debugf(transaction *Transaction, format string, args ...any)
	Infof(transaction *Transaction, format string, args ...any)
	Warnf(transaction *Transaction, format string, args ...any)
	Errorf(transaction *Transaction, format string, args ...any)
	Fatalf(transaction *Transaction, format string, args ...any)
}

type LoggerLevel uint8

type Protocol string

type RecipientChecker func(transaction *Transaction, recipient *mail.Address) error

type SenderChecker CheckerFunc

type Server struct {
	// Hostname is how we name ourselves, default is "localhost.localdomain"
	Hostname string
	// WelcomeMessage sets initial server banner. (default: "<hostname> ESMTP ready.")
	WelcomeMessage string
	// ReadTimeout is socket timeout for read operations. (default: 60s)
	ReadTimeout time.Duration
	// WriteTimeout is socket timeout for write operations. (default: 60s)
	WriteTimeout time.Duration
	// DataTimeout Socket timeout for DATA command (default: 5m)
	DataTimeout time.Duration

	// MaxConnections sets maximum number of concurrent connections, use -1 to disable. (default: 100)
	MaxConnections int
	// MaxMessageSize, default is 10240000 bytes
	MaxMessageSize int
	// MaxRecipients are limit for RCPT TO calls for each envelope. (default: 100)
	MaxRecipients int

	// Resolver is net.Resolver used by server and plugins to resolve remote resources against DNS servers
	Resolver *net.Resolver

	// SkipResolvingPTR disables resolving reverse/point DNS records of connecting IP address,
	// it can be useful in various DNS checks, but it reduces performance due to quite
	// expensive and slow DNS calls. By default resolving PTR records is enabled
	SkipResolvingPTR bool

	// ConnectionCheckers are called when TCP connection is started, if any of connection
	// checkers returns error, connection is closed, which is reported as ErrorSMTP being send to
	// client before connection is terminated
	ConnectionCheckers []ConnectionChecker

	// HeloCheckers are called after client send HELO/EHLO commands
	// If any of HeloCheckers returns error, it will be reported as HELO/EHLO command response,
	// and HELO command will be considered erroneous.
	HeloCheckers []HelloChecker

	// SenderCheckers are called when client issues MAIL FROM command
	// If any of SenderCheckers returns error, it will be reported as MAIL FROM command response,
	// and command will be considered erroneous.
	SenderCheckers []SenderChecker

	// RecipientCheckers are called every time client issues RCPT TO command
	// 1st argument is Transaction, 2nd one - RCPT TO payload
	// If any of RecipientCheckers returns error, it will be reported as RCPT TO command response
	// and command will be considered erroneous.
	RecipientCheckers []RecipientChecker

	// Authenticator, while being not nil, enables PLAIN/LOGIN authentication,
	// only available after STARTTLS. Variable can be left empty for no authentication support.
	// If Authenticator returns error, authentication will be considered erroneous.
	Authenticator func(transaction *Transaction, username, password string) error

	// DataCheckers are functions called to check message body before passing it
	// to DataHandlers for delivery. If left empty, body is not checked. It is worth
	// mentioning that message body is parsed according to RFC 5322 to ensure mandatory
	// headers From and Date are present, and important ones do not have duplicates.
	// If any of data checkers returns error, it will be reported as DATA
	// command response and command will be considered erroneous.
	DataCheckers []DataChecker

	// DataHandlers are functions to process message body after DATA command.
	// Can be left empty for a NOOP server.
	// If any of DataHandlers returns error, it will be reported as DATA
	// command response and command will be considered erroneous.
	DataHandlers []DataHandler

	// CloseHandlers are called after connection is closed. They can be used to, for example,
	// update counters, save connection metadata into persistent storage like Karma plugin does,
	// or it can even issue shell command to blacklist remote IP by firewall
	CloseHandlers []CloseHandler

	// EnableXCLIENT enables XClient command support (disabled by default, since it is security risk)
	EnableXCLIENT bool
	// EnableProxyProtocol enables Proxy command support (disabled by default, since it is security risk)
	EnableProxyProtocol bool
	// HideTransactionHeader hides transaction header
	HideTransactionHeader bool
	// TLSConfig is used both for STARTTLS and operation over TLS channel
	TLSConfig *tls.Config
	// ForceTLS requires connections to be encrypted
	ForceTLS bool
	// Logger is interface being used as protocol/plugin/errors logger
	Logger Logger
	// Tracer is OpenTelemetry tracer which starts spans for every Transaction
	Tracer trace.Tracer

	// Context is main context in which server is started
	Context context.Context
	// Cancel cancels main server Context
	Cancel context.CancelFunc
	// contains filtered or unexported fields
}

type TestLogger struct {
	Suite *testing.T
}

type Transaction struct {
	// ID is unique transaction identificator
	ID string `json:"id"`
	// StartedAt depicts moment when transaction was initiated
	StartedAt time.Time

	// ServerName depicts how out smtp server names itself
	ServerName string
	// Addr depicts network address of remote client
	Addr net.Addr
	// PTRs are  DNS PTR record is exactly the opposite of the 'A' record, which provides the IP address associated with a
	// domain name.
	PTRs []string

	// TLS Connection details, if encryption is enabled
	// Ptrs are DNS pointer record which provides the domain name associated with an IP address.
	TLS *tls.ConnectionState
	// Encrypted means connection is encrypted by TLS
	Encrypted bool
	// Secured means TLS handshake succeeded
	Secured bool

	// Logger is logging system inherited from server
	Logger Logger

	// HeloName is how client introduced himself via HELO/EHLO command
	HeloName string
	// Protocol used, SMTP or ESMTP
	Protocol Protocol
	// Username as provided by via authorization process command
	Username string
	// Password from authentication, if authenticated
	Password string
	// MailFrom stores address from which this message is originated as client says via `MAIL FROM:`
	MailFrom mail.Address
	// RcptTo stores addresses for which this message should be delivered as client says via `RCPT TO:`
	RcptTo []mail.Address

	// Body stores unparsed message body
	Body []byte
	// Parsed stores parsed message body
	Parsed *mail.Message

	// Aliases are actual users addresses used by delivery plugins
	Aliases []mail.Address

	// Span is OpenTelemetry span being used in transaction
	Span trace.Span
	// contains filtered or unexported fields
}