List all email accounts and forwarders on the server

I want to be able to list all of the email accounts and forwarders setup for every domain on the server.

I don't want to have to go through each and every account and look at the email accounts for that account. Is there a way to list all accounts through the API or through a script?

Reason is - I need a human readable backup of all email accounts on the server.

Thanks,
Jeremy

 

Hi David,

I've never messed around with the API at all - I am very new to it. The documentation says that in order to list all email accounts for an account I need to run something similar to this:

"<?cp Email::listpopswithdisk(% % % email,diskused,diskquota) domain=exampledomain.com ?>"

I don't understand where I need to put this in order to get the list. I know how to get a list of all domains - but I don't how to use this.

Thanks,
Jeremy

 

I have modified the "api2_example_withargs.php" file but it does not seem to be listing the correct information.

I have picked out below the "allamericancitylandscaping.com" account. I know that they have 1 email account setup - "info@allamericancitylandscaping.com". However it is not listed in the following information.

Here is what is listed when I run the script:

I have also included the modified api2_example_withargs.php. It reads in a CSV file that has all account names and domains listed. I have included the relevant entry below as well as the script.

CSV FILE:

PHP File:

PHP:

<?php
# cpanel12 - api2_example_withargs.php                Copyright(c) 1997-2009 cPanel, Inc.
#                                                           All Rights Reserved.
# copyright@cpanel.net                                         http://cpanel.net

include("xmlapi.php.inc");

$ip = "127.0.0.1";
$root_pass = "PASSWORD";

$accounts_list = file("/home/scripts/cp_xmlapi_php/account_list.csv");
$domains_list = file("/home/scripts/cp_xmlapi_php/domain_list.csv");
$domains_accounts = file("/home/scripts/cp_xmlapi_php/domains_list.csv");

foreach($domains_accounts as $acc_user)
{
$accounts_user = explode(",",$acc_user);
$account = $accounts_user[1];
//$email_account = "someemail";
$email_domain = $accounts_user[0];

$xmlapi = new xmlapi($ip);
$xmlapi->password_auth("root",$root_pass);

$xmlapi->set_debug(1);
//print $xmlapi->api2_query($account, "Email", "listmaildomains", $account);
print $xmlapi->api2_query($account, "Email", "listpopswithdisk", array(domain=>$email_domain) );
}

?>

 

That was it - after I stripped the "\r\n" from the line it printed all the email accounts out fine.

 

If anyone is interested, this is the end result - I didn't take time to format the output or anything.

PHP:

<?php
# cpanel12 - api2_example_withargs.php                Copyright(c) 1997-2009 cPanel, Inc.
#                                                           All Rights Reserved.
# copyright@cpanel.net                                         http://cpanel.net

include("xmlapi.php.inc");

$ip = "0.0.0.0";
$root_pass = "PASSWORD";

$domains_accounts = file("/home/scripts/cp_xmlapi_php/domains_list.csv");

foreach($domains_accounts as $domain_user)
{
$domain_user = str_replace("\r\n", "", $domain_user);
$domain_user = explode(",",$domain_user);
$account = $domain_user[1];
$email_domain = $domain_user[0];

$xmlapi = new xmlapi($ip);
$xmlapi->password_auth("root",$root_pass);

$xmlapi->set_debug(1);
echo "Domain: $email_domain \n";
echo "Email Accounts: ";
print $xmlapi->api2_query($account, "Email", "listpopswithdisk", array(domain=>$email_domain) );
echo "Domain Forwarders: \n";
print $xmlapi->api2_query($account, "Email", "listforwards", array(domain=>$email_domain) );

}

?>