Type alias SetMailActiveEditorDataOptions

SetMailActiveEditorDataOptions: { to?: { email: string }[]; cc?: { email: string }[]; bcc?: { email: string }[]; subject?: string; body?: string; attachments?: { name: string; type: string; content: string }[]; headers?: { name: `X-Zoom-App-${string}`; value: string }[]; editorState?: any }

Type declaration

  • Optional to?: { email: string }[]

    recipients

  • Optional cc?: { email: string }[]

    cc recipients

  • Optional bcc?: { email: string }[]

    bcc recipients

  • Optional subject?: string

    email subject

  • Optional body?: string

    email body

  • Optional attachments?: { name: string; type: string; content: string }[]
    • name: file name
    • type: file MIME type
    • content: file base64 encoded content, doesn't contain the data URI prefix
  • Optional headers?: { name: `X-Zoom-App-${string}`; value: string }[]

    App custom headers, it can be used to store metadata bound with mail. If a header name starts with X-Zoom-App-Private-, the header will only be saved in the draft and will not be included when sending the email. Be sure to use your own unique prefix in the header name to avoid conflicts with other app headers.

    Since

    desktop client v6.4.5

  • Optional editorState?: any

    Any app local state associated with the editor instance, it will replace the previous editorState.

    Deprecated

    Since desktop client v6.4.5, will be removed later, not recommended to use.

Settings

Member Visibility

Theme

Generated using TypeDoc