mail

Get a message

Scope: read. Pending claim keys allowed. With format=html the response adds sanitized html and blocked_images.

get/v1/messages/{id}

Request

  • Base URL: https://botmail.pro
  • URL: https://botmail.pro/v1/messages/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bm_session

Query parameters

format'html'

html = include sanitized HTML. Remote images are removed and counted in blocked_images; cid: images point at the attachment URL.

images'1'

1 = keep remote images in html.

Response

The message.

idstring required
thread_idstring required
mailbox_idstring required
uidinteger required

Monotonic per-mailbox counter.

direction'in' | 'out' required
statusstring required

Inbound: received, or held (account over storage quota; body hidden until released). Outbound: queued, held, blocked, sent, delivered, bounced, complained, failed.

status_reasonstring

Outbound only, on GET /v1/messages/{id}: why the message is held, blocked, bounced, complained or failed (e.g. the classifier verdict).

message_id_headerstring required

Message-ID without angle brackets.

in_reply_tostring
referencesstring[]
fromstring required
from_namestring
tostring[] required
ccstring[]
bccstring[]
reply_tostring
subjectstring required
snippetstring required
textstring

Plain-text body (up to 64 KB; full body via /raw). Empty for held messages.

size_bytesinteger required
has_attachmentsboolean required
auto_submittedboolean required

Sent by an automated system.

seenboolean required
starredboolean required
labelsstring[] required
sent_atstring date-time
created_atstring date-time required
htmlstring

Sanitized HTML. Only with format=html.

blocked_imagesinteger

Remote images removed from html. Only with format=html.

Example response

{
  "status": "received"
}

Changes

No recorded changes to this operation across all 1 revision of this API.