Cpanel::Email::listdefaultaddresses

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


SYNOPSIS

Cpanel::Email::listdefaultaddresses


DESCRIPTION

This tag will list the default address for each domain (parked, sub, addon) associated with the inputted domain.


VARIABLES

INPUT

domain (string)
The root domain to show all default addresses for. Format: domain.com

OUTPUT

defaultaddress (string)
Default address / destination for the catch all.

domain (string)
Domain the default address is set for. Format: domain.com


EXAMPLES

<?cp Email::listdefaultaddresses(% %,domain,defaultaddress) domain=$FORM{'domain'} ?>

This example will output all domains associated with the domain from a form and their respective default addresses.


COPYRIGHT

Copyright 2007 cPanel Inc.