Mailboxes

Forward a message

Forwards an email to new recipients as a new conversation from the thread's endpoint, with the original quoted below the caller's text and its attachments attached ahead of any the caller adds. The combined attachments must fit the email attachment limits.

post/v1/mailboxes/{id}/messages/{messageId}/forward

Request

  • Base URL: https://api.samva.dev
  • URL: https://api.samva.dev/v1/mailboxes/{id}/messages/{messageId}/forward
  • Auth: API key in header x-api-key

Path parameters

idstring required
messageIdstring required

Headers

idempotency-keystring nullable

Optional key that makes a mailbox send idempotent for the calling key or member. Repeating the request with the same key and body returns the original action in its current state. Keep the key after a lost response. Reusing it with different content returns 409. Active actions retain their key; terminal receipts remain replayable for 24 hours.

Request body

tostring[] required
ccstring[] nullable
bccstring[] nullable
textstring nullable
htmlstring nullable

Response

MailboxSendReceipt

actionIdstring required
draftIdstring required
messageIdstring required
threadIdstring required
state'approvalRequired' | 'queued' | 'accepted' | 'completed' | 'notSent' | 'uncertain' required
acceptedAtstring nullable required
waitReason'rate' | 'daily-quota' | 'domain-health' | 'sending-paused' | 'upstream-unavailable' | 'retry' | 'campaign-paused' | 'domain-warming' | 'onboarding-review' | 'content-review' | 'screening-unavailable' nullable required
reviewExpectedAtstring nullable required
executeUntilstring nullable required
retryAtstring nullable required
retryEligibleboolean required
createdAtstring required
updatedAtstring required

Changes

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