UAPI Functions - Email::get_spam_settings - Knowledgebase

Description

This function retrieves the Apache SpamAssassin™ settings for the account.

Examples

cPanel or Webmail Session URL

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

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// List Apache SpamAssassin settings.

$sa_settings = $cpanel->uapi(

'Email', 'get_spam_settings'

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# List Apache SpamAssassin settings.

my $sa_settings = $cpliveapi->uapi(

'Email', 'get_spam_settings',

}

);

cPanel Template Toolkit

[% execute('Email', 'get_spam_settings') %]

Command Line

uapi --user=username Email get_spam_settings

Notes:

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

 Output (JSON)

{ 
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{ 
 
   },
   "data":{ 
      "spam_enabled":1,
      "rewrites_subjects":1,
      "spam_status_changeable":1,
      "spam_as_acl":1,
      "spam_auto_delete":0,
      "spam_box_enabled":0
   }
}

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

Return	Type	Description	Possible values	Example
spam_enabled	Boolean	Whether spam filtering is enabled.	1 — Enabled. 0 — Not enabled.	1
rewrites_subjects	Boolean	Whether Apache SpamAssassin rewrites the subject lines of spam messages.	1 — Rewrite. 0 — No rewrites.	1
spam_status_changeable	Boolean	Whether the server's global settings allow cPanel users to configure Apache SpamAssassin settings.	1 — Allowed. 0 — Not allowed.	1
spam_as_acl	Boolean	Whether the server uses Apache SpamAssassin as an ACL.	1 — SpamAssassin is an ACL. 0 — SpamAssassin is not an ACL.	1
spam_auto_delete	Boolean	Whether the autodelete function is enabled.	1 — Enabled. 0 — Not enabled.	0
spam_box_enabled	Boolean	Whether the spam box is enabled.	1 — Enabled. 0 — Not enabled.	0

Knowledgebase

Categories

Categories