Cpanel::Email::checkmaindiscard

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

SYNOPSIS

DESCRIPTION

if your default address is set to dev null fail or blackhole, it will set the cpanel variable maindiscard = 1 and return that variable as the status. Once this tag is called, you can use <cpanelif $CPVAR{'maindiscard'}> to access the variable.

VARIABLES

INPUT

OUTPUT

status (string): Whether or not the main account discards email. 1=yes, 0=no.

EXAMPLES

<?cp Email::checkmaindiscard(,) ?>

This example will set $CPVAR{'maindiscard'} to 1 or 0 depending on the discard status of the main email account for the domain.