Cpanel::Email::getdiskusage

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


SYNOPSIS

Cpanel::Email::getdiskusage


DESCRIPTION

This tag will show the disk usage (in MB) for a specific email account.


VARIABLES

INPUT

domain (string)
Domain of email account. Format: domain.com or sub.domain.com

login (string)
Email account username. Format: username

user (string)
Email account username. Format: username

OUTPUT

diskused (integer)
Disk space used in MB.


EXAMPLES

<?cp Email::getdiskusage(%,diskused) user=$FORM{'email'},domain=$FORM{'domain'} ?>

This example will show the disk usage of an email account based on variables taken from a form.


COPYRIGHT

Copyright 2007 cPanel Inc.