# cPanel API 2 Functions - EmailTrack::trace

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](https://api.docs.cpanel.net/cpanel/introduction) instead of cPanel API 2.

## Description

This function traces the route to an email address.

Warning:
We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists.

Important:
When you disable the [*Receive Mail* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.

## Examples

WHM API (JSON)


```undefined 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
```

div
Note:

For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


```undefined 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',
    )
 );
```

div
Note:

For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


```undefined 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',
    }
 );
```

div
Note:

For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system).
  - cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
    - For more information, read our [Deprecated cPanel Tag Usage](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


Command Line


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

div
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](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:

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


Output (JSON)


```undefined 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](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

table
colgroup
col
col
col
col
col
thead
tr
th
strong
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
address
td
em
string
td
p
strong
Required
p
The destination email address.
td
A valid email address.
td
code
president@whitehouse.gov
## Returns

table
thead
tr
th
strong
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
startaddress
td
em
string
td
The destination email address.
td
A valid email address.
td
code
president@whitehouse.gov
tr
td
code
route
td
em
hash
td
A hash for each mail delivery router.
td
This hash includes the 
code
result
 and 
code
router
 returns.
td
tr
td
code
result
td
em
em
string
td
p
The router that delivers mail to the address.
p
The function returns this value in the 
code
route
 hash.
td
The hostname of the mail server, its IP address, and priority.
td
code
mail3.eop.gov [198.137.241.20] MX=105
tr
td
code
router
td
em
string
td
p
The method that the system uses to deliver mail to the specified address.
p
The function returns this value in the 
code
route
 hash.
td
p
code
lookuphost
 is the 
strong
only
 possible value.
td
code
lookuphost
tr
td
code
reason
td
em
string
td
p
A reason for failure.
p
This function 
strong
only
 returns a 
code
reason
 value if it failed.
td
p
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1