Download EML Messages

The Download EML Messages task downloads one EML file from the Connect File Store. Saving EML messages in the File Store is an option in the Render Email Content task. EML files can be stored in an ERP/ECM system for archiving purposes.

Use the Metadata Sequencer plugin, followed by the Download EML Messages plugin and the Send to Folder plugin, to download multiple EML files and save them to disk.

As an alternative to the Download EML Messages task you could use the File Store - Download File task to download an EML file from the File Store. In that case you need the folder ID and EML file name found in the output of the Render Email Content task. This information can be retrieved from the Metadata using the following data selection methods:
GetMeta(_vger_prop_folder[0], 10, Job.Group[0].Document[0])
GetMeta(_vger_prop_eml[0], 10, Job.Group[0].Document[0]).

The Mailjet and SendGrid plugins offer the possibility to add extra attachments to a rendered email message via Workflow. Note that any such attachments will not be part of the EML file produced by the Render Email Content task.

Note: With OL Connect Workflow version 2020.1, using the Download EML Messages task requires the version 2020.1 Mailjet and SendGrid plugins . They are available for download on the Resource Center (https://olresourcecenter.uplandsoftware.com).

Tip: Double-click an .eml to open it in your email client.

Input

This task must receive either Metadata or JSON Job Data containing information regarding a pre-rendered email message that has been saved in EML format in the File Store.

Storing EML messages in the File Store is an option in Render Email Content task. That task outputs information about the email messages that it pre-rendered either in the current Metadata or in the form of a JSON structure.

The Download EML Messages task expects UTF-8 encoded JSON job data files.

Note: Make sure that other components in the Workflow configuration working on the job data handle UTF-8 encoded files correctly.

Processing

The plugin communicates with the Connect Server to retrieve the EML file that was stored in the Connect File Store by the Render Email Content.

Output

The task outputs the EML file as the Job File. The Metadata are unchanged.

Properties

General Tab

  • Data Source (see Input):

    • Metadata: Metadata containing information about an email message. The Render Email Content task can output information about the email message(s) that it pre-rendered in the current Metadata. Use the Metadata Sequencer plugin to loop over the items in the Metadata and feed them to the Download EML Messages plugin.

    • JSON: A JSON object representing an email message. For an example of such an object, see the Render Email Content task. That task can output a JSON object (or an array of JSON objects) containing information about email messages.

Note: Information about the Connect Server (host, user name etc.) is taken from the Workflow Preferences (see OL Connect preferences).

Advanced Properties

To get access to the following properties tabs, right-click the plugin in the process and select Advanced Properties.

On Error Tab

For a description of the options on the On Error tab see Using the On Error tab.

Miscellaneous Tab

The Miscellaneous tab is common to all tasks.

It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button and are displayed in The Task Comments Pane.

Check the option Use as step description to display the text next to the icon of the plugin in the Process area.

The tab also provides an option to highlight the task in The Process area with the default color, set in the Preferences (see Colors), or the color selected or defined under Highlight color on this tab.
To revert the selected highlight color to the default color, open this tab, turn the Highlight option off and close the dialog with the OK button; then turn highlighting back on.
Highlighting can also be turned on and off via the task's contextual menu and with the Highlight button on the View ribbon.