Skip to content
cPanel API 2 Modules
/
cPanel API 2 Modules - EmailTrack
/
cPanel API 2 Functions - EmailTrack::trace
Last updated

cPanel API 2 Functions - EmailTrack::trace

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function traces the route to an email address.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Important:

When you disable the Receive Mail role, the system disables this function.

Examples

WHM API (JSON)

syntaxhighlighter-pre
https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=EmailTrack&cpanel_jsonapi_func=trace&address=president%40whitehouse.gov
Note:

For more information, read our Calls from the WHM API documentation.

LiveAPI PHP Class

syntaxhighlighter-pre
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

//Trace delivery servers for "president@whitehouse.gov"
$email_stats = $cpanel->api2(
    'EmailTrack', 'trace',
    array(
        'address'         => 'president@whitehouse.gov',
    )
 );
Note:

For more information, read our Guide to the LiveAPI System.

LiveAPI Perl Module

syntaxhighlighter-pre
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Trace delivery servers for "president@whitehouse.gov"
my $email_stats = $cpliveapi->api2(
    'EmailTrack', 'trace',
    {
        'address'         => 'president@whitehouse.gov',
    }
 );
Note:

For more information, read our Guide to the LiveAPI System.

cPanel Tag System (deprecated)

Warnings:
  • cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
    • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.

Command Line

syntaxhighlighter-pre
cpapi2 --user=username EmailTrack trace address=president%40whitehouse.gov
Notes:

  • You must URI-encode values.

  • username represents your account-level username.

  • You must include the --user=username option.

  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.

  • If you run CloudLinux™, you must use the full path of the cpapi2 command:

    syntaxhighlighter-pre
    /usr/local/cpanel/bin/cpapi2

Output (JSON)

syntaxhighlighter-pre
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "trace",
    "data": [
      {
        "startaddress": "president@whitehouse.gov",
        "route": {
          "president@whitehouse.gov": [
            {
              "result": "mail3.eop.gov [198.137.241.20] MX=105",
              "router": "lookuphost"
            },
            {
              "result": "mail1.eop.gov [198.137.240.20] MX=105",
              "router": "lookuphost"
            },
            {
              "result": "mail4.eop.gov [198.137.241.21] MX=105",
              "router": "lookuphost"
            },
            {
              "result": "mail2.eop.gov [198.137.240.21] MX=105",
              "router": "lookuphost"
            },
            {
              "result": "mail6.eop.gov [204.68.207.21] MX=110",
              "router": "lookuphost"
            },
            {
              "result": "mail5.eop.gov [204.68.207.20] MX=110",
              "router": "lookuphost"
            }
          ]
        }
      }
    ],
    "event": {
      "result": 1
    },
    "module": "EmailTrack"
  }
}
Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ReturnTypeDescriptionPossible valuesExample
addressstring

Required

The destination email address.

A valid email address.president@whitehouse.gov

Returns

ReturnTypeDescriptionPossible valuesExample
startaddressstringThe destination email address.A valid email address.president@whitehouse.gov
routehashA hash for each mail delivery router.This hash includes the result and router returns.
resultstring

The router that delivers mail to the address.

The function returns this value in the route hash.

The hostname of the mail server, its IP address, and priority.mail3.eop.gov [198.137.241.20] MX=105
routerstring

The method that the system uses to deliver mail to the specified address.

The function returns this value in the route hash.

lookuphost is the only possible value.

lookuphost
reasonstring

A reason for failure.

This function only returns a reason value if it failed.

A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1
Previous page
Next page