Child pages
  • UAPI Functions - Email::get_held_message_count

Versions Compared

Key

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

Description

Excerpt
This function returns the count of outbound email messages held in the mail queue for the specified email account.

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

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone


Expand
titlecPanel or Webmail Session URL


Code Block
languagetext
https://hostname.example.com:2083/cpsess##########/execute/Email/get_held_message_count?email=username%40example.com

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List the number of queued outbound messages for the specified email address.
$emails = $cpanel->uapi(
    'Email', 'get_held_message_count'
    array(
        'email' => 'username@example.com',
        )
);

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.
 
# List the number of queued outbound messages for the specified email address.
my $emails = $cpliveapi->uapi(
    'Email', 'get_held_message_count'
    {
        'email' => 'username@example.com',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Template Toolkit


Code Block
languagexml
<!-- List the number of queued outbound messages for the specified email address. -->
[% execute('Email', 'get_held_message_count', { 'email' => 'username@example.com' } ) %]

Include Page
LIB:_TTLink
LIB:_TTLink


Expand
titleCommand Line


Code Block
languagebash
uapi --user=username Email get_held_message_count email=username@example.com

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{  
  "data": 0,
  "errors": null,
  "messages": null,
  "status": 1
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
emailstring

The email address to query.

A valid email address that the cPanel account owns.

username@example.com

Returns

ReturnTypeDescriptionPossible valuesExample
datainteger

The number of messages currently held in the mail queue.

A positive integer.

Note
titleNote:

This function returns a 0 value when no messages exist in the queue.


0