Cpanel::Email::setdefaultaddress

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

SYNOPSIS

DESCRIPTION

This function sets and displays the default address for a domain.

VARIABLES

INPUT

fwdemail (string): Default address for the domain. Format: user@domain.com
failmsgs (string): Content of message to sender if default account is set to fail with message to sender.
fwdopt (string): Options for where default address mail is forwarded to. (blackhole, fail, fwd, pipe)
pipefwd (string): Path of program to pipe default address mail to, if set to pipe mail. Relative to /home/username/
domain (string): Domain the default address is associated with. Format: domain.com

OUTPUT

domain (string): Domain the default address is associated with. Format: domain.com
dest (string): Default address or forwarder.

EXAMPLES

<?cp Email::setdefaultaddress(% %,domain,dest) email=$FORM{'email'},domain=$FORM{'domain'},fwdopt=$FORM{'fwdopt'},failmsgs=$FORM{'failmsgs'},pipefwd=$FORM{'pipefwd'},fwdemail=$FORM{'fwdemail'} ?>

This example will set the default address for a domain as well as outputting the domain and the destination of mail to the catch all (the default address).