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.

Authorizations:

BasicAuth

query Parameters

required

string <email>

The email account's username.

Example: email=username@example.com

Responses

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Email \
  hold_outgoing \
  email='username@example.com'

Response samples

Content type

application/json

{"apiversion": 3,
"func": "hold_outgoing",
"module": "Email",
"result": {"data": null,
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}

Next to Return domain's autoresponders