You can find our user documentation at docs.cpanel.net.

Check out our new API beta site!

Child pages
  • UAPI Functions - Email::enable_mailbox_autocreate
Skip to end of metadata
Go to start of metadata

Description

This function allows the system to automatically create mailboxes for a cPanel account. The system will create a new mailbox when it receives an email address in plus address format and that mailbox does not exist. For example, receiving an email from the user+newmailbox@example.com address creates the newmailbox mailbox if the newmailbox mailbox does not exist.

Note:

To disable this functionality, use the UAPI Email::disable_mailbox_autocreate function.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/enable_mailbox_autocreate?email=username%40example.com



Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Allow the system to automatically create mailboxes for an email address.
$enable_mailbox_autocreate = $cpanel->uapi(
    'Email', 'enable_mailbox_autocreate',
    array(
        'email' => 'username@example.com'
        )
);


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.
 
# Allow the system to automatically create mailboxes for an email address.
my $enable_mailbox_autocreate = $cpliveapi->uapi(
    'Email', 'enable_mailbox_autocreate',
    {
        'email' => 'username@example.com'
    }
);


Note:

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

 Command Line
uapi --user=username Email enable_mailbox_autocreate email=username@example.com


Notes:

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

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
	"result": {
		"messages": null,
		"metadata": {},
		"data": 1,
		"errors": null,
		"warnings": null,
		"status": 1
	}
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
emailstring

Required

The email account for which to enable mailbox autocreation.

A valid email address that the cPanel account owns.

username@example.com

Returns

ReturnTypeDescriptionPossible valuesExample
dataBooleanWhether the function enabled mailbox autocreation for the cPanel account.
  • 1 — Mailbox autocreation enabled.
  • 0 — Mailbox autocreation is not enabled.
1