messages.unjunk
Take messages out of Junk, back to where they were filed.
Removes the Junk label from a batch of messages — the "Not spam" verb, and POST /messages/untrash's counterpart for the other state label. Where each one lands is its restoresTo: whatever it carries besides Junk if anything, otherwise the filing recorded when a label write left it carrying only Junk, otherwise Inbox. An origin label that has since been deleted is matched by name if a label of that name exists again. Reports as an update on /changes (the rows were never hidden). This does NOT train the spam filter; pair it with POST /messages/learn as before. threadIds takes a whole conversation out: it expands, server-side and in the same transaction, to the members that are IN Junk. A conversation with nothing junked expands to nothing and the call is a no-op.
openemail.messages.unjunk(
mailboxId: string,
body?: MessagesUnjunkBody,
options?: CallOptions,
): ApiPromise<BatchUnjunkResult>It calls POST /mailboxes/{mailboxId}/messages/unjunk: Take messages out of Junk, back to where they were filed in the API reference.
Example
const batchUnjunkResult = await openemail.messages.unjunk(mailboxId, {})Arguments
| Argument | Type | Description |
|---|---|---|
mailboxId | string | Mailbox ULID identifier. The path's {mailboxId}. |
body | MessagesUnjunkBody | 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, BatchUnjunkResult. 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, target_required (neither ids nor threadIds given), or thread_too_large |
401 | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge |
404 | Mailbox not found or not accessible to this principal |
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
MessagesUnjunkBody
/** The body of `messages.unjunk`. */
type MessagesUnjunkBody = {
/** Array of message IDs to take out of Junk */
ids?: string[]
/** Conversation IDs whose JUNKED members to take out of Junk, expanded server-side. Refused with thread_too_large past 1000 expanded messages. */
threadIds?: string[]
}It names these types of the API, each on a page of its own: BatchUnjunkResult.