Child pages
  • cPanel API 2 Functions - Email::delforward

Versions Compared

Key

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

 

Description

Excerpt

This function deletes an email forwarder that forwards mail to another address.


Warning
titleWarning:

We strongly recommend that you use the following UAPI function instead of this function:

  • Email::delete_forwarder

    Excerpt Include
    DD:UAPI Functions - Email::delete_forwarder
    DD:UAPI Functions - Email::delete_forwarder
    nopaneltrue

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
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=Email&cpanel_jsonapi_func=delforward&email="user@example.com"&emaildest="fwdtome@example.com"

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Delete user@example.com's mail forwarder.
$kill_forward = $cpanel->api2(
    'Email', 'delforward', 
    array(
        'email'                => 'user@example.com', 
        'emaildest'            => '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 user@example.com's mail forwarder.
my $kill_forward = $cpliveapi->api2(
    'Email', 'delforward',
    { 
        'email'                => 'user@example.com', 
        'emaildest'            => 'fwdtome@example.com',
    }
);

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 Email delforward email=user%40example.com emaildest=fwdtome%40example.com


Note
titleNote:

For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.  



Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "delforward",
    "data": [
      {
        "statusmsg": "OK",
        "status": "1"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote

 


Parameters

ParameterTypeDescriptionPossible valuesExample
emailstring

Required

The forwarded email address.

A valid email address on the cPanel account.

user@example.com
emaildeststring

Required

The email address to which the forwarder sends messages.

A valid email address.fwdtome@example.com

Returns

ReturnTypeDescriptionPossible valuesExample
statusmsgstringA message of success or failure.
  • OK — The function succeeded.
  • Unable to delete forwarder. — The function failed.

OK

status

Boolean

Whether the function succeeded.

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

Whether the function succeeded.

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