We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

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

Guide to cPanel API 1

Return Data

cPanel Tags 
(deprecated) 

 Bandwidth

Bandwidth:: displaybwheader

Bandwidth:: displaybw

Bandwidth:: displayday

Bandwidth:: displaymainbwheader

 BoxTrapper

BoxTrapper:: changestatus

BoxTrapper:: cleancfgfilelist

BoxTrapper:: editmsg

BoxTrapper:: fetchcfgfile

BoxTrapper:: getboxconfdir

BoxTrapper:: listmsgs

BoxTrapper:: logcontrols

BoxTrapper:: messageaction

BoxTrapper:: multimessageaction

BoxTrapper:: resetmsg

BoxTrapper:: savecfgfile

BoxTrapper:: saveconf

BoxTrapper:: showautowhitelist  

BoxTrapper:: showemails

BoxTrapper:: showfromname

BoxTrapper:: showlog

BoxTrapper:: showmessage  

BoxTrapper:: showqueue

BoxTrapper:: showqueuesearch

BoxTrapper:: showqueuetime

BoxTrapper:: status  

BoxTrapper:: statusbutton  

 Branding

Branding:: file

Branding:: image

Branding:: killimg

Branding:: setbrandingpkg

Branding:: setmyacctspkg

Branding:: setupdirs

Branding:: tempsetbrandingpkg

 Chkservd

Chkservd:: geteximport

Chkservd:: geteximport_ssl

 ClamScanner

ClamScanner:: bars

 cPAddons

cPAddons:: mainpg

 Cron

Cron:: crontab_perms

 CustInfo

CustInfo:: getemail

 DenyIp

DenyIp:: adddenyip

DenyIp:: deldenyip

DenyIp::   listdenyips

 DiskUsage

DiskUsage:: showmanager

 Email

Email:: addautoresponder

Email:: adddforward

Email:: addfilter

Email:: addlist

Email:: addmx

Email:: addpop

Email:: addspam

Email:: addspambox

Email:: addspamfilter

Email:: changemx

Email:: checkfastmail

Email:: checkpipefwd

Email:: clearspambox

Email:: delautoresponder

Email:: deldforward

Email:: delfilter

Email:: dellist

Email:: delmx

Email:: delpop

Email:: delspam

Email:: delspambox

Email:: disable_spam_autodelete

Email:: editquota

Email:: enable_spam_autodelete

Email:: getaging

Email:: getarsbody

Email:: getarscharset

Email:: getarsfrom

Email:: getarshtml

Email:: getarsinterval

Email:: getarsstart

Email:: getarsstop

Email:: getarssubject

Email:: getmailserver

Email:: getmailserveruser

Email:: getpopquota

Email:: has_spam_as_acl

Email:: has_spam_autodelete

Email:: listmaildomains

Email:: listmaildomainsopt

Email:: listmaildomainsoptndef

Email:: mainacctdiskused

Email:: passwdlist

Email:: passwdpop

Email:: setmxaccept

Email:: spamboxstatus

Email:: spamstatus

Email:: tracefilter

 Fileman

Fileman:: changeperm

Fileman:: delfile

Fileman:: dofileop

Fileman:: emptytrash

Fileman:: extractfile

Fileman:: fileimg

Fileman:: fmmkdir

Fileman:: fmmkfile

Fileman:: fmpushfile

Fileman:: fmrename

Fileman:: fmsavefile

Fileman:: fmsavehtmlfile

Fileman:: fullbackup

Fileman:: getfile

Fileman:: htmleditor

Fileman:: killdir

Fileman:: listfiles

Fileman:: listfullbackups

Fileman:: listtemplates

Fileman:: restoreaf

Fileman:: restoredb

Fileman:: restorefile

Fileman:: restorefiles

Fileman:: savehtmlfile

Fileman:: showperm

Fileman:: uploadfiles

Fileman:: viewfile

 Frontpage

FrontPage:: addfp

FrontPage:: delfp

FrontPage:: fpstatus

 Gpg

Gpg:: deletekey

Gpg:: exportkey

Gpg:: exportsecretkey

Gpg:: genkey

Gpg:: importkeys

 Htaccess

Htaccess:: checkprotected

Htaccess:: del_user

Htaccess:: getindex

Htaccess:: htdirls

Htaccess:: number_of_users

Htaccess:: phpselectable

Htaccess:: resname

Htaccess:: set_pass

Htaccess:: set_protect

Htaccess:: setindex

Htaccess:: setphpreference

Htaccess:: showusers

 ImageManager

ImageManager:: convert

ImageManager:: dimensions

ImageManager:: hdimension

ImageManager:: scale

ImageManager:: thumbnail

ImageManager:: wdimension

 LastLogin

LastLogin:: lastlogin

 LeechProtect

LeechProtect:: disable

LeechProtect:: enable

LeechProtect:: setup

LeechProtect:: showpasswdfile

LeechProtect:: status

 LogManager

LogManager:: listdownloads

LogManager:: savesettings

LogManager:: showsettings

 MagicRevision

MagicRevision:: uri

 Mime

Mime:: add_handler

Mime:: add_hotlink

Mime:: add_mime

Mime:: add_redirect

Mime:: del_handler

Mime:: del_hotlink

Mime:: del_mime

Mime:: del_redirect

Mime:: linkallownull

Mime:: linkenable

Mime:: linkexts

Mime:: linkrurl

Mime:: linkurls

 Mysql

Mysql:: adddb

Mysql:: addhost

Mysql:: adduser

Mysql:: adduserdb

Mysql:: checkdb

Mysql:: deldb

Mysql:: delhost

Mysql:: deluser

Mysql:: deluserdb

Mysql:: gethost

Mysql:: initcache

Mysql:: listdbs

Mysql:: listdbsopt

Mysql:: listusers

Mysql:: listusersopt

Mysql:: number_of_dbs

Mysql:: number_of_users

Mysql:: repairdb

Mysql:: routines

Mysql:: updateprivs

 Net

Net:: dnslookup

Net:: dnszone

Net:: sethastraceroute

 News

News:: displaynews

 NVData

NVData:: set

 OptimizeWS

OptimizeWS:: loadoptimizesettings

OptimizeWS:: loadoptimizesettings (bytes)

OptimizeWS:: optimizews

 Park

Park:: disableredirect

Park:: getredirecturl

Park:: park

Park:: setredirecturl

Park:: unpark

 Postgres

Postgres:: adddb

Postgres:: adduser

Postgres:: adduserdb

Postgres:: deldb

Postgres:: deluser

Postgres:: deluserdb

Postgres:: initcache

Postgres:: listdbsopt

Postgres:: listusersopt

Postgres:: number_of_dbs

Postgres:: number_of_users

 ProxyUtils

ProxyUtils:: proxyaddress

 Resellers

Resellers:: accountlistopt

Resellers:: themelistopt

 Serverinfo

Serverinfo:: servicestatus

 SetLang

SetLang:: listlangsopt

SetLang:: setlang

 SpamAssassin

SpamAssassin:: config

SpamAssassin:: saveconfig

 SSH

SSH:: getport

 SSL

SSL:: delete

SSL:: deletecrt

SSL:: deletecsr

SSL:: deletekey

SSL:: gencrt

SSL:: gencsr

SSL:: genkey

SSL:: getcabundle

SSL:: getcnname

SSL:: install

SSL:: installedhost

SSL:: listkeysopt

SSL:: showcrt

SSL:: showcsr

SSL:: showkey

SSL:: sslsharedstatus

SSL:: uploadcrt

SSL:: uploadkey

 StatManager

StatManager:: doForm

StatManager:: updateUserConfig

 Stats

Stats:: analoglist

Stats:: awstats

Stats:: bwbar

Stats:: errlog

Stats:: lastvisitors

Stats:: showbandwidth

Stats:: webalizer

Stats:: webalizerftp

 SubDomain

SubDomain:: addsubdomain

SubDomain:: cplistsubdomains

SubDomain:: disablesubrd

SubDomain:: listsubdomainsop

SubDomain:: setsuburl

 UI

UI:: confirm

UI:: redirect

UI:: showresult

 

Description

This function checks whether the server uses Spam Filters™ to autodelete spam. The function configures the spam_auto_delete and spam_auto_delete_score cPvariables with the results. You can use these variables in cpanelif tags.

Warning:

cPanel API 1 is deprecated. We strongly recommend that you do not use cPanel API 1. However, no equivalent function exists in our newer APIs.

Examples 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$spam_autodelete = $cpanel->api1('Email', 'has_spam_autodelete') ); // 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 $spam_autodelete = $cpliveapi->api1('Email', 'has_spam_autodelete'); # 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::has_spam_autodelete() )">
 Command Line
cpapi1 --user=username Email has_spam_autodelete


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.

  • If you run CloudLinux™, you must use the full path of the cpapi1 command:

    /usr/local/cpanel/bin/cpapi1

 Output (none)

This function does not return output.

Parameters

This function does not accept parameters.

Returns

This function does not return output.

 

Function information

Module:

Email

API Version:

cPanel API 1

Available in:

cPanel 11+

Methods:

GET, POST

Required Parameters:

(none)

Return Formats:

(none)

About this module

The Email module modifies cPanel email account settings.

About cPanel API 1

cPanel API 1 accesses information about cPanel accounts.


Warning:

cPanel API 1 is deprecated. We strongly recommend that you use cPanel API 2 or UAPI instead. 

Notes:

  • These functions may require a feature list. To view the available feature lists on a cPanel server, view WHM's Feature Manager interface.
  • Unless you call this API via the WHM API, you must use the appropriate cPanel ports ( 2082  or  2083 ). You can also call some functions via cPanel's Webmail ports ( 2095  or 2096 ). 
  

Find a function

Related functions