Skip to Content

Release a quarantined message

Delivers a quarantined message into the thread it would have joined and publishes one `mailbox.message.released` event.

POST
/v1/mailboxes/{id}/messages/{messageId}/release

Delivers a quarantined message into the thread it would have joined and publishes one mailbox.message.released event. Releasing it again returns the same result and publishes nothing. Only a person can release; API keys never hold quarantine.release. Isolated (malware) messages and discarded messages cannot be released: 409.

Authorization

apiKey
headerx-api-key<token>

Path Parameters

id*string
Match^mbx_[0-9a-hjkmnp-tv-z]{16,24}$
messageId*string
Match^msg_[0-9a-hjkmnp-tv-z]{16,24}$

Response Body

MailboxQuarantinedMessage

application/json
  1. response
id*MessageId
Match^msg_[0-9a-hjkmnp-tv-z]{16,24}$
disposition*string
Value in"quarantined""isolated"
reason*string
Value in"spam""dmarc""virus""virus_unscanned""phishing""fraud""prompt_injection"
source*string
Value in"receipt""classifier"
from*
subject*string|null
receivedAt*string
heldAt*string
releasedAt*string|null
threadId*|null
discardedAt*string|null
Example Request
import { createClient } from "samva";

const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });

const result = await samva.mailboxes.releaseMessage({
  "id": "example",
  "messageId": "example"
});
Example Response
{
  "id": "string",
  "disposition": "quarantined",
  "reason": "spam",
  "source": "receipt",
  "from": {
    "address": "string",
    "name": "string"
  },
  "subject": "string",
  "receivedAt": "string",
  "heldAt": "string",
  "releasedAt": "string",
  "threadId": "string",
  "discardedAt": "string"
}

Related documentation