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

Versions Compared

Key

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

Description

Excerpt

This function configures the cPanel account's default address's rules for unroutable mail.

 The cPanel account's default (catchall) address handles unroutable mail that the account's domains receive.

Warning
titleWarning:

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

  • Email::set_default_address

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

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
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=setdefaultaddress&domain="example.com"&fwdopt="fwd"&fwdemail="catchall@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.
 
// Forward example.com's unroutable mail to catchall@example.com
$default_address_rules = $cpanel->api2(
    'Email', 'setdefaultaddress', 
    array(
        'domain'          => 'example.com',
        'fwdopt'          => 'fwd',
        'fwdemail'        => 'catchall@example.com',
    ) 
);
 
 
// Bounce example.com's unroutable mail with a failure message.
$default_address_rules = $cpanel->api2(
    'Email', 'setdefaultaddress', 
    array(
        'domain'          => 'example.com',
        'fwdopt'          => 'fail',
        'failmsgs'        => 'Nobody's home.',
    ) 
);
 
 
// Delete example.com's unroutable mail.
$default_address_rules = $cpanel->api2(
    'Email', 'setdefaultaddress', 
    array(
        'domain'          => 'example.com',
        'fwdopt'          => 'blackhole',
    ) 
);
 
// Pipe example.com's unroutable mail to the mailscript.pl script.
$default_address_rules = $cpanel->api2(
    'Email', 'setdefaultaddress', 
    array(
        'domain'          => 'example.com',
        'fwdopt'          => 'pipe',
        'fwdemail'        => 'mailscript.pl',
    ) 
);

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.
 
# Forward example.com's unroutable mail to catchall@example.com
my $default_address_rules = $cpliveapi->api2(
    'Email', 'setdefaultaddress',
    { 
        'domain'          => 'example.com',
        'fwdopt'          => 'fwd',
        'fwdemail'        => 'catchall@example.com',
    }
);
 

# Bounce example.com's unroutable mail with a failure message.
my $default_address_rules = $cpliveapi->api2(
    'Email', 'setdefaultaddress',
    { 
        'domain'          => 'example.com',
        'fwdopt'          => 'fail',
        'failmsgs'        => 'Nobody's home.',
    }
);
 


# Delete example.com's unroutable mail.
my $default_address_rules = $cpliveapi->api2(
    'Email', 'setdefaultaddress',
    { 
        'domain'          => 'example.com',
        'fwdopt'          => 'blackhole',
    }
); 
 


# Pipe example.com's unroutable mail to the mailscript.pl script.
my $default_address_rules = $cpliveapi->api2(
    'Email', 'setdefaultaddress',
    { 
        'domain'          => 'example.com',
        'fwdopt'          => 'pipe',
        'fwdemail'        => 'mailscript.pl',
    }
); 

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning


Expand
titleCommand Line


Code Block
cpapi2 --user=username Email setdefaultaddress domain=example.com fwdopt=pipe fwdemail=mailscript.pl

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "setdefaultaddress",
    "data": [
      {
        "domain": "example.com",
        "dest": "catchall@example.com"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

Note
titleNote:

Make certain that you only pass necessary parameters to this function. The function adds all parameters to the default address's rules regardless of the fwdopt setting. 


ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The domain.

A valid domain on the cPanel account.

example.com
fwdoptstring

Required

The method to use to handle unroutable mail.

  • fwd — Forward unroutable messages to the fwdemail parameter's address.
  • fail — Bounce unroutable messages back to the sender, and include the failmsgs parameter's failure message.
  • blackhole — Send unroutable messages to the /dev/null/ directory. This method does not generate a failure notice.
  • pipe — Pipe unroutable mail to the pipefwd parameter's application.
fwd
fwdemailstring

The email address to which the system forwards unroutable email.

Note
titleNote:

Use this parameter if you used the fwd method for the fwdopt parameter. 


A valid email address.catchall@example.com
failmsgsstring

The failure message to send to the sender of unroutable mail.

This parameter defaults to No such person at this address.

Note
titleNote:

Use this parameter if you used the fail method for the fwdopt parameter. 


A valid string.

Nobody's home.
pipefwdstring

The application to which the system pipes unroutable mail.

Note
titleNote:

Use this parameter if you used the pipe method for the fwdopt parameter. 


The location of a program or script, relative to the account's home directory.mailscript.pl

Returns

ReturnTypeDescriptionPossible valuesExample
domainstring

The domain.

A valid domain on the account.

example.com
deststringThe method that the system will use to handle unroutable mail.
  • An email address — The system forwards mail to this address.
  • A failure message (string) — The system bounces mail back to the sender, and sends a failure message.
  • blackhole — The system deletes mail without a failure message.
  • The path to an application — The system pipes mail to this application.
 
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