Child pages
  • WHM API 1 Functions - hold_outgoing_email

Versions Compared

Key

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

Description

Excerpt

This function sets Exim's queue to hold email that a user sends to an external address.


Note
titleNote:

If mail for a cPanel user's account is suspended, the system will reject their email before the mail server puts it in the queue.

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

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/hold_outgoing_email?api.version=1&user=example



Expand
titleXML API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/hold_outgoing_email?api.version=1&user=example



Expand
titleCommand Line


Code Block
languagebash
whmapi1 hold_outgoing_email user=example

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "hold_outgoing_email"
  }
}



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
<result>
   <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>hold_outgoing_email</command>
    </metadata>
</result>


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The cPanel account.

A valid cPanel account.

Note
titleNote:

You cannot suspend the root user's outgoing email with this function.


example

Returns

This function only returns metadata.