Description

This function deletes an email account.

Examples 


$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$del_email_account = $cpanel->api1('Email', 'delpop', array('user', 'passwd', 'example.com') ); // Call the function.

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $del_email_account = $cpliveapi->api1('Email', 'delpop', ['user', 'passwd', 'example.com'] ); # Call the function.

 

<cpanel Module="Email::delpop( $FORM('email','flag','domain') )">
cpapi1 --user=username Email delpop user passwd example.com

This function does not return output.

Parameters

ParameterTypeDescriptionPossible valuesExample
emailstring

Required

The email account name.

The email account name.

For example, user if the email address is user@example.com.

user
flagsstring

Whether to remove the email address from the domain's passwd file.

If you do not specify a value, the function removes the mail account's home directory.

While this parameter is not required, we strongly recommend that you include it when you call the function.

  • passwd — Preserve the mail account's home directory.
  • Any other value — Remove the mail account's home directory.
passwd
domainstring

Required

The email account's domain.

The domain that corresponds to the email account.

For example, example.com if the email address is user@example.com.

example.com

Returns

This function does not return output.