Child pages
  • UAPI Functions - Email::delete_forwarder

Versions Compared

Key

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

Description

Excerpt
This function deletes an email forwarder.

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledReceiveSendMailRoles
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/delete_forwarder?address=user%40example.com&forwarder=fwdtome%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.
 
// Delete the forwarder for user@example.com
$delete_forwarder = $cpanel->uapi(
    'Email', 'delete_forwarder',
    array(
        'address'        => 'user@example.com',
        'forwarder'      => 'fwdtome@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.
 
# Delete the forwarder for user@example.com
my $delete_forwarder = $cpliveapi->uapi(
    'Email', 'delete_forwarder',
    {
        'address'        => 'user@example.com',
        'forwarder'      => 'fwdtome@example.com',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 


Expand
titlecPanel Template Toolkit


Code Block
languagexml
<!-- Delete the forwarder for user@example.com -->
[% execute( 'Email', 'delete_forwarder', { address => 'user@example.com', forwarder => 'fwdtome@example.com' } ) %]

Include Page
LIB:_TTLink
LIB:_TTLink

 


Expand
titleCommand Line


Code Block
languagebash
uapi --user=username Email delete_forwarder address=user%40example.com forwarder=fwdtome%40example.com

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


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


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
addressstring

Required

The forwarder's email address.

A valid email address on the cPanel account.

user@example.com
forwarderstring

Required

The forwarder's destination.

  • A valid email address.
  • A script location.
  • A system account.
fwdtome@example.com

Returns

This function only returns metadata.