Installation

1. Download the class file (see "Download" section below).

2. Upload the TheCPanelPHPObject.php file to your project directory.

3. Include the file in your PHP script:

require_once 'TheCPanelPHPObject.php';

4. Instantiate the object with your cPanel hostname, username, and API token. You will need to generate an API token in your cPanel interface (navigate to cPanel > Security > Manage API Tokens):

$cpanel = new CPanelManager('cpanelphpobject.com:2083', 'cpaneluser', 'YOUR_API_TOKEN_HERE');

Basic Usage Example

All API calls through this object return either true on success or an associative array containing an 'error' key with a descriptive message on failure. Always check for the 'error' key in the returned array to ensure the operation was successful.

$cpanel = new CPanelManager('cpanelphpobject.com:2083', 'cpaneluser', 'YOUR_API_TOKEN_HERE');

// Example: Create an email account
$result = $cpanel->createEmail('newuser', 'cpanelphpobject.com', 'StrongPass123!', 500);

if (isset($result['error'])) {
    echo "Error creating email: " . $result['error'] . "\n";
} else {
    echo "Email account created successfully!\n";
}

// Example: List all email accounts
$emailAccounts = $cpanel->listEmailAccounts();

if (isset($emailAccounts['error'])) {
    echo "Error listing emails: " . $emailAccounts['error'] . "\n";
} else {
    echo "Current Email Accounts:\n";
    foreach ($emailAccounts as $account) {
        echo "- " . $account['email'] . "@" . $account['domain'] . "\n";
    }
}
                    

Function Reference

$cpanel = new CPanelManager('cpanelphpobject.com:2083', 'cpaneluser', 'YOUR_API_TOKEN_HERE');

Email Management

$result = $cpanel->createEmail('alice', 'cpanelphpobject.com', 'MyS3cur3P@ssw0rd!', 250); // 250 MB quota
if (isset($result['error'])) {
    echo "Error creating email: " . $result['error'];
} else {
    echo "Email 'alice@cpanelphpobject.com' created successfully.";
}
                        

$result = $cpanel->deleteEmail('alice@cpanelphpobject.com');
if (isset($result['error'])) {
    echo "Error deleting email: " . $result['error'];
} else {
    echo "Email 'alice@cpanelphpobject.com' deleted successfully.";
}
                        

$result = $cpanel->changeEmailPassword('john@cpanelphpobject.com', 'N3wS3cur3P@ss!');
if (isset($result['error'])) {
    echo "Error changing password: " . $result['error'];
} else {
    echo "Password for 'john@cpanelphpobject.com' changed successfully.";
}
                        

$result = $cpanel->updateEmailQuota('john@cpanelphpobject.com', 1024); // Set to 1024 MB
if (isset($result['error'])) {
    echo "Error updating quota: " . $result['error'];
} else {
    echo "Quota for 'john@cpanelphpobject.com' updated to 1024 MB.";
}
                        

$accounts = $cpanel->listEmailAccounts();
if (isset($accounts['error'])) {
    echo "Error listing emails: " . $accounts['error'];
} else {
    echo "Current Email Accounts:\n";
    foreach ($accounts as $account) {
        echo "- " . $account['email'] . "@" . $account['domain'] . "\n";
    }
}
                        

Email Forwards

$result = $cpanel->addEmailForwarder('cpanelphpobject.com', 'support', 'myemail@gmail.com');
if (isset($result['error'])) {
    echo "Error adding forwarder: " . $result['error'];
} else {
    echo "Forwarder from 'support@cpanelphpobject.com' to 'myemail@gmail.com' added.";
}
                        

$result = $cpanel->deleteEmailForwarder('cpanelphpobject.com', 'support', 'myemail@gmail.com');
if (isset($result['error'])) {
    echo "Error deleting forwarder: " . $result['error'];
} else {
    echo "Forwarder from 'support@cpanelphpobject.com' to 'myemail@gmail.com' deleted.";
}
                        

Auto Responders

$result = $cpanel->addAutoResponder('cpanelphpobject.com', 'info', 'noreply@cpanelphpobject.com', 'Out of Office Notification', 'I am currently out of office and will respond to your email as soon as possible. Thank you for your patience.', true);
if (isset($result['error'])) {
    echo "Error adding auto-responder: " . $result['error'];
} else {
    echo "Auto-responder for 'info@cpanelphpobject.com' added successfully.";
}
                        

$result = $cpanel->deleteAutoResponder('cpanelphpobject.com', 'info');
if (isset($result['error'])) {
    echo "Error deleting auto-responder: " . $result['error'];
} else {
    echo "Auto-responder for 'info@cpanelphpobject.com' deleted successfully.";
}
                        

Email Authentication and Routing

$dkimStatus = $cpanel->getDKIMStatus('cpanelphpobject.com');
if (isset($dkimStatus['error'])) {
    echo "Error getting DKIM status: " . $dkimStatus['error'];
} else {
    echo "DKIM Status for cpanelphpobject.com: " . (isset($dkimStatus['status']) ? $dkimStatus['status'] : 'N/A');
    print_r($dkimStatus); // Provides full details
}
                        

$spfStatus = $cpanel->getSPFStatus('cpanelphpobject.com');
if (isset($spfStatus['error'])) {
    echo "Error getting SPF status: " . $spfStatus['error'];
} else {
    echo "SPF Status for cpanelphpobject.com: " . (isset($spfStatus['status']) ? $spfStatus['status'] : 'N/A');
    print_r($spfStatus); // Provides full details
}
                        

$diskUsage = $cpanel->getEmailDiskUsage();
if (isset($diskUsage['error'])) {
    echo "Error getting email disk usage: " . $diskUsage['error'];
} else {
    echo "Email Disk Usage:\n";
    foreach ($diskUsage as $item) {
        echo "- " . $item['email'] . ": " . $item['diskused'] . "MB / " . (($item['quota'] === 0) ? 'Unlimited' : $item['quota'] . 'MB') . "\n"; // Explicit 0 check
    }
}
                        

$routing = $cpanel->getEmailRouting('cpanelphpobject.com');
if (isset($routing['error'])) {
    echo "Error getting email routing: " . $routing['error'];
} else {
    echo "Email routing for cpanelphpobject.com: " . (isset($routing['route']) ? $routing['route'] : 'Unknown');
    print_r($routing); // Provides full details
}
                        

// Set a catch-all email
$result = $cpanel->setDefaultEmail('cpanelphpobject.com', 'catchall@cpanelphpobject.com');
if (isset($result['error'])) {
    echo "Error setting default email: " . $result['error'];
} else {
    echo "Default email for 'cpanelphpobject.com' set to 'catchall@cpanelphpobject.com'.";
}

// Or set to discard all invalid emails
// $result = $cpanel->setDefaultEmail('cpanelphpobject.com', ':fail:');
                        

Subdomain Management

$result = $cpanel->createSubdomain('dev', 'cpanelphpobject.com', 'public_html/dev_site');
if (isset($result['error'])) {
    echo "Error creating subdomain: " . $result['error'];
} else {
    echo "Subdomain 'dev.cpanelphpobject.com' created successfully.";
}
                        

$result = $cpanel->deleteSubdomain('dev', 'cpanelphpobject.com');
if (isset($result['error'])) {
    echo "Error deleting subdomain: " . $result['error'];
} else {
    echo "Subdomain 'dev.cpanelphpobject.com' deleted successfully.";
}
                        

$subdomains = $cpanel->listSubdomains();
if (isset($subdomains['error'])) {
    echo "Error listing subdomains: " . $subdomains['error'];
} else {
    echo "Current Subdomains:\n";
    foreach ($subdomains as $sub) {
        echo "- " . $sub['domain'] . " (Path: " . (isset($sub['dir']) ? $sub['dir'] : 'N/A') . ")\n"; // Explicit check
    }
}
                        

Redirects

$result = $cpanel->addRedirect('cpanelphpobject.com', 'old-page.html', 'https://cpanelphpobject.com/new-page.html');
if (isset($result['error'])) {
    echo "Error adding page redirect: " . $result['error'];
} else {
    echo "Page redirect added successfully.";
}

// Add a wildcard redirect for a directory
$result = $cpanel->addRedirect('cpanelphpobject.com', 'old-blog', 'https://cpanelphpobject.com/new-blog', true);
if (isset($result['error'])) {
    echo "Error adding wildcard redirect: " . $result['error'];
} else {
    echo "Wildcard redirect added successfully.";
}
                        

$result = $cpanel->deleteRedirect('cpanelphpobject.com', 'old-page.html', 'https://cpanelphpobject.com/new-page.html');
if (isset($result['error'])) {
    echo "Error deleting redirect: " . $result['error'];
} else {
    echo "Redirect deleted successfully.";
}
                        

$redirects = $cpanel->listRedirects('cpanelphpobject.com');
if (isset($redirects['error'])) {
    echo "Error listing redirects: " . $redirects['error'];
} else {
    echo "Current Redirects for cpanelphpobject.com:\n";
    foreach ($redirects as $redir) {
        echo "- From: " . $redir['source'] . " To: " . $redir['destination'] . " (Type: " . (isset($redir['type']) ? $redir['type'] : 'Unknown') . ")\n"; // Explicit check
    }
}
                        

DNS Records (ZoneEdit)

$dnsRecords = $cpanel->listDNSRecords('cpanelphpobject.com');
if (isset($dnsRecords['error'])) {
    echo "Error listing DNS records: " . $dnsRecords['error'];
} else {
    echo "DNS Records for cpanelphpobject.com:\n";
    foreach ($dnsRecords as $record) {
        echo "- Line " . (isset($record['line']) ? $record['line'] : 'N/A') . ": " . (isset($record['name']) ? $record['name'] : 'N/A') . " (" . (isset($record['type']) ? $record['type'] : 'N/A') . ") -> " . (isset($record['address']) ? $record['address'] : 'N/A') . " (TTL: " . (isset($record['ttl']) ? $record['ttl'] : 'N/A') . ")\n"; // Explicit checks
    }
}
                        

// Example 1: Add an A record for a subdomain
$result = $cpanel->addDNSRecord('cpanelphpobject.com', 'test.cpanelphpobject.com.', 'A', 14400, '192.168.1.1');
if (isset($result['error'])) {
    echo "Error adding DNS A record: " . $result['error'];
} else {
    echo "DNS A record for 'test.cpanelphpobject.com' added successfully.";
}

// Example 2: Add a TXT record (e.g., for SPF or domain verification)
$result = $cpanel->addDNSRecord('cpanelphpobject.com', 'cpanelphpobject.com.', 'TXT', 3600, '\"v=spf1 include:_spf.google.com ~all\"');
if (isset($result['error'])) {
    echo "Error adding DNS TXT record: " . $result['error'];
} else {
    echo "DNS TXT record added successfully.";
}
                        

// Step 1: List records to find the line number of the record to delete
$dnsRecords = $cpanel->listDNSRecords('cpanelphpobject.com');
$lineToDelete = null; // Initialize variable

if (!isset($dnsRecords['error']) && is_array($dnsRecords)) {
    foreach ($dnsRecords as $record) {
        // Find the specific record you want to delete by its name and type
        if (isset($record['name']) && ($record['name'] === 'test.cpanelphpobject.com.') && (isset($record['type']) && $record['type'] === 'A')) {
            $lineToDelete = $record['line'];
            break; // Found it, no need to continue
        }
    }

    // Step 2: Attempt to delete the record if found
    if (null !== $lineToDelete) { // Using explicit null check as per style guide
        $result = $cpanel->deleteDNSRecord('cpanelphpobject.com', $lineToDelete);
        if (isset($result['error'])) {
            echo "Error deleting DNS record on line " . $lineToDelete . ": " . $result['error'];
        } else {
            echo "DNS record on line " . $lineToDelete . " deleted successfully.";
        }
    } else {
        echo "Specified DNS record not found for deletion.";
    }
} else {
    // Explicitly handle error or default message
    echo "Error listing DNS records: " . (isset($dnsRecords['error']) ? $dnsRecords['error'] : "Unknown API error.");
}
                        

Password Generator

$strongPassword = $cpanel->generateStrongPassword(24);
echo "Generated Strong Password: " . $strongPassword . "\n"; // Example: "Ab1!cDeFg2#IjKlM3$NoPqR4%tUv"

$defaultLengthPassword = $cpanel->generateStrongPassword();
echo "Default Length Password (20 chars): " . $defaultLengthPassword . "\n";
                        

Download

Download the latest version of The cPanel PHP Object here. Choose your preferred archive format:

Software License

MIT License

Copyright (c) 2025 Rev. Jeffery L. Paris

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Resource Links

Your safety and peace of mind are our priority. We carefully vet all external links in this section to ensure they are free from scams, spam, and intrusive pop-ups, providing a safe and reliable Browse experience for all our valued visitors.