Skip to content

Gateways

Information about email gateway objects. Email gateway can be owned by a dealer or leased from platform owner.

Email gateway object

Own email gateway: Now supported only SMTP provider.

{
  "id": 2,
  "leasable": false,
  "label": "Paas gate",
  "provider": "smtp",
  "params": {
    "default_from_address": "no-reply@domain.tld",
    "mail.smtp.user": null,
    "mail.smtp.password": null,
    "mail.smtp.host": "localhost",
    "mail.smtp.port": 25,
    "mail.smtp.ssl.port": 465,
    "mail.smtp.ssl.trust_all_hosts": false,
    "mail.smtp.auth": true,
    "mail.debug": false,
    "mail.smtp.starttls.enable": false,
    "mail.smtp.starttls.required": false,
    "mail.smtp.use_ssl": false,
    "mail.smtp.timeout": 60000,
    "mail.smtp.connectiontimeout": 60000,
    "mail.transport.protocol": "smtp"
  }
}

Leasable email gateway:

{
  "id": 1,
  "label": "Platform gate",
  "default_from_address": "no-reply@domain.tld"
}

API actions

API path: panel/gateways/email.

list

Gets list of available email gateways for the panel.

required permissions: email_gateways: "read".

Parameters

Only session hash.

Examples

curl -X POST 'https://api.navixy.com/v2/panel/gateways/email/list' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "fa7bf873fab9333144e171372a321b06"}'

https://api.navixy.com/v2/panel/gateways/email/list?hash=fa7bf873fab9333144e171372a321b06

Response

{
    "success": true,
    "bound_gateway": 2,
    "own": [{
      "id": 1,
      "leasable": false,
      "label": "Paas gate",
      "provider": "smtp",
      "params": {
        "default_from_address": "no-reply@domain.tld",
        "mail.smtp.user": null,
        "mail.smtp.password": null,
        "mail.smtp.host": "localhost",
        "mail.smtp.port": 25,
        "mail.smtp.ssl.port": 465,
        "mail.smtp.ssl.trust_all_hosts": false,
        "mail.smtp.auth": true,
        "mail.debug": false,
        "mail.smtp.starttls.enable": false,
        "mail.smtp.starttls.required": false,
        "mail.smtp.use_ssl": false,
        "mail.smtp.timeout": 60000,
        "mail.smtp.connectiontimeout": 60000,
        "mail.transport.protocol": "smtp"
      }
    }],
    "leasable": [
        {
            "id": 2,
            "label": "Default",
            "provider": "mandrill_smtp",
            "default_from_address": "no-reply@x-gpsmail.com"
        }
    ]
}

Errors

General types only.

Last update: October 16, 2024