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

Check out our new API beta site!

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

Description

This function checks whether a cPanel account will automatically create mailboxes when it receives an email address in plus address format.

Note:

To enable or disable this functionality, use the UAPI's Email::enable_mailbox_autocreate and Email::disable_mailbox_autocreate functions.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/get_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.
 
// Return whether the cPanel user account will automatically create mailboxes.
$get_mailbox_autocreate = $cpanel->uapi(
    'Email', 'get_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.
 
# Return whether the cPanel user account will automatically create mailboxes.
my $get_mailbox_autocreate = $cpliveapi->uapi(
    'Email', 'get_mailbox_autocreate',
    {
        'email' => 'username@example.com'
    }
);


Note:

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

 Command Line
uapi --user=username Email get_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)
{
	"apiversion": 3,
	"module": "Email",
	"func": "get_mailbox_autocreate",
	"result": {
		"metadata": {},
		"errors": null,
		"warnings": null,
		"status": 1,
		"messages": null,
		"data": 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 address to query.

A valid email address that the cPanel account owns.

username@example.com

Returns

ReturnTypeDescriptionPossible valuesExample
dataBoolean

Whether the cPanel account can automatically create mailboxes.


  • 1 — The cPanel account can automatically create mailboxes.
  • 0 — The cPanel account cannot automatically create mailboxes.
1