SMTP Gateway

Get gateway info

Returns stored information about the gateway. Credentials are masked: stored passwords, the credentials in any proxy or webhook URL, and the values of custom webhook headers all read back as "******". A masked value is not the stored one - leave the field out of an update rather than writing it back, otherwise the mask replaces the credential.

get/v1/gateway/{gateway}

Request

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

Path parameters

gatewaystring required

Gateway ID

Example:example

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

Response

Returns the gateway configuration. The password is masked.

gatewaystring required

Gateway ID

namestring required

Display name for the gateway

deliveriesinteger

Count of email deliveries using this gateway

lastUsestring date-time nullable

Last delivery time. Null for gateways that have not been used yet

userstring nullable

SMTP authentication username

passstring

SMTP authentication password. Always returned as the masked value "******" when a password is set

hoststring

Hostname to connect to

portinteger

Service port number

secureboolean nullable

Should connection use TLS. Usually true for port 465

Example response

{
  "gateway": "example",
  "name": "My Email Gateway",
  "deliveries": 100,
  "lastUse": "2021-02-17T13:43:18.860Z",
  "user": "smtp-user",
  "pass": "******",
  "host": "smtp.gmail.com",
  "port": 465,
  "secure": true,
  "lastError": {
    "created": 1623868624153,
    "status": "error",
    "response": "535 Authentication failed",
    "responseCode": 535,
    "code": "EAUTH",
    "command": "AUTH PLAIN",
    "description": "Authentication failed",
    "networkRouting": {
      "localAddress": "198.51.100.24",
      "name": "relay.example.com"
    }
  }
}

Changes

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