Email Trigger (SMTP) The Email Trigger (SMTP) tool triggers a task to run based on the contents of incoming or outgoing mail sent via an SMTP mail server. steps triggers a task to run when an email is sent or received containing specific parameter values. These parameter values can be taken from either in the Sent From, To Recipients, Cc Recipients, Subject, or Body Text sections of the email.

In addition, global variables Variables are created and used extensively throughout and can either have fixed values or values that are dynamically populated when a task is run. Global variables are available for all tasks in this BPA Platform installation. Once created, global variables can be used by any task. created for the task may be mapped to the message parameters so that their values may be used in other steps. For example, a variable called Message could be mapped to the Body Text variable and then included in an SMS text message created using the Send Text Message The Send Text Message tool is used to create and send data-driven, personalised text messages to customers, employees, prospects, suppliers, and so on. Sending can be automated to guarantee the timing of the text messages. step.

Prerequisites

Adding an Email Trigger (SMTP) Agent

The Email Trigger (SMTP) Agent works with the Email Trigger (SMTP) tool to process incoming SMTP messages. It can run on the same or separate computer to the server. It launches tasks when messages arrive that match filter rules previously configured within a Email Trigger (SMTP) step for a task.

It interfaces with Microsoft Virtual SMTP Server which is part of the Microsoft Internet Information Services. When a message is received by the Virtual SMTP Server, a copy of the message is passed to the Agent which in turn decides if there are any tasks to run.

You install the Email Trigger (SMTP) Agent on the same computer hosting the SMTP server you want to monitor.

1. Download the BPA Platform 2024 installation from our Partner Area.
2. Unzip the file to your preferred location on the BPA Platform computer.
3. Run self-setup.exe to launch the Installation Console.

   As part of the initial launch process, required installation files are extracted to C:\Windows\Installer. You must ensure this folder is not deleted as the Installation Console requires these files for any further installations, upgrades, or component un-installs.

   

   Click the image to view full size.

4. (Optional) By default, all files are installed to C:\Program Files (x86)\Codeless Platforms\BPA Platform. To change the destination folder, click Modify and select the relevant folder.

   If you are installing onto the same computer hosting the BPA Platform server, you cannot change the default folder paths so this can be skipped.

5. (Optional) By default, the Installation Console uses C:\iwtemp as a temporary folder during installation. To change the temporary folder, click Modify and select the relevant folder.

   If you are installing onto the same computer hosting the BPA Platform server, you cannot change the default folder paths so this can be skipped.

6. Click Install for the Email Trigger (SMTP) Agent feature.
7. As part of the installation process, Internet Information Services (IIS) may require a restart if certain features are installed. If you don't want IIS to restart during this installation, click No to end the installation; else click Yes to continue.
8. If you are installing onto the same computer hosting the BPA Platform server, this step is skipped.

   Enter your BPA Platform product key and click Next.

   Note that the key is case-sensitive.

   If you do not have a product key, contact your account manager or business partner.

9. Click Yes to start the installation.

   Progress is displayed at the bottom of the console.

10. When complete, you can choose whether to immediately configure the Agent or do this at a later stage. It is recommended you configure this now as you cannot create tasks using the Email Trigger (SMTP) tool until then.

    Click Launch to start the Configurator You use the Configurator to install third-party software that may be required by available tools. Connection to required agents are also configured here. Note that you can only launch the Configurator if logged into the machine with Administrator rights..

11. If any of the Email Trigger (SMTP) Agent prerequisites are not met, the Configurator opens to Event Agents > Email Trigger (SMTP) Agent > Prerequisites so these can be resolved first.
    1. The Configurator checks for software which the Email Trigger (SMTP) Agent requires. If any are missing or not configured properly, a is displayed. Click Install or Modify as appropriate to resolve the problem.
    2. Click Next to move to the Event Agents > Email Trigger (SMTP) Agent > Registration Settings node.
12. If all prerequisites are met, the Configurator opens to Event Agents > Email Trigger (SMTP) Agent > Registration Settings.

13. You must register the Email Trigger (SMTP) Agent with the BPA Platform server.

    By default, the Configurator assumes the local computer is also the BPA Platform server. Click Save to complete the configuration.

    If this is a remote agent, do the following:

    1. Enable Change Settings.
    2. Enter the Server hostname where the relevant BPA Platform client is installed
    3. If required, provide a new unique Agent Name. Although the computer name is appended to the Agent Name, it is useful from a task builder's point of view to have unique names.
    4. Click Save.
14. Enter the Administrator's password to confirm the Agent registration.

No further configuration is required for the Agent in the Configurator so you can close it down.

(Optional) Changing How Emails are Checked and Stored

Before being used in a task step, you can change how the Email Trigger (SMTP) tool checks and stores the email for the trigger properties:

►

All messages received by the SMTP Virtual Server are sent to the Email Trigger (SMTP) Agent for processing before being sent to the intended recipient (Direct Delivery Mode, default behaviour). To the user, this appears to be a normal, direct delivery service.

►

All messages received by the SMTP Virtual Server are sent to the Email Trigger (SMTP) Agent for processing. You can then choose to forward the message to the intended recipient or abort the message. This is particularly useful where the recipient email address does not have an actual mailbox. (Mail Intercept Mode)

You set this in the Email Trigger (SMTP) Configuration interface. You open this interface from the resources tree — expand System > Tools > Event and double-click Email Trigger (SMTP) in the items list.

For more information, see Choosing the Email Delivery Mode.

Adding a Task Step

To add a new Email Trigger (SMTP) step to an existing task:

1. Open the relevant task (if creating a new task, see How to Create a Basic Task).
2. Either:

►

Click and drag the Email Trigger (SMTP) icon from the Task Browser to the task Design area.

–OR–

►

From the task's Design tab, right-click on empty space and select New > Event > Email Trigger (SMTP).

3. Fill out the General tab.
   How Do I Do This?

   The General tab is used to Name and describe (Description) this task step.

   Tip: If this task instance makes use of two or more Email Trigger (SMTP) steps, ensure the Name used is unique for each individual step.

4. Go to the Main tab and configure the email properties that trigger this task to run.
   How Do I Do This?

   You use the Main tab to configure the trigger that activates this task.

   

   Click the image to view full size.

   ►

   Use Agent — Select the relevant Email Trigger (SMTP) Agent which is handling the emails for this task. Alternatively, choose All Email Trigger (SMTP) Agents to trigger on emails from all monitored SMTP servers.

   ►

   Filters — Add those filters which trigger this task to run. If adding multiple filters, you can choose to trigger the task when:

   ■

   Any of the above filter criteria are matched in an email

   ■

   All of the above filter criteria are matched, that is, a received email must "tick all the boxes"

   Click Add to add a new filter.

   ►

   Mapping — Prior to creating the Email Trigger (SMTP) task step, task parameter variables should have been created to store extracted email data. These are displayed in the Mapping table for use in this task step.

   For more information, go to the main Main tab topic.

5. Go to the Options tab and select the relevant error handling options for this task step.

   How Do I Do This?

   The Options tab allows you to define how errors in this step are handled at task runtime.

   

   Click the image to view full size.

   The Message Abort Options pane is only available when Mail Intercept Mode is selected in the global configuration. When operating in this mode, you can choose to abort the original message:

   ►

   Never — The message is never aborted and is always delivered to the original recipient

   ►

   Always — The message is always aborted and is never delivered to the original recipient

   ►

   On Fail — If the filter conditions set in the Main tab are not met, then the message is delivered to the original recipient

   ►

   On Success — If the filter conditions are met, then the message is never delivered to the original recipient

   Irrespective of the chosen email delivery mode, you can choose to send an email notification to nominated persons on receipt of an error (enable Send Error Notification To). You can also choose to attach the email that caused the error if available (enable Attach Original Message to Error Notification).

   For more information, go to the main Options tab topic.

6. Click  to save the task step.