Skip to main content
POST
Save and verify email transport settings

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Body

application/json

Validated request fields for this operation.

from_address
string<email>
required
Example:

"support@example.org"

from_name
string
required

Sender display name; required by the handler.

Example:

"Example Nonprofit"

host
string | null
Maximum string length: 255
Example:

"smtp.example.org"

username
string | null
Maximum string length: 255
Example:

"postmaster@example.org"

password
string | null
write-only

Nonblank values replace the saved secret; blank/omitted values preserve it unless clear_mailgun is true.

Maximum string length: 1024
Example:

"REDACTED"

api
string | null
write-only

Optional saved Mailgun API key; blank/omitted values preserve it unless clearing.

Maximum string length: 1024
Example:

"REDACTED"

port
integer | null
Required range: 1 <= x <= 65535
Example:

587

encryption
string | null
Maximum string length: 32
Example:

"tls"

clear_mailgun
boolean

Clears saved custom delivery configuration and verifies default delivery.

Example:

false

Response

Operation result.

message
string
Example:

"Settings saved successfully."