Skip to main content
POST
Connect a mailbox over SMTP

Authorizations

X-API-Key
string
header
required

Body

application/json
email
string
required

Mailbox address (lowercased).

smtp_host
string
required

SMTP server host.

smtp_password
string
required

SMTP password (stored encrypted).

first_name
string

Sender first name.

imap_host
string

IMAP host for replies/bounces. Default: the SMTP host.

imap_password
string

IMAP password. Default: the SMTP password.

imap_port
integer

IMAP port. Default 993.

imap_security
string

ssl, starttls or none. Default ssl.

imap_username
string

IMAP login. Default: the SMTP login.

last_name
string

Sender last name.

smtp_port
integer

Port. Default 587.

smtp_security
string

ssl, starttls or none. Default starttls; anything else becomes starttls.

smtp_username
string

Login name. Defaults to the email.

Response

200

Redirect to the mailbox list; flash 'Connected over SMTP.' or 'Reconnected ...'.