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

Description

This function enables spam box filtering for a cPanel account. When you enable spam box filtering, the system sends messages marked as spam to a spam folder.

Notes:

  • This function requires that your hosting provider enables Apache SpamAssassin on the server.
  • To disable spam box filtering, use the UAPI Email::disable_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/enable_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.

// Enable spam box filtering for the account.
$enable_sa = $cpanel->uapi(
    'Email', 'enable_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.

# Enable spam box filtering for the account.
my $enable_sa = $cpliveapi->uapi(
    'Email', 'enable_spam_box',
);


Note:

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

 

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


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.