---
title: "Add cPanel account to outbound email hold queue"
method: GET
path: "/hold_outgoing_email"
tags: ["Mail", "cPanel Account Mail Management"]
---

# Add cPanel account to outbound email hold queue

`GET /hold_outgoing_email`

This function sets Exim's queue to hold email that a user sends to an external address.

**Note:**

  If mail for a cPanel user's account is suspended, the system will reject their email before the mail server puts it in the queue.

## Query parameters

- `user` string, required

## Response `200`

HTTP Request was successful.

- object
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` - Success * `0` - Failed: Check the reason field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)