sending

Forward a message

Forwards message_id, a ready received message or an accepted sent message in the sending inbox, to the recipients in to, cc and bcc. Recipients are used exactly as given, with the limits of send. An optional note goes above the forwarded message.

The forward carries a header block with the original From, Date, Subject, To and Cc (never Bcc), then the original text and HTML as they are, quoted history included: check them for anything the new recipients shouldn't see. The subject gets Fwd: unless it already starts with Fw: or Fwd:. A forward starts a new conversation.

The original attachments, embedded images included, are attached unless include_attachments is false, which leaves out every file, so images in the HTML may not display.

Outcomes are those of send, and retries those of reply.

post/v1/inboxes/{inbox_id}/forward

Request

  • Base URL: https://cherami.to
  • URL: https://cherami.to/v1/inboxes/{inbox_id}/forward
  • Auth: HTTP bearer

Path parameters

inbox_idstring required

Cherami resource ID returned by the API.

Request body

message_idstring required

ID of a ready received message or an accepted sent message in this inbox.

notestring

Optional plain-text introduction above the forwarded message.

include_attachmentsboolean

false leaves out every original file, embedded images included.

labelsLabel[]

Label names, case-sensitive; order and duplicates don't matter.

idempotency_keystring

Your unique value for this one operation. Save it with the exact request before sending; repeating that request with the same key within 24 hours returns what the first one did instead of acting again.

Response

A retry matched an earlier request: this is that request's result as it is now. Nothing new was created or sent.

limitedunknown required
outcome_persistedboolean required

false: this response is the only record of the outcome; keep it rather than resending.

replayedtrue required

true when a retry matched an earlier request: the result is that request's, and nothing new was created or sent.

idempotency_expires_atstring date-time required

When the key stops protecting retries.

Changes

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