messages.untrash
Take messages out of Trash, back to where they were filed.
Removes the Trash label from a batch of messages. Where each one lands is its restoresTo: whatever it carries besides Trash if anything, otherwise the filing recorded when it was trashed, otherwise Inbox. Reports as an update on /changes (the rows were never hidden), unlike POST /messages/restore, which reports created. For a message on the Recently-deleted TIER use that endpoint instead; here such an id answers not_found. threadIds puts a whole conversation back: it expands, server-side and in the same transaction, to the members that are IN the Trash — the mirror of the expansion on POST /messages/patch, and the only set this verb can act on. A conversation with nothing trashed expands to nothing and the call is a no-op.
openemail.messages.untrash(
mailboxId: string,
body?: MessagesUntrashBody,
options?: CallOptions,
): ApiPromise<BatchUntrashResult>It calls POST /mailboxes/{mailboxId}/messages/untrash: Take messages out of Trash, back to where they were filed in the API reference.
Example
const batchUntrashResult = await openemail.messages.untrash(mailboxId, {})Arguments
| Argument | Type | Description |
|---|---|---|
mailboxId | string | Mailbox ULID identifier. The path's {mailboxId}. |
body | MessagesUntrashBody | 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, BatchUntrashResult. 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
MessagesUntrashBody
/** The body of `messages.untrash`. */
type MessagesUntrashBody = {
/** Array of message IDs to take out of Trash */
ids?: string[]
/** Conversation IDs whose TRASHED members to take out of Trash, 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: BatchUntrashResult.