UAPI Functions - Email::disable_spam_assassin

Description

This function disables Apache SpamAssassin™ for a cPanel account.

Examples 


 cPanel or Webmail Session URL

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

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
 
// Disable Apache SpamAssassin for the account.
$disable_sa $cpanel->uapi(
    'Email''disable_spam_assassin'
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Disable Apache SpamAssassin for the account.
my $disable_sa $cpliveapi->uapi(
    'Email''disable_spam_assassin',
    }
);

 cPanel Template Toolkit

<!-- Disable Apache SpamAssassin. -->
[% execute('Email', 'disable_spam_assassin') %]

 Command Line

uapi --user=username Email disable_spam_assassin

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 Output (JSON)

{
  "messages": [
    "Apache SpamAssassin™ has been disabled."
  ],
  "errors": null,
  "status": 1,
  "data": null
}

 

Note:

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

Parameters

This function does not accept parameters.

Returns

This function only returns metadata.

 

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....