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
CustInfo Module Documentation
The CustInfo module allows users to specify contact information and preferences. 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.CustInfo::displaycontactinfo
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Retrieve your contact information and email notfication settings. |
| Returns: | |
<data> <enabled> A boolean value that indicates whether or not your contact information is enabled. '1' if it is enabled.</enabled> <value> A string, boolean, or undefined value that contains the option's setting.</value> <type> A string value that indicates what type of value the option is. (e.g. 'string' or 'boolean')</type> <descp> A string value that contains a description of the option.</descp> <name> A string value that contains the name of the option being displayed.</name> </data> |
CustInfo::savecontactinfo
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Saves the user's contact info and settings for email notifications |
| Parameters: | |
| notify_email_quota_limit (boolean (optional)) | |
| Send notifications to your contact email address when one of your email accounts approaches or is over quota. | |
| notify_bandwidth_limit (boolean (optional)) | |
| Send notifications to your contact email address when you are reaching your bandwidth usage limit. | |
| notify_disk_limit (boolean (optional)) | |
| Send notifications to your contact email address when you are reaching your disk quota. | |
| email (string) | |
| Email account to send notifications to. | |
| second_email (string) | |
| Secondary email account to send notifications to. | |
| Returns: | |
<data> <value> A string value that contains the value of the specified parameter.</value> <display_value> A string value that contains what is displayed from 'value'.</display_value> <name> A string value that contains the name of the parameter.</name> </data> |
Edit | Attach | Print version | History: r2 < r1 | Backlinks | Raw View | More topic actions
Topic revision: r2 - 26 Mar 2012 - 15:21:11 - Main.JenniferDoubrava