# Add cPanel account to outbound email hold queue

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



  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.

Endpoint: GET /hold_outgoing_email
Version: 11.134.0.5
Security: BasicAuth

## Query parameters:

  - `user` (string, required)
    The cPanel account.



You  suspend the root user's outgoing email with this function.
    Example: "example"

## Response 200 fields (application/json):

  - `metadata` (object)

  - `metadata.command` (string)
    The method name called.
    Example: "hold_outgoing_email"

  - `metadata.reason` (string)
    The reason the API function failed when the  field is 0. This field may display a success message when a function succeeds.
    Example: "OK"

  - `metadata.result` (integer)
    *  - Success
*  - Failed: Check the reason field for more details.
    Enum: 0, 1

  - `metadata.version` (integer)
    The version of the API function.
    Example: 1