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.

Authorizations:
query Parameters
username
required
string <username>

The cPanel account's username.

Example: username=username

Responses

Response Schema: application/json
object

Request samples

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

Response samples

Content type
application/json
{
  • "metadata": {
    • "command": "terminate_cpuser_mailbox_sessions",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}