<Intro>

<EndpointHeader />

<Description>

Applies read-state, label, and contact changes to a message in a conversation. Omitted fields are left unchanged. The read flag is only valid on received messages.

</Description>

</Intro>

<Payload kind="request">

<Field name="labels" type="object">

<Description>

Label changes to apply. Labels in `add` are applied and labels in `remove` are taken off; other labels are left untouched. Adding a label that is already present, or removing one that is not, has no effect. System labels express state changes: on a conversation, adding `spam` files it as spam, adding `archive` files it away without deleting it, adding `inbox` (or removing `spam` or `archive`) returns it to the inbox, and removing `unread` marks all retained received messages as read in one call; on a message, adding or removing `unread` flips read state, and adding or removing `trash` moves it to or out of the trash. Changes that contradict this model are rejected: adding more than one placement label in one request, adding `blocked` (blocking a sender is a receive-rule decision), removing `inbox` without adding a destination, adding `trash` or `unread` to a conversation (removing `unread` is the mark-all-read shortcut; `trash` uses the DELETE verb), placement labels on a message (move its conversation instead), and `unread` on a sent message. Custom labels are 1-64 characters with no commas, control characters, or leading or trailing whitespace. System label names and a small reserved set (`all`, `archived`, `deleted`, `draft`, `drafts`, `flagged`, `important`, `junk`, `muted`, `none`, `outbox`, `pinned`, `read`, `scheduled`, `snoozed`, `starred`) cannot be used as custom labels, in any casing. A conversation or message carries at most 20 labels, system labels included.

</Description>

<FieldChildren kind="request">

<Field name="add" type="array of string" prefix="labels.">

<Description>

Labels to apply.

</Description>

</Field>

<Field name="remove" type="array of string" prefix="labels.">

<Description>

Labels to take off.

</Description>

</Field>

</FieldChildren>

</Field>

<Field name="contact_id" type="nullable string">

<Description>

Contact to link this message to, or null to unlink the current contact.

</Description>

</Field>

</Payload>

<Payload kind="response">

<Field name="id" type="string" required>

<Description>

Message ID. Received messages carry a `rem_` ID, sent messages an `em_` ID — the same IDs used by the received-message and sent-message logs.

</Description>

</Field>

<Field name="direction" type="string" required>

<Description>

Direction of the message — `inbound` for a received message, `outbound` for a sent one.

</Description>

<Description>

Possible values: `inbound`, `outbound`

</Description>

</Field>

<Field name="channel" type="string" required>

<Description>

Channel this message was carried on. Always `email`.

</Description>

</Field>

<Field name="thread_id" type="string" required>

<Description>

Conversation this message belongs to.

</Description>

</Field>

<Field name="from" type="string" required>

<Description>

Sender address.

</Description>

</Field>

<Field name="to" type="array of string" required>

<Description>

Recipient addresses on the To line.

</Description>

</Field>

<Field name="cc" type="array of string" required>

<Description>

Recipient addresses on the Cc line. Empty when the message had none.

</Description>

</Field>

<Field name="delivered_to" type="nullable string" required>

<Description>

Address the message was actually delivered to, when it differs from the mailbox address (for example mail routed in from another address). Null for sent messages and for mail addressed directly to the mailbox.

</Description>

</Field>

<Field name="subject" type="nullable string" required>

<Description>

Message subject. Null when the message had no subject.

</Description>

</Field>

<Field name="preview" type="nullable string" required>

<Description>

Short plain-text preview of the message body.

</Description>

</Field>

<Field name="extracted_text" type="nullable string">

<Description>

Plain-text content of the message with quoted history stripped — readable for the mailbox's full retention period, both directions. Always present when fetching a single message; on list endpoints it is included only when the request sets `include=extracted_text`. Null when no text could be extracted.

</Description>

</Field>

<Field name="labels" type="array of string" required>

<Description>

Labels on this message. System labels carry its state: a received message holds exactly one placement label — `inbox` for accepted mail, `archive` when its conversation was filed away, `spam` (failed sender authentication), or `blocked` (rejected by the mailbox's receive policy or rules) — plus `unread` until it is read. `trash` marks a message in the trash, either direction. Custom labels share the same list; a message carries at most 20.

</Description>

</Field>

<Field name="status" type="nullable string" required>

<Description>

Folded delivery status of a sent message: `accepted`, `sent` (provider handoff), `delivered` (all attempted recipients delivered), or `failed` (terminal failure). Null for received messages.

</Description>

</Field>

<Field name="recipients" type="nullable array" required>

<Description>

Terminal per-recipient delivery outcomes of a sent message, folded in as they become known — part of the message's durable memory. Null for received messages and before any recipient reaches a terminal state. Per-recipient event detail lives on the sent-message log (`source`) for 30 days.

</Description>

</Field>

<Field name="authentication" type="nullable string" required>

<Description>

Whether the sender of a received message was authenticated. `pass` means the sender's identity was verified; `fail` means it was checked and did not verify; `unknown` means no verdict could be determined and the sender should not be treated as verified. Null for sent messages. Part of the message's durable memory — readable for the mailbox's full retention period, so the verdict survives after the 30-day inbound log has expired.

</Description>

<Description>

Possible values: `pass`, `fail`, `unknown`, `null`

</Description>

</Field>

<Field name="spf_pass" type="nullable boolean" required>

<Description>

Whether SPF passed for the sender of a received message. Null for sent messages and when no verdict is available. Durable for the mailbox's retention period.

</Description>

</Field>

<Field name="dkim_pass" type="nullable boolean" required>

<Description>

Whether DKIM passed for the sender of a received message. Null for sent messages and when no verdict is available. Durable for the mailbox's retention period.

</Description>

</Field>

<Field name="dmarc_pass" type="nullable boolean" required>

<Description>

Whether DMARC passed for the sender of a received message. Null for sent messages and when no verdict is available. Durable for the mailbox's retention period.

</Description>

</Field>

<Field name="purge_at" type="string" required>

<Description>

When the message will be permanently deleted: the end of the mailbox's retention period, pulled nearer (at most 30 days out) while the message is in the trash. Restore a trashed message before then with `PATCH {"labels": {"remove": ["trash"]}}`.

</Description>

</Field>

<Field name="attachment_count" type="integer" required>

<Description>

Number of attachments on the message.

</Description>

</Field>

<Field name="attachment_manifest" type="array of object" required>

<Description>

Attachment metadata (filename, content type, size). Remains readable for the mailbox's retention period even after the attachment bytes themselves have expired.

</Description>

<FieldChildren kind="response">

<Field name="id" type="string" prefix="attachment_manifest." required>

<Description>

Attachment ID, used to download the attachment bytes.

</Description>

</Field>

<Field name="filename" type="nullable string" prefix="attachment_manifest." required>

<Description>

Original filename, or null when the attachment had none.

</Description>

</Field>

<Field name="content_type" type="nullable string" prefix="attachment_manifest." required>

<Description>

MIME content type, or null when it could not be determined.

</Description>

</Field>

<Field name="size" type="integer" prefix="attachment_manifest." required>

<Description>

Attachment size in bytes.

</Description>

</Field>

</FieldChildren>

</Field>

<Field name="reference_ids" type="array of string" required>

<Description>

RFC 5322 References header entries used to thread the conversation.

</Description>

</Field>

<Field name="contact_id" type="nullable string" required>

<Description>

Contact linked to this message, or null when none is linked.

</Description>

</Field>

<Field name="source" type="object" required>

<Description>

Link to the message's entry in the received-message or sent-message log, which carries delivery analytics such as per-recipient events. Log entries expire 30 days after the message occurred.

</Description>

<FieldChildren kind="response">

<Field name="resource" type="string" prefix="source." required>

<Description>

API path of the log entry for this message.

</Description>

</Field>

<Field name="available_until" type="string" prefix="source." required>

<Description>

When the log entry (and the message's original rendered source) expires.

</Description>

</Field>

</FieldChildren>

</Field>

<Field name="occurred_at" type="string" required>

<Description>

When the message was received or accepted for sending.

</Description>

</Field>

</Payload>