Email.composer in ui builder

Mabubi
Tera Contributor

I need some idea how to configure email.composer component in ui builder .my requirement is when the user click send email button,all the fields which are required to send email should display (like compose email in Gmail like to,cc,sub,email body ).it should prompt the user to enter the details on the email form.pls provide me some idea how to proceed with this

2 REPLIES 2

Community Alums
Not applicable

Hi @Mabubi ,

The Email Composer component enables requestors and fulfillers to use email to communicate. The component is associated with a record to include conversations as part of the record.

This task assumes you have placed the component on the page and are ready to configure the properties and events. For instructions on accessing and using features in UI Builder, see Customize UI pages using components .
Note: This document describes the latest component functionality. Go to the store to make sure you have the latest version of the component.

Role required: admin or ui_builder_admin

  1. Define a label for your Email Composer that differentiates it from other components in the content tree.

    A label makes finding the component easier in a large list of components. For instructions on using the content tree, see Manage UI pages and page variants . For instructions on using the content tree, see Manage UI pages and page variants .

     
     
    2. Select the Email Composer component, using one of these methods:
    • Click anywhere within the component.
    • Select the Email Composer label you created for your component in the content tree.

    The property fields appear in the Config tab in the setup panel on the right.

     

    Properties

    Configure the tables and properties for your Email Composer component.

    To configure the properties, enter either static or dynamic input. Enter dynamic input by selecting the input type.
    Label [property] Description
    Sys ID

    [sysID]

    Sys ID for this record
    Target table

    [targetTable]

    Name of target table for this record
    Target record

    [targetRecord]

    Target record Sys ID for the record
    Reply type

    [replyType]

    Type of response action to be performed
    Reply ID

    [replyId]

    Sys ID of sys_email record to respond to
    Is compact

    [isCompact]

    Type of email composer to load, either the full composer or the mini composer (compact). If this value is true, the mini composer is loaded.

    Default: false

    Show email details

    [showEmailDetails]

    Flag to toggle between email composer details view
    Now resizable pane's default divider position

    [sidebarDefaultDividerPosition]

    Number between 0 and 100 that sets the default location of the sidebar divider. To place the divider all the way to the left, enter 0. To place the divider all the way to the right, enter 100. To place the divider exactly in the middle of the panes, enter 50.
    Now resizable pane is fixed

    [sidebarDisabled]

    Prevents the user from resizing the sidebar panes by moving the divider

    Default: false

    Now resizable pane's minimum width of right pane

    [sidebarRightPaneConstraints]

    Sets the minimum width of the right pane of the sidebar. You can set this value as a range of 0 to 100 and/or as a number of pixels. Enter a JSON string in the format {minRatio:number, minPixels:number}.
    Now resizable pane's sidebar ratio user preference

    [sidebarRatioPreference]

    Sets the user preference for the ratio of sidebar inside the right pane of the resizable panes. When set, this ratio is used every time that user access the email composer.

    Events

    Select event handlers to configure the actions (events) provided with the Email Composer component.

    The Events tab shows the events used by the Email Composer component. To view the available events, select + Add event mapping. Select the event in the list to add one or more event handlers.

    Event handlers

    Event handlers work with data resources to link the Email Composer actions to the data you want to display to your users. Select the event in the list to add one or more event handlers.

    For instructions on adding event handlers to an event, see Configure an event handler.

    Event descriptions

    Event Description
    Email Initialised

    DRAFT_INITIALISED

    An email record is initialized
    Payload:
    • table: Table name
    • sys_id: Sys ID of the record
    • subject: Subject of the email
    Email draft modified

    DRAFT_MODIFIED

    User modifies an email draft
    Payload:
    • table: Table name
    • sys_id: Sys ID of the record
    Email saved

    DRAFT_SAVE_SUCCEEDED

    User selects the Save button
    Payload:
    • table: Table name
    • sys_id: Sys ID of the record
    Email sent

    DRAFT_SEND_SUCCEEDED

    User selects the Send button
    Payload:
    • table: Table name
    • sys_id: Sys ID of the record
    Email record status changed

    RECORD_STATUS_CHANGED

    Status of an email record changes
    Payload:
    • table: Table name
    • sys_id: Sys ID of the record
    • status: Record status (Default: inserted)
    Email tab header update

    FORM_UPDATE_HEADER

    Updates the value of the email tab header
    Payload:
    • table: Table name
    • sys_id: Sys ID of the record
    • recordDisplayValue: Tab header displa value
    Email tab update

    UPDATE_ONE_TAB

    Closes out the workspace email tab
    • type: Type of action (Default: UPDATE_ONE_TAB_CLOSE)
    • tab_id: Workspace tab ID of the record
    Resizable pane size changed

    RESIZABLE_PANES_SIZE_CHANGED

    Sets the sidebar ratio when the user changes the pane size
    • sidebarRatio: Ratio of the sidebar panes
    • sidebarRatioPreference: User's preference for the ratio of the sidebar panes

Thanks Sandeep for ur information.can you pls share scenario based information how to use it for specific record.