Type alias RegisterMailEditorComponentOptions

RegisterMailEditorComponentOptions: { name: string; schema: { type?: "AdaptiveCard"; version?: string; body: Record<string, any>[]; [key: string]: any } }

Type declaration

  • name: string

    Component name, component names cannot be dulpicated in the same app.

  • schema: { type?: "AdaptiveCard"; version?: string; body: Record<string, any>[]; [key: string]: any }

    The AdaptiveCards template schema to render the component ui. We can bind data in the template, the data will be passed by the component props. And the template language support many built-in functions, such as parse json, format date, etc. We support all adaptive card elements up to schema version 1.6, and some elements also support markdown. Please do not use actions or other functions that need to execute js in the schema, because js cannot be contained in the emails sent.

    We also support some custom elements, please see RenderInMailOptions for details.

    • [key: string]: any
    • Optional type?: "AdaptiveCard"

      default is AdaptiveCard

    • Optional version?: string

      range is ['1.0', '1.6'], default is '1.6'

    • body: Record<string, any>[]

Generated using TypeDoc