pickups.delete
Delete a POP3 pickup source.
Deletes a POP3 pickup source configuration and stops its background polling schedule.
openemail.pickups.delete(
mailboxId: string,
pickupId: string,
options?: CallOptions,
): ApiPromise<DeletedResult>It calls DELETE /mailboxes/{mailboxId}/pickups/{pickupId}: Delete a POP3 pickup source in the API reference.
Example
const deletedResult = await openemail.pickups.delete(mailboxId, pickupId)Arguments
| Argument | Type | Description |
|---|---|---|
mailboxId | string | Mailbox ULID identifier. The path's {mailboxId}. |
pickupId | string | Pickup source identifier. The path's {pickupId}. |
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, DeletedResult. 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 | Not found or not accessible |
409 | conflict: destination configuration changed or a handoff is pending; retry |
503 | temporary_failure: the mailbox or account is in transition while its store is being adopted; retry after Retry-After |
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
It names these types of the API, each on a page of its own: DeletedResult.