cPanel API 2 Functions - EmailTrack::stats - Knowledgebase

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

LiveAPI PHP Class

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

// Report email statistics for account.

$email_stats = $cpanel->api2(

'EmailTrack', 'stats',

);

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',

);

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.

 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 (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 messages that the server sent, in bytes.	A positive integer.	1150
SUCCESSCOUNT	integer	The number of successful deliveries. Note: A message with three recipients can have up to three successful deliveries.	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. Note: A message with three recipients can have up to three failed deliveries.	A positive integer.	5
INPROGRESSCOUNT	integer	The number of messages that are currently in progress.	A positive integer.	0
DEFERFAILCOUNT	integer	The combined number of deferral and failure events.	A positive integer.	23
reason	string	A reason for failure. Note: This function only returns a reasonvalue 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

Knowledgebase

Categories

Categories