cPanel UAPI / Email

cPanel UAPI terminate_mailbox_sessions

Find the endpoint, CLI syntax and practical purpose of this cPanel command, with a direct link to the official documentation.

What this command does

The cPanel documentation summary for this operation is: Stop cPanel account IMAP and POP3 connections.

In Hostilla.pl this page helps identify the exact API operation before using automation, reseller integrations or a support request.

Command details

API
cPanel UAPI 11.136.0.25
Category
Email
Method and path
GET /Email/terminate_mailbox_sessions
Operation ID
email-terminate_mailbox_sessions
CLI example
uapi --user=USER Email terminate_mailbox_sessions

Open official cPanel documentation

Practical request workflow

cPanel UAPI terminate_mailbox_sessions should be run only after the target account and expected result are known. Start with a read-only lookup when one is available, then make the smallest required change and verify the resource again.

  1. Confirm the cPanel account, domain and full mailbox or mail-routing target.
  2. Read the current mailbox, quota, forwarder or DNS state before changing it.
  3. Send only the parameters required by terminate_mailbox_sessions and keep credentials outside logs.
  4. Read the returned status and perform a second lookup or delivery test.

CLI request example

uapi --user=USER Email terminate_mailbox_sessions

How to read the response

For e-mail operations, verify the returned account, domain, quota or routing data and then test the mailbox or DNS state. Treat validation and policy errors as a request-data problem before retrying.

Record the request time, account and domain together with the returned status. A successful transport response does not by itself prove that the requested resource was created, changed or deleted exactly as intended.

Questions before automation

What permission does cPanel UAPI terminate_mailbox_sessions require?

Use the target cPanel account context or a least-privilege token allowed to perform this function.

What should I check before running terminate_mailbox_sessions?

Confirm the cPanel account, domain and full mailbox or mail-routing target. Read the current mailbox, quota, forwarder or DNS state before changing it.

How do I confirm that terminate_mailbox_sessions worked?

For e-mail operations, verify the returned account, domain, quota or routing data and then test the mailbox or DNS state. Treat validation and policy errors as a request-data problem before retrying.

Hostilla.pl usage notes

UAPI commands normally act inside a single cPanel account. Use the least-privilege token or the account context required for the task.

Need this operation for your hosting account? Contact Hostilla.pl support with the account name, domain and expected result. We will help select a safe API path.

Related practical guides

Related API navigation