v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Email
Email Accounts

Run email delivery route trace

This function traces the email delivery route to an email account.

get/Email/trace_delivery

Query parameters

recipientstring required
Example:username@example.com

The email address to which to trace a message delivery path.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "trace_delivery",
  "module": "Email",
  "result": {
    "data": {
      "address": "username@example.com",
      "destinations": [
        {
          "address": "username@example.com",
          "aliasfile": "/etc/valiases/example.com",
          "destinations": [
            {
              "mailbox": "username@example.com",
              "type": "local_delivery"
            }
          ],
          "type": "routed"
        }
      ],
      "type": "routed"
    },
    "status": 1
  }
}