scheduled.cancelAll
Cancel all scheduled sends for a mailbox.
Cancels all pending scheduled sends for this mailbox, optionally scoped to a specific creator credential.
openemail.scheduled.cancelAll(
mailboxId: string,
options?: ScheduledCancelAllOptions,
): ApiPromise<ScheduledCancelAllResult>It calls POST /mailboxes/{mailboxId}/scheduled/cancel: Cancel all scheduled sends for a mailbox in the API reference.
Example
const result = await openemail.scheduled.cancelAll(mailboxId)Arguments
| Argument | Type | Description |
|---|---|---|
mailboxId | string | Mailbox ULID identifier. The path's {mailboxId}. |
Options
The last argument, options, a ScheduledCancelAllOptions, takes:
| Option | Type | Sent as | Description |
|---|---|---|---|
actorId | string | query actorId | Filter cancellation to schedules created by this specific credential or API key ID |
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, ScheduledCancelAllResult. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.
Errors
| Status | What it means |
|---|---|
401 | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge |
404 | Mailbox not found or not accessible |
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
ScheduledCancelAllResult
/** What `scheduled.cancelAll` answers. */
type ScheduledCancelAllResult = {
/** Number of scheduled sends canceled */
canceled: number
}