cPanel API 1 Functions - Email::delpop - Knowledgebase

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:

UAPI (recommended) — Email::delete_pop — This function deletes an email address.
cPanel API 2 — Email::delpop — This function deletes an email account.

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.

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.

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Email::delpop( $FORM('email','flag','domain') )">

Output (none)

This function does not return output.

Parameters

Parameter	Type	Description	Possible values	Example
email	string	Required The email account name.	The email account name. For example, user if the email address is user@example.com.	user
flags	string	Whether to remove the email address from the domain's passwd file. Important: While this parameter is not required, we strongly recommend that you include it when you call the function.	passwd	passwd
domain	string	Required The email account's domain.	The domain that corresponds to the email account. For example, example.com if the email address isuser@example.com.	example.com

Returns

This function does not return output.

Knowledgebase

Categories

Categories