Praecise Platform
Menu

Rivier/ Reference/ inbox

Inbox export mailbox

get/workspace/inbox/export

Take a mailbox's mail out as mbox, a zip of .eml files or a CSV (owner or manager). Marks the mailbox exported, which the release rules ask for. Customer-facing mail only; notes only in the CSV and only when asked.

Before you call

Credential
Authorization: Bearer $KEY
Scope
inbox:read
Sdk
inbox.export.mailbox
Cli
inbox export mailbox

Parameters

  • mailboxstringrequired
    In the query
  • formatstring
    In the query
  • includeNotesstring
    In the query
  • filesstring
    In the query

Responses

  • 200application/octet-stream
    Success

    string (binary)

  • 400application/json
    The request was malformed
    • errorstringrequired
    • messagestring
  • 401application/json
    No valid credential
    • errorstringrequired
    • messagestring
  • 403application/json
    The credential lacks the scope, origin or address
    • errorstringrequired
    • messagestring
  • 429application/json
    Over the key's rate limit; see Retry-After
    • errorstringrequired
    • messagestring

This page as Markdown