cPanel API 2 Functions - EmailTrack::stats

Warning:

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

Description

This function returns a cPanel account's mail statistics.

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=stats

Note:

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

LiveAPI PHP Class

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

//  Report email statistics for account.
$email_stats = $cpanel->api2(
    'EmailTrack', 'stats'
 );

Note:

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

LiveAPI Perl Module

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

# Report email statistics for account.
my $email_stats = $cpliveapi->api2(
    'EmailTrack', 'stats',
);

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.
- For more information, read our Deprecated cPanel Tag Usage documentation.

Command Line

cpapi2 --user=username EmailTrack stats

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:
```
/usr/local/cpanel/bin/cpapi2
```

Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "stats",
    "data": [
      {
        "TOTALSIZE": "1150",
        "SUCCESSCOUNT": "2",
        "SENDCOUNT": "7",
        "DEFERCOUNT": "18",
        "FAILCOUNT": "5",
        "INPROGRESSCOUNT": "0",
        "DEFERFAILCOUNT": "23"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "EmailTrack"
  }
}

Note:

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

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
`TOTALSIZE`	integer	The total size of the messages that the server sent, in bytes.	A positive integer that represents the size of the messages, measured in bytes.	`1150`
`SUCCESSCOUNT`	integer	The number of successful deliveries. A message with three recipients can successfully deliver up to three times.	A positive integer.	`2`
`SENDCOUNT`	integer	The number of sent messages.	A positive integer.	`7`
`DEFERCOUNT`	integer	The number of deferral events.	A positive integer.	`18`
`FAILCOUNT`	integer	The number of delivery failures. A message with three recipients can fail to deliver up to three times.	A positive integer.	`5`
`INPROGRESSCOUNT`	integer	The number of currently in progress messages.	An integer value.	`0`
`DEFERFAILCOUNT`	integer	The combined number of deferral and failure events.	A positive integer.	`23`
`reason`	string	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.`
`result`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`