SMTP Gateway

Register new gateway

Registers a new SMP gateway

post/v1/gateway

Request

  • Base URL: https://your-emailengine-host
  • URL: https://your-emailengine-host/v1/gateway
  • Auth: HTTP bearer

Headers

x-ee-timeoutinteger

Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect

Example:30000

Request body

gatewaystring nullable required

Gateway ID. If set to null, a unique ID will be generated automatically

namestring required

Account Name

userstring

SMTP authentication username

passstring

SMTP authentication password

hoststring required

Hostname to connect to

portinteger required

Service port number

secureboolean

Should connection use TLS. Usually true for port 465

Example request

{
  "gateway": "sendgun",
  "name": "John Smith",
  "user": "smtp-user",
  "pass": "verysecret",
  "host": "smtp.gmail.com",
  "port": 465,
  "secure": true
}

Response

Returns the registered gateway.

gatewaystring required

Gateway ID

state'existing' | 'new' required

Whether the gateway was created or updated

Example response

{
  "gateway": "example",
  "state": "new"
}

Changes

No recorded changes to this operation across all 1 revision of this API.