Child pages
  • Mail Delivery Reports

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Include Page
LIB:_Version
LIB:_Version

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

Table of Contents
maxLevel3
minLevel2
stylenone

Overview

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

Warning
titleImportant:
  • 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.

    Note
    titleNote:
    Search terms are optional.


  2. Select the part of the email that you wish to query. The default trait is Recipient.
  3. Select a Search Type button.

    Warning
    titleImportant
    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.

    Warning
    titleImportant
    • Enter dates in the MM/DD/YYYY format, where MM is the two-digit month, DD is the two-digit day, and YYYY is 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.

Results

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

ColumnDescription
Event

This column contains 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 email was deferred.
    •  — The email encountered a delivery error.
    •  — The email was rejected at SMTP time. This typically occurs because the sender's server is configured insecurely or is listed on a RBL.
SenderThe email address that sent the email.
Sent TimeThe date and time at which the email was sent.
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.
ResultThis column contains a short email about the delivery.
Actions
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.

Note
titleNote:
The results remain filtered until you clear the search box.

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

CheckboxDescription
Show DeliveriesSelect this checkbox to view the emails that the system delivered successfully.
Show DeferralsSelect this checkbox to view the emails that were deferred.
Show FailuresSelect this checkbox to view the emails that were not delivered.
Show In-ProgressSelect this checkbox to view the emails that were received by the mail transport agent but that 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.

Note
titleNote:
cPanel & WHM limits results to 5000 per Advanced Search type filter.

Additional results columns

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

  • Click the gear icon () in the top right corner of the results table, and 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:

ColumnDescription
UserThe sender's cPanel username.
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

Localtab Group


Localtab
activetrue
titleSuggested documentation

Content by Label
showLabelsfalse
max5
showSpacefalse
cqllabel in ("exim","email") and label = "whm" and space = currentSpace()


Localtab
titleFor cPanel users

Content by Label
showLabelsfalse
max5
showSpacefalse
cqllabel in ("exim","email") and label = "cpanel" and space = currentSpace()


Localtab
titleFor WHM users

Content by Label
showLabelsfalse
max5
showSpacefalse
cqllabel in ("exim","email") and label = "whm" and space in (currentSpace(),"CKB")


Localtab
titleFor developers

Content by Label
showLabelsfalse
max5
showSpacefalse
cqllabel in ("exim","email") and space = "DD"