Child pages
  • cPanel API 2 Functions - Email::setdefaultaddress
Skip to end of metadata
Go to start of metadata

Description

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:

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

Important:

In cPanel & WHM version 76 and later, when you disable the MailReceive role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 WHM API (JSON)
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"


Note:

 For more information, read our Calls from the WHM API documentation.

 LiveAPI PHP Class
$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',
    ) 
);


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
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',
    }
); 


Note:

For more information, read our Guide to the LiveAPI System.

 cPanel Tag System (deprecated)


Warnings:

  • In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

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


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:

    /usr/local/cpanel/bin/cpapi2

 Output (JSON)
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "setdefaultaddress",
    "data": [
      {
        "domain": "example.com",
        "dest": "catchall@example.com"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Note:

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:

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:

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:

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:

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