We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Child pages
  • Mail Delivery Reports
For cPanel & WHM version 76

Skip to end of metadata
Go to start of metadata

(WHM >> Home >> Email >> Mail Delivery Reports)


This interface allows you to search for emails that users on your system sent and received.


  • Only users with root-level privileges can access emails for all accounts.
  • Resellers can only access emails that belong to accounts that they own.

Search for emails

Use the Report Inquiry section of the interface to define your search parameters.

To search for emails, perform the following steps:

  1. Enter the text for which you wish to search in the Search... text box.


    Search terms are optional.
  2. Select the part of the email that you wish to query. This menu defaults to Recipient.
  3. Select a Search Type button.


    Partial searches may require more time to complete than other search types.
  4. Select a Delivery Type button.
  5. Enter a date range in the Start Date and End Date text boxes or click the calendar icons to select dates.


    • Enter dates in the MM/DD/YYYY format, where MM represents the two-digit month, DD represents the two-digit day, and YYYY represents the four-digit year.
    • A large date range drastically increases query time for busy mail servers.
  6. Enter a time range in the Start Time and End Time text boxes. Select AM or PM next to each text box.
  7. Click Run Report.


By default, results for your query appear in the following columns:


An icon that indicates the email's delivery status:

    •   — The system delivered the email successfully.
    •   — The email's status is unknown, or delivery is in progress.
    •  — The system deferred the email.
    •  — The email encountered a delivery error.
    •  — The system rejected the email at SMTP time. This typically occurs because an RBL contains the sender's server or that server contains an insecure configuration.
From AddressThe email address that sent the email.
SenderThe system user that sent the email.
Sent TimeThe date and time when the user sent the email.
Spam ScoreA score that the system bases on the number of spam-related traits that the email contains.
RecipientThe email address to which the email was sent.
IDThe unique identifier for the outgoing email.
ResultThe result of the email transaction.
Click the magnifying glass icon () to view and print information about the selected email. This information includes the email's sender, recipient, and username.

The Search and Advanced Search features

You can further refine your results in the results table's Search... text box.


The interface will filter the results until you clear the search text box.

The results table also features an Advanced Search option. Click Advanced Search to access the four available checkboxes:

Show DeliveriesSelect this checkbox to view the emails that the system delivered successfully.
Show DeferralsSelect this checkbox to view the emails that the system deferred.
Show FailuresSelect this checkbox to view the emails that the system has not yet delivered.
Show In-ProgressSelect this checkbox to view the emails that the mail transport agent received, but the system has not yet processed (for example, succeeded, failed, or deferred).

You may deselect checkboxes to remove the email types from the results table.

Additional results columns

You may add columns to the results table to view more information. To add columns, perform the following steps:

  • Click the hamburger icon () in the top right corner of the results table, and then select the checkbox for the information that you wish to view in the table. To hide information from the table, deselect the checkbox.
  • To automatically select the default columns, click Reset to Default.

You can choose the following additional columns:

Sender UserThe sender's cPanel username.
Sender DomainThe sender's domain.
Sender HostThe sender's hostname.
Sender IPThe sender's IP address.
AuthenticationThe sender's authentication type.
Delivered ToThe recipient's email address.
Delivery UserThe username that owns the recipient's email address.
Delivery DomainThe recipient's domain.
RouterThe internal router that the mail server uses to determine the email's destination.
TransportThe recipient's SMTP type.
Out TimeThe date and time at which the intended recipient received the email.
Delivery HostThe recipient mail exchanger's hostname.
Delivery IPThe recipient mail exchanger's IP address.
SizeThe size of the outgoing email, in bytes.

Additional documentation

There is no content with the specified labels

There is no content with the specified labels

There is no content with the specified labels