server.htaccess

cPanelAPI1Functions-BoxTrapper::saveconfGuidetocPanelAPI1ReturnDatacPanelTags(deprecated)Bandwidth::displaybwheaderBandwidth::displaybwBandwidth::displaydayBandwidth::displaymainbwheaderBoxTrapper::changestatusBoxTrapper::cleancfgfilelistBoxTrapper::editmsgBoxTrapper::fetchcfgfileBoxTrapper::getboxconfdirBoxTrapper::listmsgsBoxTrapper::logcontrolsBoxTrapper::messageactionBoxTrapper::multimessageactionBoxTrapper::resetmsgBoxTrapper::savecfgfileBoxTrapper::saveconfBoxTrapper::showautowhitelistBoxTrapper::showemailsBoxTrapper::showfromnameBoxTrapper::showlogBoxTrapper::showmessageBoxTrapper::showqueueBoxTrapper::showqueuesearchDescriptionThisfunctionmodifiesanaccount'sBoxTrapperconfiguration.
Examples$cpanel=newCPANEL();//ConnecttocPanel-onlydothisonce.
$edit_boxtrapper_config=$cpanel->api1('BoxTrapper','saveconf',array('user@example.
com','sender1@test.
com,sender2@test.
com','14','1','UserName'Callthefunction.
my$cpliveapi=Cpanel::LiveAPI->new();#ConnecttocPanel-onlydothisonce.
my$edit_boxtrapper_config=$cpliveapi->api1('BoxTrapper','saveconf',['user@example.
com','sender1@test.
com,sender2@test.
com','14','1','UserName']);#Callthefunction.
FunctioninformationModule:BoxTrapperAPIVersion:cPanelAPI1Availablein:cPanel11+Methods:GET,POSTRequiredParameters:account,,froms,queuetimeauto,whitelistfromnameReturnFormats:(none)AboutthismoduleThemoBoxTrapperdulemanagestheBoxTrappersubsystem.
AboutcPanelAPI1cPanelAPI1accessesinformationaboutcPanelaccounts.
Warning:cPanelAPI1isdeprecated.
Donotusethisfunction.
Instead,westronglyrecommendthatyouusethefollowingnewerfunctions:(recommended)UAPI——BoxTrapper::save_configurationThisfunctionmodifiesanaccount'sBoxTrapperconfiguration.
cPanelAPI2—None.
Important:IncPanel&WHMversion76andlater,whenyoudisabletheMailReceiverole,thesystemthisfunction.
disablesFormoreinformation,readourHowtoUseServerProfilesdocumentation.
Note:Formoreinformation,readour.
GuidetotheLiveAPISystemNote:Formoreinformation,readour.
GuidetotheLiveAPISystemNote:ThismodulerequiresaccesstotheBoxTrapperfeature.
BoxTrapper::showqueuetimeBoxTrapper::statusBoxTrapper::statusbuttonBranding::fileBranding::imageBranding::killimgBranding::setbrandingpkgBranding::setmyacctspkgBranding::setupdirsBranding::tempsetbrandingpkgCgi::backuplinkCgi::displayurchinCgi::phpmyadminlinkChkservd::geteximportChkservd::geteximport_sslClamScanner::barscPAddons::mainpgCron::crontab_permsCustInfo::getemailDenyIp::adddenyipDenyIp::deldenyipDenyIp::listdenyipsDiskUsage::showmanagerEmail::addautoresponderEmail::adddforwardEmail::addfilterEmail::addlistEmail::addmxEmail::addpopEmail::addspamEmail::addspamboxEmail::addspamfilterEmail::changemxEmail::checkfastmailEmail::checkpipefwdcpapi1--user=usernameBoxTrappersaveconfuser@example.
comsender1@test.
com,sender2@test.
com141"UserName"Thisfunctiondoesnotreturnoutput.
ParametersParameterTypeDescriptionPossiblevaluesExampleaccountstringRequiredTheaccount'semailaddress.
Avalidemailaddressontheserver.
user@example.
comfromsstringRequiredTheemailaddressesthatsendmailtotheaccount.
Acomma-separatedlistofemailaddresses.
sender1@test.
com,sender2@test.
comqueuetimeintegerRequiredThenumberofdaystoretainlogfilesandqueuedmessages.
Apositiveinteger.
14autowhitelistBooleanRequiredWhethertoenableautomaticwhitelisting.
1—Enable.
0—Disable.
1fromnamestringRequiredThenamethatFrom:BoxTrapperformemailsuse.
Anyvalidstring.
UserNameWarning:IncPanel&WHMversion11.
30andlater,cPaneltagsaredeprecated.
WeprovidethisexampletohelpdevelopersmovefromtheoldcPaneltagsystemtooursystem.
WerecommendLiveAPIstronglythatyouusethesystemtocallthecPanelAPIs.
onlyLiveAPINotes:Youthesevalues.
mustURI-encodeusernamerepresentsyouraccount-levelusername.
Formoreinformationandadditionaloutputoptions,readourdocumentationorruntheGuidetocPanelAPI1cpapi1--command.
helpIfyourunCloudLinux,youusethefullpathofthemustcpcommand:api1/usr/local/cpanel/bin/cpapi1Warning:cPanelAPI1isde.
precatedWestronglyrecommendthatyouusecPanelorAPI2UAPIinstead.
Notes:Email::clearspamboxEmail::delautoresponderEmail::deldforwardEmail::delfilterEmail::dellistEmail::delmxEmail::delpopEmail::delspamEmail::delspamboxEmail::disable_spam_autodeleteEmail::editquotaEmail::enable_spam_autodeleteEmail::getagingEmail::getarsbodyEmail::getarscharsetEmail::getarsfromEmail::getarshtmlEmail::getarsintervalEmail::getarsstartEmail::getarsstopEmail::getarssubjectEmail::getmailserverEmail::getmailserveruserEmail::getpopquotaEmail::has_spam_as_aclEmail::has_spam_autodeleteEmail::listmaildomainsEmail::listmaildomainsoptEmail::listmaildomainsoptndefEmail::mainacctdiskusedEmail::passwdlistEmail::passwdpopEmail::setmxacceptEmail::spamboxstatusReturnsThisfunctiondoesnotreturnoutput.
Thesefunctionsmayrequireafeaturelist.
ToviewtheavailablefeaturelistsonacPanelserver,viewWHM'sFeatureManagerinterface.
UnlessyoucaEmail::spamstatusEmail::tracefilterFileman::changepermFileman::delfileFileman::dofileopFileman::emptytrashFileman::extractfileFileman::fileimgFileman::fmmkdirFileman::fmmkfileFileman::fmpushfileFileman::fmrenameFileman::fmsavefileFileman::fmsavehtmlfileFileman::fullbackupFileman::getfileFileman::htmleditorFileman::killdirFileman::listfilesFileman::listfullbackupsFileman::listtemplatesFileman::restoreafFileman::restoredbFileman::restorefileFileman::restorefilesFileman::savehtmlfileFileman::showpermFileman::uploadfilesFileman::viewfileFrontPage::addfpFrontPage::delfpFrontPage::fpstatusFtp::addftpFtp::delftpFtp::ftpquotaFtp::ftpservernameFtp::ftpstatsloginFtp::get_anonftpllthisAPIviatheWHMAPI,youmustusetheappropriatecPanelports(2082or2083).
YoucanalsocallsomefunctionsviacPanel'sWebmailporFtp::get_anonftpinFtp::get_welcomemsgFtp::getftpquotaFtp::kill_ftp_sessionFtp::listftpstatsurlFtp::passwdftpFtp::set_anonftpFtp::set_anonftpinFtp::set_welcomemsgGpg::deletekeyGpg::exportkeyGpg::exportsecretkeyGpg::genkeyGpg::importkeysHtaccess::checkprotectedHtaccess::del_userHtaccess::getindexHtaccess::htdirlsHtaccess::number_of_usersHtaccess::phpselectableHtaccess::resnameHtaccess::set_passHtaccess::set_protectHtaccess::setindexHtaccess::setphpreferenceHtaccess::showusersImageManager::convertImageManager::dimensionsImageManager::hdimensionImageManager::scaleImageManager::thumbnailImageManager::wdimensionLastLogin::lastloginFindafunctionRelatedfunctionscPanelAPI1Functions-Email::addspam—ThisfunctionenablesApacheSpamAssassinforacPanelaccount.
cPanelAPI1Functions-Email::addspamfilter—ThisfunctionmodifiestheminimumApacheSpamAssassinspamscore.
cPanelAPI1Functions-Email::spamboxstatus—ThisfunctioncheckswhetherApacheSpamAssassinSpamBoxisenabled.
cPanelAPI1Functions-SpamAssassin::config—ThisfunctionprintsthecPanelaccount'sApacheSpamAssassin'sdefaultvalues.
cPanelAPI1Modules-SpamAssassin—TheSpamAssassinmodulemodifiesApacheSpamAssassinsettings.
ts(2095or2096).
LeechProtect::disableLeechProtect::enableLeechProtect::setupLeechProtect::showpasswdfileLeechProtect::statusLogManager::listdownloadsLogManager::savesettingsLogManager::showsettingsMagicRevision::uriMime::add_handlerMime::add_hotlinkMime::add_mimeMime::add_redirectMime::del_handlerMime::del_hotlinkMime::del_mimeMime::del_redirectMime::linkallownullMime::linkenableMime::linkextsMime::linkrurlMime::linkurlsMysql::adddbMysql::addhostMysql::adduserMysql::adduserdbMysql::checkdbMysql::deldbMysql::delhostMysql::deluserMysql::deluserdbMysql::gethostMysql::initcacheMysql::listdbsMysql::listdbsoptMysql::listusersMysql::listusersoptMysql::number_of_dbsMysql::number_of_usersMysql::repairdbMysql::routinesMysql::updateprivsNet::dnslookupNet::dnszoneNet::sethastracerouteNews::displaynewsNVData::setOptimizeWS::loadoptimizesettingsOptimizeWS::loadoptimizesettings(bytes)OptimizeWS::optimizewsPark::disableredirectPark::getredirecturlPark::parkPark::setredirecturlPark::unparkPostgres::adddbPostgres::adduserPostgres::adduserdbPostgres::deldbPostgres::deluserPostgres::deluserdbPostgres::initcachePostgres::listdbsoptPostgres::listusersoptPostgres::number_of_dbsPostgres::number_of_usersProxyUtils::proxyaddressResellers::accountlistoptResellers::themelistoptServerinfo::servicestatusSetLang::listlangsoptSetLang::setlangSpamAssassin::configSpamAssassin::saveconfigSSH::getportSSL::deleteSSL::deletecrtSSL::deletecsrSSL::deletekeySSL::gencrtSSL::gencsrSSL::genkeySSL::getcabundleSSL::getcnnameSSL::installSSL::installedhostSSL::listkeysoptSSL::showcrtSSL::showcsrSSL::showkeySSL::sslsharedstatusSSL::uploadcrtSSL::uploadkeyStatManager::doFormStatManager::updateUserConfigStats::analoglistStats::awstatsStats::bwbarStats::errlogStats::lastvisitorsStats::showbandwidthStats::webalizerStats::webalizerftpSubDomain::addsubdomainSubDomain::cplistsubdomainsSubDomain::disablesubrdSubDomain::listsubdomainsopSubDomain::setsuburlUI::confirmUI::redirectUI::showresult