---
title: "Stop email account's outgoing mail"
method: GET
path: "/Email/hold_outgoing"
tags: ["Email", "Email Accounts"]
---

# Stop email account's outgoing mail

`GET /Email/hold_outgoing`

This function sets Exim's queue to not send outgoing mail from an email account.

**Notes:**

* To send all mail from the queue, use the UAPI `Email::release_outgoing` function.
* To reject outgoing mail and not place mail in a queue, use the UAPI `Email::suspend_outgoing` function.
* This function does **not** hold local outgoing mail.

## Query parameters

- `email` string, email, required

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object, nullable
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
    - `status` 0 | 1 — * `1` - Success. * `0` - Failed. Check the `errors` field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.

---

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