Child pages
  • cPanel API 2 Functions - EmailTrack::search

Versions Compared

Key

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

Description

Excerpt

This function displays tracking information for the messages in the account's message queue.

Include Page
LIB:_cPanelAPI2NoEquivalent
LIB:_cPanelAPI2NoEquivalent

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledSendMailRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleWHM API (JSON)


Code Block
languagetext
https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=EmailTrack&cpanel_jsonapi_func=search&success=1&defer=0

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Displays tracking information for email on the account.
$email_search = $cpanel->api2(
    'EmailTrack', 'search',
       array(
       'success'     => '1',
       'defer'  => '0'
    )
 );

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Displays tracking information for email on the account.
my $email_search = $cpliveapi->api2(
    'EmailTrack', 'search',
    {
        'success'           => '1',
        'defer'        => '0'
    }
 );

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning


Expand
titleCommand Line


Code Block
languagebash
cpapi2 --user=username EmailTrack search success=1 defer=0

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
   "cpanelresult" : {
      "apiversion" : 2,
      "data" : [],
      "event" : {
         "result" : 1
      },
      "func" : "search",
      "metadata" : {
         "overflowed" : 0
      },
      "module" : "EmailTrack"
   }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
success

Boolean

Whether to return messages with a success status.

This parameter defaults to 0 .

  • 1 — Return messages with a success status.
  • 0 — Do not return messages with a success status.

1

defer

Boolean


Whether to return messages with a defer status.

This parameter defaults to 0 .

  • 1 — Return messages with a defer status.
  • 0 — Do not return messages with a defer status.
0

Returns

Return TypeDescriptionPossible valuesExample
transportstringThe mail transfer agent (MTA)A valid cPanel-supported MTA.
Exim 
ipstringThe recipient's IP address.A valid IP address.192.168.0.1
transport_is_remoteBooleanWhether the MTA was remote.
  • 1 — Remote.
  • 0Not remote.
0
deliveredtostringThe delivery attempt's final destination.A valid email address.user@example.com
sizeintegerThe size of the message, in bytes.A positive integer that represents the size of the messages, measured in bytes..12345
deliveryuserstringThe user that delivered the mail.A valid username.postmaster
sendunixtimestringThe message's send time.A valid time stamp, in Unix time format. 1415392926
senderhoststringThe sender's hostname.A valid hostname.hostname.example.com
domainstringThe sender's domain name.A valid domain name.example.com
actionunixtimestringThe time of the delivery attempt.A valid time stamp, in Unix time format.1415392926
msgidstringThe message ID.A valid string.This is a message id
userstringThe sender's username.A valid username.sender
recipientstringThe recipient's email address.A valid email address.user@example.com
actiontimestringThe time that the delivery attempt occurred, in human-readable format.

A valid timestamp, in YYYY-DD-MM HH:MM:SS format, where:

  • YYYY represents the year.
  • DD represents the day.
  • MM represents the month.
  •   HH represents the hour.
  • MM represents the minute.
  • SS represents the second.
2014-02-06 14:17:51
deliverydomainstringThe recipient's domain.A valid domain name.example.com
hoststringThe hostname that received the message.A valid hostname.hostname.example.com
routerstring

The method that the system uses to deliver mail to the specified address.

lookuphost is the only possible value.

lookuphost
messagestringThe action that the mail server executed.A valid string.Domain example.com has exceeded the max defers and failures per hour (5/5 (100%)) allowed. Message discarded).
senderauthstringThe user's authentication method.A valid authentication method.DKIM
senderstringThe sender's full email address.A valid email address.sender@example.com
spamscoreintegerThe message's Apache SpamAssassin™ score.A positive integer.1
senderipstringThe sender's IP address.A valid IP address.192.168.0.2
typestringThe delivery status.
  • success
  • defer
  • failure
  • inprogress
success
reasonstring

A reason for failure.

Note
titleNote:

This function only returns a reason value if it failed.


A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1