Stop cPanel account IMAP and POP3 connections

This function terminates all IMAP and POP3 connections for a cPanel account.

Note:

This function ends connections for every email address, which includes the default address.

SecurityBasicAuth

Request

username

required

string <username>

The cPanel account's username.

Example: username=username

Responses

200

HTTP Request was successful.

object

get/terminate_cpuser_mailbox_sessions

Request samples

whmapi1 --output=jsonpretty \
  terminate_cpuser_mailbox_sessions \
  username='username'

Response samples

application/json

{"metadata": {"command": "terminate_cpuser_mailbox_sessions",
"reason": "OK",
"result": 1,
"version": 1
}
}