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

Submits spam or ham training feedback for a specific email message to tune the spam filter. Idempotent per message and class: if this message was already taught this class — by an earlier call, or by the user moving it into or out of Junk (which trains on its own after a short undo window) — the call answers 202 without sending it again, and it supersedes a move-triggered sample still waiting out that window. The opposite class is always sent.

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

Request Body

application/json
  1. body
class*string

Feedback classification ('spam' for junk, 'ham' for legitimate)

Value in"spam""ham"

Response Body

Feedback accepted and queued for spam filter training

application/json
  1. response
status*string
Example Request
curl -X POST 'https://api.open.email/api/v1/mailboxes/string/messages/string/learn' \
  -H 'Content-Type: application/json' \
  -d '{
  "class": "spam"
}'
Example Response
{
  "status": "string"
}