Sign in

v1

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

Suspend email account incoming (SMTP) mail

This function suspends incoming email for an account. The system will reject incoming email while the account is suspended.

Notes:

  • The user can still log in to the email account. To suspend a user's ability to log in to, send mail from, and read their account, use the UAPI Email::suspend_login function.
  • Use the UAPI Email::unsuspend_incoming function to allow the account to receive email.

Important:

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

get/Email/suspend_incoming

Query parameters

emailstring email
Example:user@example.com

The email user's account name.

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": "suspend_incoming",
  "module": "Email",
  "result": {
    "status": 1
  }
}