---
title: "Return server mail queue contents"
method: GET
path: "/fetch_mail_queue"
tags: ["Mail", "Mail Server Settings"]
---

# Return server mail queue contents

`GET /fetch_mail_queue`

This function retrieves the contents of the server's mail queue.

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `records` object[] — An array of objects that contain of the message information.
      - `frozen` 0 | 1 — Whether the mail message is frozen. * `1` — Frozen. * `0` — **Not** frozen.
      - `msgid` string — The mail message's ID.
      - `recipients` string[] — An array of the mail message's recipients.
      - `sender` string, email — The mail message's sender.
      - `size` integer — The mail message's size in bytes.
      - `time` integer — The mail message's timestamp.
      - `user` string, nullable — The mail message's owner.
  - `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)