latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Mail
cPanel Account Mail Management

Return cPanel account unique email recipients

This function gets the number of unique recipients that a system user sent mail to within a period of time. It groups this data by each of the user's email accounts.

get/get_unique_recipient_count_per_sender_for_user

Query parameters

end_timeinteger required
Example:1550923200

An end time to query.

start_timeinteger required
Example:1550872800

A start time to query.

userstring required
Example:username

The system user's username.

Response

HTTP Request was successful.

Example response

{
  "data": {
    "payload": [
      {
        "sender": "username@example.com",
        "unique_recipient_count": 51
      }
    ]
  },
  "metadata": {
    "command": "get_unique_recipient_count_per_sender_for_user",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}