Email Archive
In this article
Overview
You can use this Snap to move email messages from one folder to another folder.
Only IMAP accounts are supported.
Snap Type
Email Archive Snap is a WRITE-type Snap that passes the data to the downstream Snap.
Prerequisites
This Snap requires a valid IMAP account to handle access to this endpoint.
Support for Ultra Pipelines
Works in Ultra Pipelines.
Limitations and Known Issues
None.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
| Any Document Snap | This Snap can have at the most one document input view. If you do not specify an input view, the Snap generates a downstream flow of one row. |
Output | Document |
| Any Document Snap | This Snap has exactly one document output view. |
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:
Learn more about Error handling in Pipelines. |
Snap Settings
Asterisk (*): Indicates a mandatory field.
Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
Expression icon (): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon (): Indicates that you can add fields in the fieldset.
Remove icon (): Indicates that you can remove fields from the fieldset.
Field Name | Field Type | Description |
---|---|---|
Label*
Default Value: Email Archive | String | 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.
|
Source folder*
Default Value: None | String/Expression | Specify the name of email folder from which the messages are to be moved. The values displayed in this field are based on the folders available in the email client. Ensure that you specify the folder name as it appears on the email client, because folder names might be case-sensitive for some email providers, such as Yahoo. Otherwise, the Snap displays |
Target folder*
Default Value: None | String/Expression | Specify the name of email folder to which messages are to be moved. The values displayed in this field are based on the folders available in the email client. |
Unread only
Default Value: Deselected | Checkbox | Select this checkbox to move only the unread email messages. Deselecting this checkbox moves all the messages. |
Number of messages
Default Value: All | Integer | Specify the maximum number of messages to be moved. Any non-integer or negative value moves all messages. |
From
Default Value: None | String | Specify the name of the sender, based on which the messages are to be moved. This field filters the messages based on the sender name. |
Subject
Default Value: None | String | Specify the subject of the email, based on which the messages are to be moved. This field filters the messages based on the specified subject. |
Snap Execution
Default Value: | Dropdown list | Select one of the three modes in which the Snap executes. Available options are:
|
Examples
Archiving Email from the SMTP server
This example pipeline demonstrates how to archive an email residing in the SMTP server using the SMTP account.
Step 1: Configure the Email Sender Snap to send an email to the SMTP server. On validation, the Snap displays the output with the details of the email.
|
|
Step 2: Configure the Email Archive Snap as follows to archive the email with the Subject test email archive. On validation, the Snap displays the output of a confirmation message indicating that the email with the Subject test email archive is successfully archived.
|
|
Downloads
Snap Pack History
Related Content
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.