Email Sender

This topic provides an overview of the Email Sender component, and describes its configuration as well as supported connections.

Component introduction

Email Sender component allows you to send emails, enabling real-time notifications, alerts, or delivery of user-specific information. You can specify the email server to use, and customize email fields such as recipients (To, CC, BCC), subject, message body, and file attachments.

Supported email servers
  • Yeastar SMTP Server
  • Custom Email Server
    Note:

Component configuration

  1. After adding Developer component to a call flow, click Developer component to proceed with the configuration.

  2. In the Component Type drop-down list, select Email Sender.

  3. In the Type of Email Server drop-down list, select an option.

  4. Customize email fields.
    Item Description
    From Sender name, which will appear as the "From" address for outgoing emails sent by the PBX.
    Note: You can modify the default value in PBX Settings > Preferences > Device Name.
    Subject Enter the subject of the email.
    Email Recipient

    Recipient email address, which will appear as the "To" address for outgoing emails sent by the PBX.

    You can enter specific email addresses, or click to configure an expression.

    Note:
    Expression example: 
    FX_TO_STRING($DatabaseAccess1.queryResult)

    In this example, the system retrieves the email address returned by the upstream Database Access component, which runs the SQL statement SELECT email_addr FROM user WHERE number='$Session.ani'; to query email address based on the caller's number, and then convert the email address to a string.
    CC

    Carbon Copy (CC) email address, which will appear as the "Cc" address for outgoing calls sent by the PBX.

    You can enter specific email addresses, or click to configure an expression.

    Note:
    BCC

    Blind Carbon Copy (BCC) email address, which will appear as the "Bcc" address for outgoing calls sent by the PBX.

    You can enter specific email addresses, or click to configure an expression.

    Note:
    Content Enter the body content of the email.
    Note: You can add system-related information using template variables.
    Attachments
    Click Add to add attachments. You can enter a file path or configure an expression, which must be an absolute path pointing to a file stored in the PBX's local storage.
    • Example of file path: /ysdisk/syslog/pbxlog.log
    • Example of expression: /ysdisk/email/'FX_CONCATENATE("yeastar","6602")'
    Note:
    Do not send email if the attachment file does not exist

    If selected, the system will NOT send email if any attachment file is missing.
  5. At the bottom-right corner, click Confirm.

Component connections

Email Sender component can be connected to one component, which can be any of the components listed below.

Component Description
Prompt

Prompt component allows you to play audio prompt(s) or a text-to-speech message to callers.

For more information, see Prompt.
Business Hours

Business Hours component allows you to route calls to different destinations based on the time of day.

For more information, see Business Hours.
Menu Menu component allows you to present callers with a set of menu options, and route calls based on the DTMF digit they press.

For more information, see Menu.
User Input

User Input component allows you to collect DTMF digits from callers, typically used with Condition component to evaluate user input and route calls.

For more information, see User Input.
Language

Language component allows you to change the system prompt language for subsequent components in a call flow.

For more information, see Language.
Record Record component allows you to start recording a call upon the caller being connected to another participant, and optionally configure prompts to inform call participants at the start and during the recording. Alternatively, you can use the component to disable call recording for calls that are supposed to be recorded.

For more information, see Record.
Dial by Number

Dial by Number component allows callers to directly dial a number to reach the destination.

For more information, see Dial by Number.
Dial by Name

Dial by Name component is one of the end components to terminate caller's connection to the current call flow. It allows callers to reach extension user by entering the first three letters of the user's name.

For more information, see Dial by Name.
Transfer

Transfer component is one of the end components to terminate caller's connection to the current call flow. It allows you to transfer callers to a designated destination, and optionally configure prompts to inform them of the transfer.

For more information, see Transfer.
Hang Up Call

Hang Up Call component is one of the end components to terminate caller's connection to the current call flow. When callers are routed to the component, the call will be disconnected.

For more information, see Hang Up Call.
Condition Condition component allows routing calls based on logical expressions.

For more information, see Condition.
Loop Loop component allows a group of components to be executed repeatedly, either for a specified number of times or until a condition is met.

For more information, see Loop.
Developer Developer component allows you to query and update data from PBX-native database or third-party database.
For more information, see the following topics: