Retrieve a stored message

Parameters

Request

curl -X GET 'https://app.mailyte.com/api/v1/domains/yourdomain.com/messages/01JBT8XQ2M9WYC3K4F6R7S8T9V' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'

const response = await fetch('https://app.mailyte.com/api/v1/domains/yourdomain.com/messages/01JBT8XQ2M9WYC3K4F6R7S8T9V', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer mk_live_YOUR_API_KEY',
  },
});
const { data } = await response.json();

import requests
response = requests.get(
    "https://app.mailyte.com/api/v1/domains/yourdomain.com/messages/01JBT8XQ2M9WYC3K4F6R7S8T9V",
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
)
data = response.json()["data"]

<?php

$response = Http::withToken('mk_live_YOUR_API_KEY')
    ->get('https://app.mailyte.com/api/v1/domains/yourdomain.com/messages/01JBT8XQ2M9WYC3K4F6R7S8T9V');

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/domains/yourdomain.com/messages/01JBT8XQ2M9WYC3K4F6R7S8T9V")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

Response

Success.

• dataobject
  • objectstringarchived_message | archived_message_preview

    Which of the two shapes you got. archived_message is the default and carries raw; archived_message_preview is ?format=html and carries the parsed fields instead. Branch on this, never on the presence of a key.

  • message_idstring

    The Message-ID, angle brackets included, as the send returned it.

  • domainstring

    The domain this copy is archived under.

  • archived_atstring

    When the message was archived. Null if the stored copy has no date.

  • legal_holdboolean

    Default shape only. True means retention cannot expire this copy.

  • rawstring

    The raw message (message/rfc822) exactly as stored: headers, body and attachments. It is not made safe, so do not show it in a browser; use ?format=html for that. Not present with ?format=html.

  • headersobject

    ?format=html only. The parsed headers, name to value.

  • htmlstring

    With ?format=html only: the HTML body, made safe to display, with scripts and remote content removed. Null when the message has no HTML part; show text instead.

  • textstring

    With ?format=html only: the plain-text body. Null when the message has no plain-text part. html and text can both be null.

  • attachmentsarray<object>

    With ?format=html only: each attachment's name, type and size, not the file itself.

  • blocked_remote_countinteger

    With ?format=html only: how many remote images or other content were blocked, so you can tell the reader.

Returned inside the standard envelope.

Errors

Every status, with what causes it and what to do, is on the error reference.