Cpanel::Email::listpopswithdisk

This article documents the usage of the Cpanel::Email::listpopswithdisk function in relation to the cPanel interface. This tag can be used inside cPanel pages.


SYNOPSIS

Cpanel::Email::listpopswithdisk


DESCRIPTION

This function lists all email accounts for a domain, along with their disk space quota and disk space usage.


VARIABLES

INPUT

nearquotaonly (string)
Displays accounts with disk usage percentage greater than 95%, if nearquotaonly=1 (1,0)

infinitylang (string)
Use the language tag ``infinity'' for the infinity symbol if the item's limit is infinity. (1,0)

domain (string)
Domain to list email accounts for. Format: domain.com

infinityimg (string)
Use an image for the infinity symbol if the item's limit is infinity. (filename of image)

email (string)
Email account. Format: email@domain.com

OUTPUT

email (string)
Email account. Format: email@domain.com

diskused (integer)
Email account's disk space usage (in MB).

diskquota (integer)
Email account's disk space quota (in MB).


EXAMPLES

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

This example lists all email accounts associated with exampledomain.com and their respective disk space usages and disk space quotas.


COPYRIGHT

Copyright 2007 cPanel Inc.