Skip to Content

Train spam filter from multiple messages.

Submits spam or ham training feedback for a batch of messages in a single request. Same per-message idempotence as the single form: a message already taught this class is answered accepted but not sent again.

openemail.messages.learnMany(
  mailboxId: string,
  body: MessagesLearnManyBody,
  options?: CallOptions,
): ApiPromise<BatchLearnResult>

It calls POST /mailboxes/{mailboxId}/messages/learn: Train spam filter from multiple messages in the API reference.

Example

const batchLearnResult = await openemail.messages.learnMany(mailboxId, { ids: ['…'], class: 'spam' })

Arguments

ArgumentTypeDescription
mailboxIdstringMailbox ULID identifier. The path's {mailboxId}.
bodyMessagesLearnManyBodyThe 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, BatchLearnResult. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
400validation_failed
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404Mailbox not found or not accessible to this principal
413too_large: JSON request body exceeds 1 MiB or 500,000 values (object keys included), checked before parsing
503learning_unavailable — spam filter service is not configured. Or 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

MessagesLearnManyBody

/** The body of `messages.learnMany`. */
type MessagesLearnManyBody = {
  /** Feedback classification ('spam' for junk, 'ham' for legitimate) */
  class: ('spam' | 'ham')
  /** Array of message IDs to train on */
  ids: string[]
}

It names these types of the API, each on a page of its own: BatchLearnResult.