Cpanel::Email::listdomainforwards

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

SYNOPSIS

DESCRIPTION

This tag will list all domains (sub, parked, addon) associated with the root domain, as well as the root domain, and their repesctive domain forwarders, if any.

VARIABLES

INPUT

domain (string): Root domain to list domain forwarders for. Format: domain.com

OUTPUT

forward (string): Domain being forwarded. Format: domain.com
dest (string): Destination of forwarded emails.

EXAMPLES

<?cp Email::listforwards(% %,dest,forward) domain=$FORM{'domain'} || '$LANG{'NoFwds'}' ?>

This example will output the names of all domains associated with the domain from a form and their respective domain forwarders. If no domain forwarders are present, it will output the language file entry for NoFwds.