v1

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

Start email account outgoing mail

This function sends all of the outgoing mail from Exim's queue for an email account.

Note:

To set Exim to queue all outgoing mail for an email account, use the UAPI Email::hold_outgoing function.

get/Email/release_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": "release_outgoing",
  "module": "Email",
  "result": {
    "status": 1
  }
}