API Docs / Schemas / ReplyMailboxEmailRequest

ReplyMailboxEmailRequest

Request to reply to a mailbox message, extending the email service reply contract
with practice document attachments resolved server-side by code.

Properties

Name Type Description
htmlBody*string

HTML body of the reply

HTML body of the reply

plainTextBodystring

Plain text body (optional fallback)

Plain text body (optional fallback)

replyAllboolean

Whether to reply to all recipients (default: false = reply to sender only)

Whether to reply to all recipients (default: false = reply to sender only)

toRecipientsarray of EmailRecipientDto

Override To recipients. Null = use provider default (original sender for reply, all for reply-all).
Empty list = explicitly no To recipients.

Override To recipients. Null = use provider default (original sender for reply, all for reply-all).
Empty list = explicitly no To recipients.

ccRecipientsarray of EmailRecipientDto

Override CC recipients. Null = use provider default.
Empty list = explicitly no CC recipients (useful for removing CC on reply-all).

Override CC recipients. Null = use provider default.
Empty list = explicitly no CC recipients (useful for removing CC on reply-all).

bccRecipientsarray of EmailRecipientDto

BCC recipients. Null or empty = no BCC (providers never auto-populate BCC).

BCC recipients. Null or empty = no BCC (providers never auto-populate BCC).

attachmentsarray of EmailAttachmentDto

Attachments to include in the reply. Null or empty = no attachments.

Attachments to include in the reply. Null or empty = no attachments.

practiceDocumentCodesarray of string

Codes of practice documents (tenant document library) to attach. Resolved to file
content server-side, so the browser never round-trips the document bytes.

Codes of practice documents (tenant document library) to attach. Resolved to file
content server-side, so the browser never round-trips the document bytes.

scheduledAtstring

When set, the reply is not sent now: a scheduled send is created and dispatched at this
UTC instant. Must be in the future. Omit to send immediately.

When set, the reply is not sent now: a scheduled send is created and dispatched at this
UTC instant. Must be in the future. Omit to send immediately.

JSON Example

{
  "htmlBody": "string",
  "plainTextBody": "string",
  "replyAll": false,
  "toRecipients": [
    {
      "email": "...",
      "name": "..."
    }
  ],
  "ccRecipients": [
    {
      "email": "...",
      "name": "..."
    }
  ]
}

Used By Operations

Contained in Schemas