Child pages
  • cPanel API 1 Functions - Email::delpop

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

This function deletes an email account.

Warning
titleWarning:

Include Page
LIB:_cPanelAPI1NewerFunctions
LIB:_cPanelAPI1NewerFunctions

  • UAPI (recommended)Email::delete_pop
    Excerpt Include
    UAPI Functions - Email::delete_pop
    UAPI Functions - Email::delete_pop
    nopaneltrue
  • cPanel API 2Email::delpop
    Excerpt Include
    cPanel API 2 Functions - Email::delpop
    cPanel API 2 Functions - Email::delpop
    nopaneltrue
Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$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.

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
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.

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

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

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote

Expand
titleOutput (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.

Warning
titleImportant:

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.