https://github.com/eugenefvdm/export_whm_emails
Export WHM/cPanel email addresses and usage
https://github.com/eugenefvdm/export_whm_emails
cpanel php whm
Last synced: 6 months ago
JSON representation
Export WHM/cPanel email addresses and usage
- Host: GitHub
- URL: https://github.com/eugenefvdm/export_whm_emails
- Owner: eugenefvdm
- Created: 2020-02-13T06:25:54.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-06-26T08:29:34.000Z (over 2 years ago)
- Last Synced: 2025-03-25T11:52:17.341Z (7 months ago)
- Topics: cpanel, php, whm
- Language: PHP
- Homepage:
- Size: 37.1 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# WHM/cPanel Get a list of all emails for all accounts in .CSV format
## Description
A PHP script to output cPanel account and email addresses:
In this format:
```
user1@example.com,371.99,2000.00
user2@example.com,471.99,3000.00
user3@example.com,571.99,4000.00
```
or this format:
```
accountname1,email1@domain1.com
accountname1,email2@domain1.com
accountname2,email1@domain2.com
```
## Usage
Execute the script either for a specific username or for all accounts.
```shell
php export.php username
```
```shell
php export.php all
```
## Installation
First get the script on your computer:
```
git clone https://github.com/eugenevdm/export_whm_emails
cd export_whm_emails`
composer install`
```
Then copy `.env.example` to `.env` and add your server details:
```html
HOST=https://myserver.domain.com:2087
USERNAME=
AUTH_TYPE=
PASSWORD=
```
`AUTH_TYPE` can be `hash` or `password`
If you're using `hash`, get the hash from:
WHM-->>CLusters-->>Remote Access Key-->>Access Key For User
## Credits
https://packagist.org/packages/gufy/cpanel-php
The inspiration for this script was found on the cPanel forum.
https://forums.cpanel.net/threads/list-all-mailboxes-email-addresses-defined-on-server.75372/
Additional posts and script links exist on the cPanel forum too:
https://forums.cpanel.net/threads/export-email-account-addresses.82169/
## Support
Contact `eugene@vander.host` or +27 82 3096710 for support
https://vander.host
Servers, Emails, and Domain Name Registration