UAPI Functions - Email::delete_auto_responder

Description

This function deletes an autoresponder.

Examples 


 cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Email/delete_auto_responder?email=user%40example.com

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// Delete an autoresponder for user@example.com
$delete_auto_responder $cpanel->uapi(
    'Email''delete_auto_responder',
    array(
        'email'         => 'user@example.com',
         )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Delete an autoresponder for user@example.com
my $delete_auto_responder $cpliveapi->uapi(
    'Email''delete_auto_responder',
    {
        'email'         => 'user@example.com',
    }
);

 cPanel Template Toolkit

<!-- Delete an autoresponder for user@example.com -->
[% data = execute( 'Email', 'delete_auto_responder', { 'email' => 'user@example.com' } ); %]

 Command Line

uapi --user=username Email delete_auto_responder email=user%40example.com

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
      
  },
  "data": null
}

 

Note:

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

 

Parameters

 Parameter 

Type

Description

Possible values

Example

email

 string 

Required

 The email account. 

 A valid email address on the cPanel account. 

 user@example.com 

 

Returns

This function does not return output.

 

  • 7 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....