Skip to Content
POST
/api/v1/mailboxes/{mailboxId}/messages/{messageId}/restore

Restores one message from the Recently-deleted tier back to where it was filed (restoresTo), or Inbox when that is no longer resolvable. For a message on the Trash LABEL use POST /messages/untrash instead. Reports as created on /changes, since the row was hidden and is now back.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Two credential kinds share this scheme; GET /api/v1/auth/whoami answers which one you hold and what it reaches.

oek_… API key (minted by POST /api/v1/api-keys; shown once at mint). role: account reaches the full account surface: the directory (domains, routes, patterns, api-keys, accounts, address lists) plus every mailbox the account owns. role: system additionally reaches the operator surface, which is documented separately.

oemp_… mailbox app password (minted by POST /api/v1/identities/{identityId}/credentials). Reaches ONE mailbox: its messages, labels, threads, search, sync, send, filters and PIM collections. Directory routes refuse it with 403 insufficient_scope.

Refusal vocabulary: a missing, malformed, expired, or revoked credential answers 401 unauthorized with a WWW-Authenticate: Bearer challenge; a VALID credential outside its scope answers 403 (insufficient_scope for an app password on a directory route, system_credentials_required where only the operator may call). The public routes (health, branding, token-in-path capabilities) declare security: [].

Path Parameters

mailboxId*string

Mailbox ULID identifier

messageId*string

Message ULID identifier

Response Body

Restored message metadata

application/json
  1. response
message*

Restored message metadata

restored*boolean

True if message was restored from trash

Example Request
curl -X POST 'https://api.open.email/api/v1/mailboxes/string/messages/string/restore'
Example Response
{
  "message": {
    "auth": {
      "arc": "string",
      "dkim": "string",
      "dmarc": "string",
      "junk": true,
      "spf": "string"
    },
    "bcc": [
      {
        "email": "string",
        "name": "string"
      }
    ],
    "blobGen": "string",
    "blobHash": "string",
    "cc": [
      {
        "email": "string",
        "name": "string"
      }
    ],
    "deliveryMeta": {
      "property1": null,
      "property2": null
    },
    "deliveryState": "queued",
    "envelopeFrom": "string",
    "envelopeTo": "string",
    "flags": [
      "string"
    ],
    "from": [
      {
        "email": "string",
        "name": "string"
      }
    ],
    "hasAttachment": true,
    "id": "string",
    "inReplyTo": "string",
    "keywords": [
      "string"
    ],
    "labels": [
      {
        "deleted": true,
        "modseq": 0,
        "name": "string",
        "uid": 0,
        "uidValidity": 0
      }
    ],
    "messageIdHeader": "string",
    "modseq": 0,
    "receivedAt": 0,
    "referencesIds": [
      "string"
    ],
    "restoresTo": [
      "string"
    ],
    "sentAt": 0,
    "size": 0,
    "snippet": "string",
    "subject": "string",
    "threadId": "string",
    "to": [
      {
        "email": "string",
        "name": "string"
      }
    ],
    "uid": 0
  },
  "restored": true
}