Skip to main content

Interface: SmtpSettings

Defined in: packages/identity/src/port.ts:137

SMTP for the realm's own mail (invitations, verification, resets).

Properties​

auth?​

readonly optional auth?: object

Defined in: packages/identity/src/port.ts:152

Credentials; absent for an open relay such as Mailpit.

password​

readonly password: Secret<string>

user​

readonly user: string


from​

readonly from: string

Defined in: packages/identity/src/port.ts:146

The envelope and header sender.


fromDisplayName?​

readonly optional fromDisplayName?: string

Defined in: packages/identity/src/port.ts:148

Display name of the sender.


host​

readonly host: string

Defined in: packages/identity/src/port.ts:142

The relay's host name, as the provider's server resolves it rather than as this process would: in compose that is a service name such as mailpit.


port​

readonly port: number

Defined in: packages/identity/src/port.ts:144

The relay's TCP port, such as 587 for starttls or 465 for tls.


security​

readonly security: "none" | "tls" | "starttls"

Defined in: packages/identity/src/port.ts:150

Transport security.