Skip to content

Preview message

GET/post-delivery-quarantine/messages/{id}/preview

Email Management API · Post-Delivery Quarantine

Preview a message in post-delivery quarantine.

Parameters

Name In Type Required Description
X-Tenant-ID header string (uuid) Yes Tenant ID.
id path string (uuid) Yes ID from 'X-Sophos-Email-ID' header.

Request samples

curl -X GET "https://api-<data-region>.central.sophos.com/email/v1/post-delivery-quarantine/messages/<id>/preview" -H "Authorization: Bearer <access-token>" -H "X-Tenant-ID: <tenant-id>"


import requests

response = requests.get(
    "https://api-<data-region>.central.sophos.com/email/v1/post-delivery-quarantine/messages/<id>/preview",
    headers={
        "Authorization": "Bearer <access-token>",
        "X-Tenant-ID": "<tenant-id>",
    },
)
print(response.json())


$headers = @{
    "Authorization" = "Bearer <access-token>"
    "X-Tenant-ID" = "<tenant-id>"
}
Invoke-RestMethod -Method GET -Uri "https://api-<data-region>.central.sophos.com/email/v1/post-delivery-quarantine/messages/<id>/preview" -Headers $headers


package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, err := http.NewRequest("GET", "https://api-<data-region>.central.sophos.com/email/v1/post-delivery-quarantine/messages/<id>/preview", nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer <access-token>")
    req.Header.Set("X-Tenant-ID", "<tenant-id>")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}


const response = await fetch("https://api-<data-region>.central.sophos.com/email/v1/post-delivery-quarantine/messages/<id>/preview", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <access-token>",
    "X-Tenant-ID": "<tenant-id>",
  },
});
const data = await response.json();
console.log(data);

Responses

200 — Preview of a post-delivery quarantined message.

Response fields

headersarray of stringrequired
List of all MIME headers in the message.
htmlBodystring
The html body of the message.
textBodystring
The text body of the message.

Errors

Status Meaning
400 Bad request.
404 Not found.
500 Unexpected error.

All error responses share the same shape — see the error response object.

Response examples

200

{
  "headers": [
    "X-Sophos-Processing-Start-Time: 1603156423403"
  ],
  "htmlBody": "string",
  "textBody": "string"
}

See the guide for a narrative walkthrough of this API.