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

Description

This function disables the Apache SpamAssassin™ Spam Box feature for a cPanel account.

Note:

Important:

In cPanel & WHM version 76, the SpamFilter role affects this function.

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 Apache Spam Box 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 Apache Spam Box for the account.
my $disable_sa = $cpliveapi->uapi(
    'Email', 'disable_spam_box',
    }
);


Note:

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

 

 cPanel Template Toolkit
<!-- Disable Apache Spam Box. -->
[% execute('Email', 'disable_spam_box') %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 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/api/uapi


 Output (JSON)
{
  "metadata": {

  },
  "messages": null,
  "errors": null,
  "status": 1,
  "data": 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.