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

Description

This function disables the system's ability to automatically create mailboxes. Certain calendar and contact integrations require this functionality.

Note:

When you enable the UAPI's Email::enable_mailbox_autocreate function, the system automatically creates mailboxes. The system creates 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.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/disable_mailbox_autocreate?email=username@example.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.
 
// Disable the system’s ability to automatically create mailboxes for an email address.
$disable_mailbox_autocreate = $cpanel->uapi(
    'Email', 'disable_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.
 
# Disable the system’s ability to automatically create mailboxes for an email address.
my $disable_mailbox_autocreate = $cpliveapi->uapi(
    'Email', 'disable_mailbox_autocreate',
    {
        'email' => 'username@example.com'
    }
);


Note:

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

 Command Line
uapi --user=username Email disable_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":"disable_mailbox_autocreate",
   "result":{
      "data":1,
      "status":1,
      "messages":null,
      "warnings":null,
      "errors":null,
      "metadata":{
      }
   }
}


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

This function only returns metadata.