Download an attachment
const url = 'https://mail.work.optidata.cloud/api/mail/mailboxes/78/messages/4186/parts/2/content?signature=example';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://mail.work.optidata.cloud/api/mail/mailboxes/78/messages/4186/parts/2/content?signature=example'Stream one attachment of a message. This endpoint takes no bearer token:
it is authorised by the signature in the query string, which the reader
endpoints already embed in each attachment’s url. Read that url and use
it as-is rather than assembling one yourself — the signature is bound to the
exact mailbox, message and part.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”Id of the mailbox. Every mailbox the caller may use is listed in their account.
Id of the message.
The MIME part number, from the attachment’s part field.
Query Parameters
Section titled “Query Parameters”The signature issued with the attachment’s url.
Responses
Section titled “ Responses ”The attachment content.
The signature is missing.
Generic error envelope used by policy, binding and framework failures.
object
Human-readable description of the failure.
Examples
{ "message": "Missing signature"}The signature is invalid, or does not match this mailbox, message and part.
Generic error envelope used by policy, binding and framework failures.
object
Human-readable description of the failure.
Examplegenerated
{ "message": "example"}Rate limit exceeded. Retry after the window resets.
Generic error envelope used by policy, binding and framework failures.
object
Human-readable description of the failure.
Examples
{ "message": "Too Many Attempts."}The mail platform did not answer as expected — a folder or message that
does not exist, or a transient failure. reference is the code to quote to
support and fault_code names the underlying condition. A 503 with the
same envelope means the platform is in maintenance; retry shortly.
Failure raised by the mail platform behind the API rather than by the request itself.
object
What went wrong, phrased for the end user.
Repeats the HTTP status code.
Suggested next step.
Support reference, e.g. MZ-502.
Names the underlying condition, e.g. mail.NO_SUCH_FOLDER.
Examples
Unknown folder
{ "error": "The mail server did not answer as expected, so this action could not be completed.", "status": 502, "help": "If the problem persists, contact support and inform the error code above.", "reference": "MZ-502", "fault_code": "mail.NO_SUCH_FOLDER"}Unknown message
{ "error": "The mail server did not answer as expected, so this action could not be completed.", "status": 502, "help": "If the problem persists, contact support and inform the error code above.", "reference": "MZ-502", "fault_code": "mail.NO_SUCH_MSG"}