labels.updateMessages
Update flags, labels and keywords for every message in a folder.
Applies one patch to a UID RANGE of this label — the write twin of GET /labels/{label}/messages, and the way to act on a whole folder without naming its messages. PATCH /messages takes at most 200 ids, so "archive everything in this folder" means downloading every id and sending hundreds of calls, racing every arrival in between. Here the selection is a RULE the store resolves inside the same turn that writes it.
THE CEILING IS THE POINT. uidMax is resolved once and fixes the working set: a label's UIDs only increase and are never reused within a uidValidity, so mail that arrives — or that a rule files here — while the call runs takes a UID above the ceiling and is never touched. A client that showed a user "all 5,420 messages" can therefore act on the 5,420 they were looking at. Read uidNext from GET /labels and send uidMax = uidNext - 1 with that response's uidValidity beside it.
IT MAY ANSWER A CURSOR. The call spends a bounded budget and then stops, because the store is single-threaded and a mailbox has no size limit. nextAfter non-null means call again with after set to it, the same uidMax and the same patch, until it is null; remaining says how many memberships are left. Ordinary folders finish in one call. Every chunk has committed, so stopping early leaves the store consistent and the gesture partial — which is what remaining is there to make visible. Repeating a call is harmless.
Conversations do not enter into it: the patch reaches the messages FILED UNDER this label, which is what threadLabelOnly means on PATCH /messages. Removing a message's last label expunges it to the Recently-deleted tier, restorable until purge, exactly as it does by id.
openemail.labels.updateMessages(
mailboxId: string,
label: string,
body?: LabelsUpdateMessagesBody,
options?: CallOptions,
): ApiPromise<LabelMessagesUpdateResult>It calls PATCH /mailboxes/{mailboxId}/labels/{label}/messages: Update flags, labels and keywords for every message in a folder in the API reference.
Example
const labelMessagesUpdateResult = await openemail.labels.updateMessages(mailboxId, label, {})Arguments
| Argument | Type | Description |
|---|---|---|
mailboxId | string | Mailbox ULID identifier. The path's {mailboxId}. |
label | string | Label or folder name (e.g. INBOX, Archive, custom). The path's {label}. |
body | LabelsUpdateMessagesBody | Optional. The request's body. |
Options
It takes no options of its own. Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).
Answer
Awaited, it is the API's JSON, LabelMessagesUpdateResult. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.
Errors
| Status | What it means |
|---|---|
400 | validation_failed, patch_required (no change named), uidmax_required (after without uidMax), unknown_label (a name in the patch), or invalid_keyword |
401 | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge |
404 | Mailbox or label not found, or outside this principal's folder grant |
409 | uid_validity_mismatch — the label's UIDVALIDITY is not the one given |
413 | too_large: JSON request body exceeds 1 MiB or 500,000 values (object keys included), checked before parsing |
503 | temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description) |
A failed call rejects with a RequestError: its status, and its code, the API's error. Decide on the code: one status covers several.
Types
LabelsUpdateMessagesBody
/** The body of `labels.updateMessages`. */
type LabelsUpdateMessagesBody = {
/** Continuation cursor: resume above this UID. Pass the previous call's `nextAfter`. */
after?: number
/** Flags to remove */
flagsClear?: ('seen' | 'answered' | 'flagged' | 'draft' | 'deleted')[]
/** Flags to set */
flagsSet?: ('seen' | 'answered' | 'flagged' | 'draft' | 'deleted')[]
/** Narrow the selection to messages with ALL of these flags set */
hasFlags?: ('seen' | 'answered' | 'flagged' | 'draft' | 'deleted')[]
/** Custom keywords to remove */
keywordsClear?: string[]
/** Exact replacement list of custom keywords */
keywordsExact?: string[]
/** Custom keywords to add */
keywordsSet?: string[]
/** Labels to add */
labelsAdd?: string[]
/** Exact replacement list of labels */
labelsExact?: string[]
/** Labels to remove */
labelsRemove?: string[]
/** Lower the per-call update budget, for a client that wants finer progress than the server's own bound gives. Never raises it. */
limit?: number
/** Narrow the selection to messages with NONE of these set — `["seen"]` for the unread-only gesture a folder's unread badge implies */
notFlags?: ('seen' | 'answered' | 'flagged' | 'draft' | 'deleted')[]
/** What to do if this write would leave the message with no label. 'expunge' (the default) sends the message to Recently deleted. 'archive' keeps the message live by attaching the Archive system label (attaching Archive needs no right beyond the grant's 't' for a scoped viewer). If the write removes Archive itself and would leave no labels, Archive is kept without error. A SCOPED viewer whose write lands the message in Archive has moved it out of their own scope: the answer is still `updated`, and the hydrated message carries an EMPTY `labels` list rather than naming a label the grant never included. `labelsAdded` omits Archive for the same reason. */
orphans?: ('expunge' | 'archive')
/** Inclusive UID ceiling — the selection is every member with uid <= this. Omitted on a FIRST call, the label's current highest UID is used and echoed back. REQUIRED once `after` is given, so a continuation cannot move its own ceiling and sweep in mail that arrived mid-gesture. */
uidMax?: number
/** Precondition: refuse with 409 uid_validity_mismatch unless the label still carries this epoch. A bump means the UIDs this selection was taken over no longer name the same messages. */
uidValidity?: number
}It names these types of the API, each on a page of its own: LabelMessagesUpdateResult.