Email Sender

On this Page

Snap type:

Write 

Description:

This Snap provides the functionality to send email messages to an SMTP server in plain text as well as HTML format. It can also format an HTML table and fill the rows by using data from the input view.

If your pipeline results in no data being sent to this Snap, no email will be sent.

 

Prerequisites:

[None] 

Support and limitations:

Works in Ultra Pipelines if batching is disabled. 

Supports TLS version 1.2.

Account: 

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint and requires a valid SMTP account. It is possible to send emails anonymously if your SMTP server allows. In that case, you may leave the Email ID and Password fields empty. You may have to set the Secure connection to 'NONE' if your SMTP server requires. See Email Account for information on setting up this type of account.

 

Views:
Input

This Snap has at most one document input view. Each document may contain Map data with values for JavaScript expression in the properties and/or data for the HTML table rows.

If an input view is configured and the Snap is connected to incoming documents, emails will be sent for each document processed unless you are using HTML Table as the Email Type. If you want to just send an attachment to an email, do not add an input view. Instead, just place the Snap unconnected on the workspace.

Note that if the main portion of the pipeline fails, the Email Sender Snap in this case may succeed and send a message with incorrect data.

Output

This Snap has at most one document output view. Each document contains a Map data which represents one successfully-sent email message. The keys in the document are "from", "to", "cc", "subject", "emailType", "body" and "attachments". The values of "from", "to", "cc", "subject" and "body" are strings. The value of "emailType" is "text/plain" or "text/html". The value of "attachments" key is a Map data whose keys are URLs and values are file names of the attached files. The following is an example of an output document:

[{"to":"user@example.com","body":"","emailType":"text/html","subject":"Tweeters","from":"user@example.com","attachments":[{"url":"sldb:///result-20140128115802.json","filename":"result-20140128115802.json"}],"cc":null}] 

Error

This Snap has at most one document error view and produces zero or more documents in the view. Each Document contains a Map data which represents one unsuccessfully-sent email message. The format of the Map data is the same as in output.


 

Settings

Label

 

Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

To


 

Required. Email addresses of to-type recipients, its exact format including the address separator may be email-server dependent. It may contain JavaScript expression to be substituted with the data from the input view.

Example:

Snap@example.comyouto@example.com

_customer + " Defects and Stories" where the pipeline has a pipeline parameter of customer

Default value: [None]

Most mail systems use a comma as an address separator. If the Email Sender Snap is having issues with multiple users in the list, verify that you are using the correct address separator for your mail system.

 

CC


Email addresses of cc-type recipients, its exact format including the address separator may be email-server dependent. It may contain JavaScript expression to be substituted with the data from the input view.

Examplemeto@example.comsomeoneelse@example.com

Default value: [None]

Most mail systems use a comma as an address separator. If the Email Sender Snap is having issues with multiple users in the list, verify that you are using the correct address separator for your mail system.

 

Bcc


Email addresses of bcc-type (blind carbon copy) recipients, its exact format including the address separator may be email-server dependent. It may contain JavaScript expression to be substituted with the data from the input view.

Example: meto@example.com, someoneelse@example.com
Default value: [None]

Most mail systems use a comma as an address separator. If the Email Sender Snap is having issues with multiple users in the list, verify that you are using the correct address separator for your mail system.


From


The email address of the sender. If there are multiple senders then separate them with a comma. The exact format of the email address including the address separator is email-server dependent. The format may contain a JavaScript expression that must be substituted with the data from the input. Email systems like Microsoft Office 365 enforce having the From field populated. We highly recommend you to populate this field.

Default value: N/A

Example: meto@example.com, someoneelse@example.com

Most mail systems use a comma as an address separator. However, if you face any issues with multiple users in the list, verify that you are using the correct address separator for your mail system.


Subject


Subject of email message.
Example:  Using Email Sender Snap
Default value:  [None] 

Email type


Required. Email type of "Plain text" or "HTML text" or "HTML table". If the Email type property is "Plain text" or "HTML text", the Snap sends one email message per each Document. If the Email type property is "HTML table", each Document provides one row of information for the HTML table.

Example:  HTML table
Default value:  HTML text 

Template

Template of email message body. For the email type of "HTML text" and "HTML table", the Template body should be in HTML format. For "HTML table" type, the Snap expects to find <table> and </table> tags inside the Template body. One Document at the input view corresponds to one row of the HTML table. For each Document, the Snap gets a map data referenced by the Table-data path property and insert a row into the HTML table of the message body. The Table-data path property can also reference an array of map data. The Snap uses the key sets of the map data to compose the column headers of the table. The Snap processes the entire stream of Documents in a batch to generate the superset of keys. 

See Expression Language for items to use with the expression toggle (=), but set Email type to Plain Text.

Example: The following is an example for a "HTML table" type of the Template body. It uses Cascading Style Sheets (CSS) for the table style. Please note Gmail does not support CSS in rendering HTML table. You should use in-line style of the HTML table for proper rendering in Gmail. The Snap does not support the in-line style HTML table for individual cells in the table header and rows: 

Default value:  [None]

Attachments


URLs of files that you want to attach to your email. If the URL protocol is missing, or if a given path is relative, SnapLogic automatically modifies the URL to start with "sldb:///".

The Snap supports SLDB, SFTP, and SMB file protocols. The username should be included in the URL as in the example below and the password should be entered into the Attachment password property in the email account. The filename part of the URL can contain wildcards so that multiple files can be attached for each row of Attachments property.

It may also contain JavaScript expressions, which can be substituted with the data from the input view.

Using Files in SFTP and SMB

  • The Email Sender Snap first downloads SFTP or SMB files to a temporary location in the local disk before sending them as attachments. Therefore, you must ensure that there is sufficient free local disk space in the Snaplex. All temporary files are deleted once the Snap completes execution.
  • The character '@' is a reserved character and is used as a delimiter between the username and hostname in the URL. Do not use it as part of filenames or directory names.

Example:

  • sftp://qatest@sftp.example.com/home/qatest/update_*.xls
  • Snap/sales.xls
  • smb://mydomain;snapuser@54.159.200.139:445/snapuser/sample.csv
  • smb://snap@54.159.200.329:445/snap/sample.csv

Default value: [None]

Using files in SLDB

  • Attaching files from the same project: <file_name> or sldb:///<file_name>. For example, asset.json or sldb:///asset.json.
  • Attaching files from a shared project: shared/<file_name> or sldb:///shared/<file_name>. For example, shared/asset.json or sldb:///shared/asset.json.
  • Attaching files from a shared project, wherein the pipeline being developed is also a shared project: <file_name> or sldb:///<file_name>. For example, asset.json or sldb:///asset.json.

Table-data path

JSON path to the map data which corresponds to a row in the HTML table. If it references an array of map data, such as $.Customers[::1], the Snap will add each map data into the HTML table. If the object referenced by this property is not a map data nor an array of map data, the input document will be routed to the error view.

Example: $.table
Default value: [None]

When using just "$" in the Table-data path, the Snap creates an HTML table, wherein the Template Body has the HTML table tags (<table></table>). Thus, the table auto-fills with the incoming data.

The document structure needs to be flat. You can do this by using a Structure Snap before the Email Sender Snap, creating a new map of all the required fields, and then using "$" as table-data path.

 

Batch size


The Batch size property is used only for the "HTML table" Email type. The unit of the value is in the number of rows of the HTML table. If the number of Documents the Snap receives from the input view reaches the given Batch size, the Snap composes an email message with an HTML table and sends it to the server. Multiple emails are generate if needed to send out all Documents. The Snap sends the last message at the end of the pipeline execution if any number of the un-sent table rows remain. 
Example:  100
Default value: 100 

Pass through


Determines if input data should be passed through or not. If selected, input data will be mapped as a value to the 'original' key in the output document.

Default value: Not selected 

Retries

Number of retries when the Snap fails to send email. Initially the Snap waits two seconds before retry, and in every subsequent retry. the delay is doubled up to an hour.

Example:  0  (no retry)
Default value: 3

Snap Execution

Select one of the three modes in which the Snap executes. Available options are:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.
  • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.
  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Temporary Files

During execution, data processing on Snaplex nodes occurs principally in-memory as streaming and is unencrypted. When larger datasets are processed that exceeds the available compute memory, the Snap writes Pipeline data to local storage as unencrypted to optimize the performance. These temporary files are deleted when the Snap/Pipeline execution completes. You can configure the temporary data's location in the Global properties table of the Snaplex's node properties, which can also help avoid Pipeline errors due to the unavailability of space. For more information, see Temporary Folder in Configuration Options


This note applies to the case your account is a Gmail account, but it may also apply to other web-based email accounts. Gmail SMTP accounts may not work with the Email Sender Snap. Gmail processes an email hijack detection based on IP addresses and locations. If it sees the IP address that the IMAP/POP3 client app is running from is different than the usual locations, it suspects the account is being hijacked and sends error messages like:

  • +OK Gpop ready for requests from 23.23.38.68 n18mb191678450qav" or
  • "Cannot connect to the endpoint reason: [SYS/PERM] Your account is not enabled for POP access. Please visit your Gmail settings page and enable your account for POP access." or other variations.

You may find an email from Gmail in the inbox titled "Suspicious sign in prevented", which is caused by the execution of Email Reader Snap. You may be able to see more messages from Gmail in your Gmail account web page: Account > Security > Recent Activity > View activity.

As of writing this note, there seems to be no settings available in the Gmail account to disable this security feature. Please contact Gmail Support if your Gmail account must work in Email Reader Snap.

HTML Table Email Template Body

Examples

 Email attachment from an SFTP location

Email Attachment from an SFTP Location

In the below example, the Email Sender Snap mail with an attachment from the SFTP location.


Note that in order to read the file attachment from the SFTP location, the Attachment password must be set on the Account Settings of the Snap, else will display an error.

The successful execution of the pipeline displays the below output preview:

 Email attachment from an SLDB Location

Email Attachment from an SLDB Location

In the below pipeline, the Email Sender Snap reads and sends the mail with an attachment (Customer Information.csv) from an SLDB location.


  

See Also

https://community.snaplogic.com/t/loop-through-csv-file-before-sending-email/10671

https://community.snaplogic.com/t/how-we-can-send-specific-email-template-from-email-sender-snap/10684

Snap Pack History

 Click to view/expand
ReleaseSnap Pack VersionDateTypeUpdates

4.27

main12833

 

Stable

Upgraded with the latest SnapLogic Platform release.
4.26main11181 StableUpgraded with the latest SnapLogic Platform release.
4.25main9554
 
StableUpgraded with the latest SnapLogic Platform release.
4.24main8556
StableUpgraded with the latest SnapLogic Platform release.
4.23main7430 StableUpgraded with the latest SnapLogic Platform release.
4.22422patches6730 Latest

Fixes the connectivity issue for the Email Sender Snap by making it compatible with TLS version 1.2.

4.22main6403
 
StableUpgraded with the latest SnapLogic Platform release.
4.21snapsmrc542-StableUpgraded with the latest SnapLogic Platform release.
4.20 Patchemail8813-Latest

Fixes an issue with the Email Sender Snap that caused the Snap to fail while uploading attachments to SMB locations when the attachment password contained a forward slash "/".

4.20snapsmrc535-StableUpgraded with the latest SnapLogic Platform release.
4.19snaprsmrc528-Stable

Upgraded with the latest SnapLogic Platform release.

4.18snapsmrc523-StableUpgraded with the latest SnapLogic Platform release.
4.17 PatchALL7402-Latest

Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.

4.17snapsmrc515-Stable

Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.

4.16 Patch email6772-Latest

Fixed an issue with the Email Delete Snap wherein the Snap fails to delete emails with multiple input documents.

4.16 snapsmrc508-StableUpgraded with the latest SnapLogic Platform release.
4.15 Patchemail6267-Latest

Fixed an issue with handling null attachments in the Email Sender and Email Reader Snaps.

4.15snapsmrc500-StableUpgraded with the latest SnapLogic Platform release.
4.14 Patchemail5740-LatestFixed an issue with POP3 access in Email Reader, Archive, and Delete Snaps. IMAP specific methods are now not called during POP3 access.
4.14 Patchemail5662-Latest

Fixed the Email Reader/Sender Snaps that replace the "+" symbol in attachment files with a space in the output.

4.14 snapsmrc490-StableUpgraded with the latest SnapLogic Platform release.
4.13 Patchemail5368-Latest
  • Enhanced Email Reader Snap to perform read and archive functions. 
  • Fixed the Email Archive Snap that does not display sorting errors. 
  • Fixed the Email Reader Snap that slows down when renaming the downloaded attachments.
4.13snapsmrc486-StableUpgraded with the latest SnapLogic Platform release.
4.12 Patchemail4948-Latest

Fixed an issue with the Email Reader Snap, wherein the Snap gets corrupted when a file name and content contains Unicode characters.

4.12snapsmrc480-StableUpgraded with the latest SnapLogic Platform release.
4.11 Patchemail4481-Latest
  • Resolved an issue with Email Reader Snap:
    • The Snap now reads to fetch mails from a shared mail box.
    • The Snap can now read the file attachment that has a percent sign [%], or ó.  
  • Updated the Email Delete Snap code to display the default value as zero instead of blank in the UI.
4.11snapsmrc465-StableUpgraded with the latest SnapLogic Platform release.
4.10 Patchemail4025-Latest

Added Connection, Read, and Write timeout settings that support retries for SMTP, POP3, and IMAP email account types.

4.10 Patchemail3944-Latest

Resolved an issue with the Email Reader Snap to support the shared mailbox on an Office 365 server. Email Reader did not support Office 365 shared mailbox until we explicitly disabled plaintext authentication when we specify ssl authentication. The Office server falsely reports that it supports PLAIN authentication and the snap library is happy to try it but it always fails. This is a known issue with Office 365 / Outlook.

4.10snapsmrc414-Stable
  • Email Account Updated with Attachment password property (encrypted) to support the attachment function for the Email Sender and Reader Snaps.
  • Email Reader Snap updated with the Attachment folder property to store the attached files on a path.
  • Email Sender Snap extended support to SLDB, SFTP, and SMB file protocols for the attachments
4.9.10snapsmrc405-LatestUpgraded with the latest SnapLogic Platform release.
4.8.0 Patchemail2816-Latest

Addressed an issue with Email Sender Snap being unable to Handle Chinese characters.

4.8--StableUpgraded with the latest SnapLogic Platform release.
4.7.0 Patchemail2499-Latest

Added logic to process emails that have text files as attachments and download the files to the provided attachment location.

4.6.0snapsmrc362-Latest
  • Resolved an issue in Email Sender Snap that failed when attached a file that had spaces in the file name.

  • Enhanced error handling in Email Reader Snap to appropriately route connection errors to error view.

4.5.1email1564-Latest
  • BCC field added to the Email Sender Snap.

  • Retries added to the Email Sender Snap.

--August 7, 2015 (2015.25/4.2.1)-
  • Email Reader Snap now has an option to read older message first.

  • Resolved Null Pointer exception in Email Reader Snap when reading from Yahoo mailbox.

--June 27, 2015 (2015.22)-

Email Sender now supports the ability to pass through input documents.

--June 6, 2015 (2015.20)-

Email Reader: Resolved an error with concatenating file names in attachments

--Snap Updates, December 20, 2014-

NEW! Email Archive introduced in this release.

--November 2014 Launch Updates-

NEW! Email Delete Snap was introduced in this release.

--October 18, 2014-

Email Sender now allows JSONPath expressions

--Fall 2014 Launch Updates-

Email Sender: better handling of error messages to the error view.

--December 2013 Launch Updates-

Email Reader Snap and Email Sender Snap were updated to handle attachments.

--September 2013 Updates-

Email Sender & Email Reader introduced in this release. This pair of Snaps let you send and receive an email when you run a pipeline.