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

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

Description

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

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/disable_spam_autodelete


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.

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

);


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.

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

);


Note:

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

 

 cPanel Template Toolkit
<!-- Disable Apache SpamAssassin spam auto-delete feature. -->
[% execute('Email', 'disable_spam_autodelete',) %]


Note:

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

 

 Command Line
uapi --user=username Email disable_spam_autodelete 


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)
{  
   "errors":null,
   "data":{  
      "spam_auto_delete":0
   },
   "messages":null,
   "warnings":null,
   "status":1,
   "metadata":{  

   }
}


Note:

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

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

  • No labels