Run email delivery route trace

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

Authorizations:
query Parameters
recipient
required
string

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

Example: recipient=username@example.com

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --output=jsonpretty \
  --user=username \
  Email \
  trace_delivery \
  recipient='username@example.com'

Response samples

Content type
application/json
{
  • "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"
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}