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
DomainKeysUI Module Documentation
This module allows users to edit domain keys. 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 features sets available on your cPanel server, please navigate to Home >> Packages >> Feature Manager within WHM.DKIMUI::installed
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Check to see if your domain has DomainKeys installed. This function will also determine if your domain is live. |
| Returns: | |
<data> <installed> A boolean value that indicates whether or not your domain uses DomainKeys. '1' indicates that your domain has DomainKeys in place. '0' indicates that DomainKeys are not installed for your domain.</installed> <active> A boolean value that indicates whether or not your domain is live within DNS. '1' indicates that your domain is live within DNS. '0' indicates that your domain is not live.</active> </data> |
DKIMUI::available
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Check to see if DomainKeys are available on the server. |
| Returns: | |
<data> <available> A boolean value that indicates whether or not DomainKeys are available to your domain. '1' indicates DomainKeys are available. '0' indicates that DomainKeys are not available on your server.</available> </data> |
DKIMUI::install
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Install DomainKeys for your cPanel account. |
| Returns: | |
<data> <installed> A boolean value that indicates that the install was success or a failure. '1' indicates that DomainKeys were properly installed. '0' indicates that DomainKeys were not installed.</installed> </data> |
DKIMUI::uninstall
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Remove DomainKeys corresponding to your domain. |
| Returns: | |
<data> <uninstalled> A boolean value that indicates that the install was a success or a failure. '0' indicates that the DomainKeys were not removed. '1' indicates that the DomainKeys were removed.</uninstalled> </data> |
Topic revision: r3 - 06 Feb 2013 - 21:18:15 - Main.LaurenceSimon