Sign inGet Started

bird email threads messages forward

Usage

Code example
bird email threads messages forward <thread-id> <message-id> [flags]

Description

Forward a thread message

Forward a conversation message, with its original body and attachments, to new recipients from the mailbox's own address. Add a plain-text note and optional blind-copy recipients. It requires the original source, which is available for 30 days.

Build the request from flags, a JSON EmailThreadMessageForwardRequest body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Examples

Code example
# print the body shape (no credentials needed)
bird email threads messages forward --example

# the body it prints:
Code example
{
  "note": "Please review the attached request.",
  "to": ["delivered@messagebird.dev"]
}

Options

Request

NameDescription
--body-fileRead the JSON request body from this file; "-" reads stdin
--examplePrint a complete example request body, then exit
--dry-runPrint the resolved request without sending it, then exit
--idempotency-keyDeduplication key; a retry with the same key won't act twice

Options

NameDescription
--to <value>…Recipient addresses to forward the message to. (required; or in --body-file)
--cc <value>…Cc recipient addresses.
--bcc <value>…Blind-copy recipient addresses. Bcc recipients are not exposed in the conversation.
--notePlain-text note prepended to the original body. Escaped as text when the original has an HTML body.
--tags <key=value>Structured {name, value} labels for filtering and analytics on the sent-message log. Cap: 20 tags per send.
--metadataArbitrary JSON object stored on the send and echoed in webhook payloads. Cap: 2 KB serialized.
--categoryContent classification, which controls suppression policy: - marketing: Blocks on all suppression reasons. - transactional: Allows delivery through complaint and unsubscribe suppressions, for receipts, password resets, and similar operational mail. Possible values: marketing, transactional.
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird email threads messages attachmentDownload an attachment from a thread message
bird email threads messages attachmentsList a thread message's attachments
bird email threads messages bodyGet a thread message's original body
bird email threads messages getGet a message in a thread
bird email threads messages listList messages in a thread
bird email threads messages rawDownload a thread message's raw RFC 5322 content
bird email threads messages replyReply to a thread message

Continue with the documentation, guides and examples for this topic.