emailSenderSetup

Requires at least one of the permissions settings:email:update or settings:tenant:update.

Returns the state of sender-domain verification: whether it is available on this deployment, the organization's domain and its DNS records, the address mail is currently sent from and why, and the platform's own sending domain. Requires permission to update email settings.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query EmailSenderSetup {
  emailSenderSetup {
    platformDomain
    providerAvailable
    replyTo
    sendingFrom
    sendingFromReason
    domain {
      id
      status
      domain
      lastCheckedAt
      lastError
      verifiedAt
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query EmailSenderSetup {\n  emailSenderSetup {\n    platformDomain\n    providerAvailable\n    replyTo\n    sendingFrom\n    sendingFromReason\n    domain {\n      id\n      status\n      domain\n      lastCheckedAt\n      lastError\n      verifiedAt\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "emailSenderSetup": {
      "platformDomain": "string",
      "providerAvailable": true,
      "replyTo": "string",
      "sendingFrom": "string",
      "sendingFromReason": "string",
      "domain": {
        "id": "string",
        "status": "FAILED",
        "domain": "string",
        "lastCheckedAt": "2025-01-15T00:00:00Z",
        "lastError": "string",
        "verifiedAt": "2025-01-15T00:00:00Z"
      }
    }
  }
}

emailSenderSetup: EmailSenderSetup!

Type

EmailSenderSetup object

What the email settings page needs to say truthfully about which address document mail goes out from. It is worked out by the same resolver the send path uses.