Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
UAPI Functions - Email::disable_spam_box - Developer Documentation - cPanel Documentation
Child pages
  • UAPI Functions - Email::disable_spam_box
Skip to end of metadata
Go to start of metadata

Description

This function disables spam box filtering for a cPanel account. When you disable spam box filtering, the system sends all messages to the account's inbox.

Notes:

  • This function requires that your hosting provider enables Apache SpamAssassin on the server.
  • To enable spam box filtering, use the UAPI Email::enable_spam_box function.
  • For more information, read our Spam Filters documentation.

Important:

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

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/disable_spam_box


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 spam box filtering for the account.
$disable_sa = $cpanel->uapi(
    'Email', 'disable_spam_box'
);


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 spam box filtering for the account.
my $disable_sa = $cpliveapi->uapi(
    'Email', 'disable_spam_box',
);


Note:

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

 

 Command Line
uapi --user=username Email disable_spam_box


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_spam_box",
   "result":{
      "metadata":{ },
      "warnings":null,
      "messages":null,
      "errors":null,
      "data":null,
      "status":1
   }
}


Note:

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

Parameters

This function does not accept parameters.

Returns

This function only returns metadata.