Mailboxes

Add a mailbox forwarding destination

Send a confirmation email to a forwarding destination. Forwarding becomes active only after the recipient confirms. Active forwarding keeps a copy in the Shipmail mailbox and excludes messages classified as spam. Repeating this request for a pending destination sends a new confirmation link.

post/mailboxes/{id}/forwarding

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/mailboxes/{id}/forwarding
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://shipmail.to/api/auth/oauth2/authorize, token URL https://shipmail.to/api/auth/oauth2/token)

Headers

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Request body

destinationstring email required
senderstring email nullable

Optional exact From address. Omit or set null to forward every non-spam message.

recipientstring email nullable

Optional exact mailbox primary address or alias. Omit or set null to match every address. When both sender and recipient are set, a message must match both.

Response

Forwarding destination created, refreshed, or already active.

object'mailbox_forwarding' required
idstring required
mailbox_idstring required
destinationstring email required
senderstring email nullable required

Exact From address to forward, or null to forward every non-spam message.

recipientstring email nullable required

Exact mailbox primary address or alias that received the message, or null to match every address.

status'pending' | 'active' required
verification_sent_atstring date-time nullable required
verified_atstring date-time nullable required
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.