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

Description

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

Notes:


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


Note:

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

 

 cPanel Template Toolkit
<!-- Enable Apache SpamAssassin Spam Box for the account. -->
[% execute('Email', 'enable_spam_assassin') %]


Note:

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

 

 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. 

 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.