latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Mail
cPanel Account Mail Management

Return all cPanel accounts email tracking statistics

This function retrieves email tracking statistics for each user.

get/emailtrack_user_stats

Query parameters

deliverytype'remote' | 'remote-or-faildefer' | 'local'
Example:remote

The type of delivery to query. If you do not specify a value, this function returns all types.

  • remote
  • remote-or-faildefer
  • local
endtimeinteger
Example:1471552781

The end time of the search window.

senderstring email
Example:username@example.com

The sender's email address. If you do not specify a value, this function returns entries for mail from all senders.

starttimeinteger
Example:1371552781

The start time of the search window.

Response

HTTP Request was successful.

Example response

{
  "data": {
    "records": [
      {
        "DOMAIN": "example.com",
        "OWNER": "root",
        "PRIMARY_DOMAIN": "example.com",
        "REACHED_MAXDEFERFAIL": 1,
        "REACHED_MAXEMAILS": 1,
        "SENDCOUNT": 14,
        "SUCCESSCOUNT": 14,
        "TOTALSIZE": 27444,
        "USER": "example"
      }
    ]
  },
  "metadata": {
    "command": "emailtrack_user_stats",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}