Input 

Document

• Min: 0

• Max: 1

Document

This Snap has at the most one document input view.

By default, the input view is not enabled; however, you can specify at the most one input.

Output

Document

• Min: 1

• Max: 1

Document

This Snap has exactly one output view and produces documents in the view. Each Document contains a Map data which represents one email message. The keys in the document are "from", "to", "cc", "subject", "dateSent", "emailType", "textBody", "htmlBody" and "attachments". The value of "from", "to" and "cc" keys is a list of strings. The value of "subject" and "dateSent" keys is a string.The value of "emailType" key is "text/plain" or "text/html" or "multipart/*". The value of "attachments" key is a list of Map data. Each Map data corresponds to an attached file. The keys of the Map data are "contentType", "filename" and "attachment". The value of the "attachment" key is a binary data read from the attached file. If the email message received has a nested multipart of content, all plain text bodies are appended to the value of the "textBody" key, and all HTML contents to the value of the "htmlBody" key. The following is an example of an Output Document:

{ from: "sender@example.com", to: "Snap@example.com; youto@example.com", cc: "meto@example.com", subject: "testing Email Sender Snap", emailType: "text/plain", textBody: "This is a sample email body.", htmlBody: "", dateSent: "Thu Mar 06 09:20:06 PST 2014", attachments: [ { contentType: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet; name="bbskus.xlsx"", filename: "sldb:///Snaplogic/projects/attachments/bbskus.xlsx", status: "overwritten" } ] }

Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

• Stop Pipeline Execution: Stops the current pipeline execution when the Snap encounters an error.

• Discard Error Data and Continue: Ignores the error, discards that record, and continues with the rest of the records.

• Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Label*

Default Value: Email Reader
Example: Email Reader

String

None

Specify 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.

Mail folder*

Default Value: Inbox
Example: Inbox

String/Expression

None

Specify the name of email folder where the Snap reads messages from.

Unread only

Default Value: Selected
Example: Selected

Checkbox

None

Select this checkbox to inform Snap to read only the unread email messages. If you do not select this checkbox, the Snap reads all messages.

Number of messages

Default Value: All
Example: 100

Integer

None

Specify the maximum number of messages that the Snap has to read. Any non-integer or negative value leads to "All" messages being moved.

Older message first

Default Value: Deselected
Example: Selected

Checkbox

None

Select this checkbox to view the older messages first in the output view. If you do not select this checkbox, the latest messages display first in the output view.

Attachment folder

Default Value: Shared
Example: smb://<username>@<hostname>:<port>/<directory>

String/Expression

None

Specify the URL of the directory where attached files are stored. If this property is blank, all attached files are ignored.

The following are the most commonly-used target directory values:

• shared: The Snap writes attachment files to /<org>/shared/ 

• /<org>/projects/<project>: The Snap writes attachment files to the specified project.

• sftp://<username>@<hostname>:<port>/<directory>:The Snap writes attachment files to the specified directory.

• smb://<username>@<hostname>:<port>/<directory>: The Snap writes attachment files to the specified directory.

• smb://<domain>;<username>@<hostname>:<port>/<directory>: The Snap writes attachment files to the specified directory. if the SMB credential has a Domain field, there should be a semicolon used as a separator between <domain> and <username>.

• For SFTP and SMB paths, the password should be entered into the Attachment password property in the email account.

Examples:

• sldb:///snaplogic/projects/attachments

• $attachmentFolder

• sftp://mrtest@ftp.xyz.com/home/mrtest

• smb://mydomain;snapuser@54.111.223.111:444/snapuser/

File action

Default Value: OVERWRITE
Example: RENAME

Dropdown list

None

Select an action to be taken if a file with the same name as in the email attachments exists in the specified directory. The available options include:

• OVERWRITE

• RENAME

• IGNORE

• ERROR

If ERROR is selected, the Snap displays an error message and the pipeline execution is terminated when it encounters an already existing file.

Archive messages after reading

Default Value: Deselected
Example: Selected

None

Select this checkbox to move or archive the read messages. If you do not select this checkbox, the read messages are not moved or archived.

Target folder

Value: None
Example: Archived

String/Suggestion

Archive messages after reading

Specify the target location for the archived emails. You need to configure this property only if you select the Archive messages after reading field. This is a suggestible field and the suggestions are based on the folders available in the email account.  

Snap Execution

Default Value: Validate & Execute
Example: Execute only

Dropdown list

N/A

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.

The Email Reader Snap is configured as in the following image:

In order to read and store the files on a provided location, the Attachment password must be set on the Account Settings of the Snap, else will display an error.

The Email Reader Snap is configured the same way as in individual mailboxes, in the Mail folder property, the folders from the shared mailbox are suggested as seen in the screenshot below:

A sample preview of the output data showing one of the emails in the shared mailbox.

We have an email in a Gmail account inbox that contains both an inline image and an image as an attachment:

Configure the Email Reader Snap as shown below: