Child pages
  • UAPI Functions - Email::unsuspend_outgoing

Versions Compared

Key

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

Description

Excerpt
This function cancels the suspension action put in place by the UAPI Email::suspend_outgoing function for outgoing mail for an email account.


Note
titleNote:

To suspend an email account and reject all outgoing mail, use the UAPI Email::suspend_outgoing function.

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
titlecPanel or Webmail Session URL


Code Block
languagetext
https://hostname.example.com:2083/cpsess##########/execute/Email/unsuspend_outgoing?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.
 
// Unsuspend outgoing email for the user's email account.
$unsuspend_outgoing = $cpanel->uapi(
    'Email', 'unsuspend_outgoing',
    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.
 
# Unsuspend outgoing email for the user's email account.
my $unsuspend_outgoing = $cpliveapi->uapi(
    'Email', 'unsuspend_outgoing',
    {
        'email' => 'username@example.com',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Template Toolkit


Code Block
languagexml
<!-- Unsuspend outgoing email for the user's email account. -->
[% execute('Email', 'unsuspend_outgoing', { 'email' => 'username@example.com' } ) %]

Include Page
LIB:_TTLink
LIB:_TTLink


Expand
titleCommand Line


Code Block
languagebash
uapi --user=username Email unsuspend_outgoing email=username%40example.com

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


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


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
emailstring

Required

The email account's username.

A valid email account username.

username@example.com

Returns

This function only returns metadata.