Child pages
  • UAPI Functions - Email::disable_spam_box

Versions Compared

Key

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

Description

Excerpt
This function disables the Apache SpamAssassin™ Spam Box feature for a cPanel account.


Note
titleNote:

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_box

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 Spam Box for the account.
$disable_sa = $cpanel->uapi(
    'Email', 'disable_spam_box'
);

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 Spam Box for the account.
my $disable_sa = $cpliveapi->uapi(
    'Email', 'disable_spam_box',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink
 


Expand
titlecPanel Template Toolkit


Code Block
languagexml
<!-- Disable Apache Spam Box. -->
[% execute('Email', 'disable_spam_box') %]

Include Page
LIB:_TTLink
LIB:_TTLink
 


Expand
titleCommand Line


Code Block
languagebash
uapi --user=username Email disable_spam_box

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "metadata": {

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


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

This function does not accept parameters.

Returns

This function only returns metadata.