latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Mail
cPanel Account Mail Management

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.

get/terminate_cpuser_mailbox_sessions

Query parameters

usernamestring username required
Example:username

The cPanel account's username.

Response

HTTP Request was successful.

Example response

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