Child pages
  • UAPI Functions - Email::delete_pop
Skip to end of metadata
Go to start of metadata

Description

This function deletes an email address.

Important:

In cPanel & WHM version 76 and later, when you disable the MailReceive role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/delete_pop?email=user&domain=example.com



Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Delete user@example.com.
$new_delete = $cpanel->uapi(
    'Email', 'delete_pop',
    array(
        'email'           => 'user',
        'domain'          => 'example.com',
        )
);


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.
 
# Delete user@example.com.
my $new_delete = $cpliveapi->uapi(
    'Email', 'delete_pop',
    {
        'email'           => 'user',
        'domain'          => 'example.com',
    }
);


Note:

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

 

 cPanel Template Toolkit
<!-- Delete user@example.com. -->
[% execute('Email', 'delete_pop', { 'email' => 'user', 'domain' => 'example.com' } ) %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 Command Line
uapi --user=username Email delete_pop email=user domain=example.com


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{  
   "messages":[  
      "",
      "Horde data for "user@example.com" has been removed.\n",
      "",
      ""
   ],
   "errors":null,
   "status":1,
   "metadata":{  

   },
   "data":null
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
emailstring

Required

The email account username or address.

  • A valid email account username. For example, user if the email address is user@example.com.
  • A valid email address.
user
flagsstring

Whether to remove the mail account's home mail directory.

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

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

The email account's domain.

This parameter defaults to the cPanel account's main domain.

A valid domain on the cPanel account.

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

example.com
skip_quotaBoolean

Whether to modify the mail account's quota file.

This parameter defaults to 0.

  • 1 — Do not modify.
  • 0 — Modify.
0

Returns

This function only returns metadata.