Suspend email account outgoing mail

This function rejects outgoing mail for a suspended email account. This function does not disable a user's login credentials or access permissions to their email account.

Notes:

To suspend a user's login credentials and prevent authenticated connections to the email account, use the UAPI Email::suspend_login function.
To allow an email account to send mail, use the UAPI Email::unsuspend_outgoing function.
To hold outgoing mail in Exim's queue, use the UAPI Email::hold_outgoing function.

Important:

When you disable the Send Mail role, the system disables this function.

SecurityBasicAuth

Request

query Parameters

required

string <email>

The email account's username.

Example: email=username@example.com

Responses

200

HTTP Request was successful.

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

get/Email/suspend_outgoing

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

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

Response samples

application/json

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