Page tree
Skip to end of metadata
Go to start of metadata

 

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

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.

// List Apache SpamAssassin settings.
$sa_settings = $cpanel->uapi(
    'Email', 'get_spam_settings'
);

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.

# List Apache SpamAssassin settings.
my $sa_settings = $cpliveapi->uapi(
    'Email', 'get_spam_settings',
    }
);

Note:

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

 

 cPanel Template Toolkit
<!-- List Apache SpamAssassin settings. -->
[% execute('Email', 'get_spam_settings') %]

Note:

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

 

 Command Line
uapi --user=username Email get_spam_settings

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. 
  • We introduced this functionality in cPanel & WHM version 56.

 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 (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
spam_enabledBooleanWhether spam filtering is enabled.
  • 1 — Enabled.
  • 0 — Not enabled.
1
rewrites_subjectsBooleanWhether Apache SpamAssassin rewrites the subject lines of spam messages.
  • 1 — Rewrite.
  • 0 — No rewrites.
1
spam_status_changeableBooleanWhether the server's global settings allow cPanel users to configure Apache SpamAssassin settings.
  • 1 — Allowed.
  • 0 — Not allowed.
1
spam_as_aclBooleanWhether the server uses Apache SpamAssassin as an ACL.
  • 1 — SpamAssassin is an ACL.
  • 0 — SpamAssassin is not an ACL.
1
spam_auto_deleteBooleanWhether the autodelete function is enabled.
  • 1 — Enabled.
  • 0 — Not enabled.
0
spam_box_enabledBooleanWhether the spam box is enabled.
  • 1 — Enabled.
  • 0 — Not enabled.
0