v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Email
Email Accounts

Stop email account's outgoing mail

This function sets Exim's queue to not send outgoing mail from an email account.

Notes:

  • To send all mail from the queue, use the UAPI Email::release_outgoing function.
  • To reject outgoing mail and not place mail in a queue, use the UAPI Email::suspend_outgoing function.
  • This function does not hold local outgoing mail.
get/Email/hold_outgoing

Query parameters

emailstring email required
Example:username@example.com

The email account's username.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "hold_outgoing",
  "module": "Email",
  "result": {
    "status": 1
  }
}