Mailboxes

Get a mailbox export

Read one customer mailbox export. Completed exports include a private download URL valid for at most five minutes and never beyond the seven-day export expiry.

get/mailboxes/{id}/exports/{export_id}

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/mailboxes/{id}/exports/{export_id}
  • 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.

Response

Mailbox export status.

object'mailbox_export' required
idstring required
mailbox_idstring required
status'pending' | 'processing' | 'completed' | 'failed' | 'expired' required
format'zip' required
format_versioninteger required
file_sizeinteger nullable required
message_countinteger nullable required
folder_countinteger nullable required
error_code'source_unavailable' | 'snapshot_changed' | 'export_failed' | 'null' nullable required
download_urlstring uri nullable required
download_url_expires_atstring date-time nullable required
expires_atstring date-time nullable required
created_atstring date-time required
started_atstring date-time nullable required
completed_atstring date-time nullable required

Changes

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