Software Development Kit
cPanel & WHM's API [+] cPanel & WHM's API [-]Modules and Plugins [+] Modules and Plugins [-]
cPanel Modules
Writing cPanel Modules PHP Accounting Module cPanel::Accounting Perl Module Writing cPanel Plugins
Writing cPanel Plugins PHP in cPanel Plugin Interfaces cPanel CGI Scripts Live PHP in cPanel Plugins Plugin Variables Installing cPanel Plugins Adding Icons and Groups Plugin Installation File Generator Plugin Security Policy (
.pdf)
WHM Plugins
Creating WHM Plugins ACL Reference Table The swapip Utility cPanel Logger Module Pluggable dnsadmin Modules EasyApache Modules
Custom Modules?
cPanel & WHM Hooks [+] cPanel & WHM Hooks [-]
Standardized Hooks Introduction Taxonomy Getting Started Hooks Management Interface Hookable Events Advanced Usage Troubleshooting
Legacy Hooks Introduction Writing Function Hooks Script Hooks Custom Event Handlers cPanel Logger Module Universal Password Trap Hooking into EasyApache
EasyApache Hooks?
cPAddons (Site Software) [+] cPAddons (Site Software) [-]
System Administration [+] System Administration [-]
Developer Software [+] Developer Software [-]
Back to All Documentation
SpamAssassin Module Documentation
Allows users to change their SpamAssassin Settings The functions within this module may or may not be governed by a feature list. The required feature list may vary from function to function, to review a total list of the available features sets on a cPanel server, please see "Feature Manager" in WHM.SpamAssassin::saveconfig
| API Version: | 1 - Click here for documentation |
|---|---|
| Syntax: | SpamAssassin::saveconfig( ) |
| Description: | Save SpamAssassin's configuration information. This function requires access to the 'spamassassin' feature. This feature is not available in demo mode. |
| Form Data: | |
| blacklist_from-* (string) | |
| The email address(es) to blacklist. This variable will need to be incremented in order to specify more than one address (e.g., blacklist_from-1, blacklist_from-2). | |
| required_score (integer) | |
| The score above which email messages are considered spam. | |
| score-* (string) | |
| Set specific scores for specific rules. For example: SPAM_RULE 3 3 3 3 - This rule indicates that if SPAM_RULE is tripped, it will add 3 to the score regardless of the configuration. The 1st score is used when both Bayes and network tests are disabled. The 2nd score is used when Bayes is disabled, but network tests are enabled. The 3rd score is used when Bayes is enabled and network tests are disabled. The 4th score is used when Bayes is enabled and network tests are enabled. Setting a rule's score to 0 will disable that rule from running. . | |
| whitelist_from-* (string) | |
| The email address(es) to whitelist. This variable will need to be incremented in order to specify more than one address (e.g., whitelist_from-1, whitelist_from-2*). | |
| Returns: | |
This function does not produce any output.
|
SpamAssassin::config
| API Version: | 1 - Click here for documentation |
|---|---|
| Syntax: | SpamAssassin::config( ) |
| Description: | Print SpamAssassin configuration HTML. This function requires access to the 'spamassassin' feature. The function pulls the default values from the global /usr/local/cpanel/etc/spamassassin.options file and the /home/$user/.spamassassin/user_prefs configuration file. |
| Returns: | |
Displays a large chunk of HTML displaying a user's SpamAssassin configuration.
|
Edit | Attach | Print version | History: r2 < r1 | Backlinks | Raw View | More topic actions
Topic revision: r2 - 27 Mar 2012 - 19:22:34 - Main.JenniferDoubrava