Partners

Your default mail server name

Your DEFAULT name (see /mail-hosts for every name): the hostname your customers see in IMAP/SMTP settings, setup emails and autodiscover records instead of mx.faivelo.com, with its DNS and certificate state. activeHost and ports are what customers see right now: a live host serves IMAP 993 / SMTP 465 / POP3 995 over SSL/TLS (no STARTTLS), mx.faivelo.com serves 993 / 587. setup is the one A record to publish. Requires partner:read.

get/mail-host

Request

Base URL: https://faivelo.com/api/partner
URL: https://faivelo.com/api/partner/mail-host
Auth: HTTP bearer

Response

The mail host

successboolean

Example response

{
  "success": true,
  "data": {
    "host": "mail.yourcompany.com",
    "activeHost": "mx.faivelo.com",
    "setup": {
      "name": "mail.yourcompany.com",
      "value": "18.195.1.2"
    },
    "ports": {
      "imapPort": 993,
      "smtpPort": 465
    }
  }
}

Changes

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