Child pages
  • UAPI Functions - Email::disable_spam_autodelete

Versions Compared

Key

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

Description

Excerpt

This function disables the Apache SpamAssassin™ auto-delete spam feature.

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledSpamFilterRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone


Expand
titlecPanel or Webmail Session URL


Code Block
languagetext
https://hostname.example.com:2083/cpsess##########/execute/Email/disable_spam_autodelete

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Disable Apache SpamAssassin spam auto-delete feature.
$sa_settings = $cpanel->uapi(
    'Email', 'disable_spam_autodelete',

);

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.

# Disable Apache SpamAssassin spam auto-delete feature.
my $sa_settings = $cpliveapi->uapi(
    'Email', 'disable_spam_autodelete',

);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 


Expand
titlecPanel Template Toolkit


Code Block
languagexml
<!-- Disable Apache SpamAssassin spam auto-delete feature. -->
[% execute('Email', 'disable_spam_autodelete',) %]

Include Page
LIB:_TTLink
LIB:_TTLink

 


Expand
titleCommand Line


Code Block
languagebash
uapi --user=username Email disable_spam_autodelete 

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{  
   "errors":null,
   "data":{  
      "spam_auto_delete":0
   },
   "messages":null,
   "warnings":null,
   "status":1,
   "metadata":{  

   }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
spam_auto_deleteBoolean

Whether the auto-delete spam feature is disabled.

0 is the only possible value.

0