cPanel API 2 Functions - EmailTrack::trace

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.

 

Examples 


 WHM API (JSON)

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

 LiveAPI PHP Class

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

 LiveAPI Perl Module

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

 cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that youonly use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 

 Command Line

cpapi2 --user=username EmailTrack trace address=president%40whitehouse.gov

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 Output (JSON)

{
  "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 (Home >> Advanced >> API Shell) to directly test cPanel API calls.

 

Parameters

 Return

 Type

Description

Possible values

Example

 address 

 string 

 Required

 The destination email address. 

 A valid email address. 

 president@whitehouse.gov 

 

Returns

Return

Type

Description

Possible values

Example

 startaddress 

 string

 The destination email address.

 A valid email address.

 president@whitehouse.gov

 route

 hash

 A hash for each mail delivery router.

 This hash includes theresult and routerreturns.

 

   result

 string

 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 

   router

 string

 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

 reason

 string

 A reason for failure.

 Note:

 This function onlyreturns a reason value if it failed.

 A string that describes the error.

 This is an error message.

 result

 Boolean 

 Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.

 1

 

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....