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.

  • 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.

Examples




https://hostname.example.com:2083/cpsess##########/execute/Email/disable_spam_box



$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'
);



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',
);

 



<!-- Disable spam box filtering for the account. -->
[% execute('Email', 'disable_spam_box') %]

 



uapi --user=username Email disable_spam_box



{
   "apiversion":3,
   "module":"Email",
   "func":"disable_spam_box",
   "result":{
      "metadata":{ },
      "warnings":null,
      "messages":null,
      "errors":null,
      "data":null,
      "status":1
   }
}



Parameters

This function does not accept parameters.

Returns

This function only returns metadata.