Child pages
  • cPanel API 1 Functions - Email::delpop
Skip to end of metadata
Go to start of metadata

 

Description

This function deletes an email account.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

Examples 


 LiveAPI PHP Class
$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.


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
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.


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

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


Notes:

  • You must URI-encode these values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (none)

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.

Important:

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.