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

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 1

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

  • Min: 1

  • Max: 1

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:

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

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

Field Name

Field Type

Description

Label*

 

Default ValueEmail Archive
ExampleEmail 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
Example: Inbox

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 Error retrieving folder for given source or destination error.

Target folder*

 

Default Value: None
Example: Important

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.

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 Error retrieving folder for given source or destination error.

Unread only

 

Default Value: Deselected
Example: Selected

Checkbox

Select this checkbox to move only the unread email messages. Deselecting this checkbox moves all the messages.

Number of messages

 

Default Value: All
Example: 100

Integer

Specify the maximum number of messages to be moved. Any non-integer or negative value moves all messages.

From

 

Default Value: None
Example: JohnDoe

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
Example: Important Message

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
Example: Validate & Execute

Dropdown list

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.

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

  1. Download and import the Pipeline into SnapLogic.

  2. Configure Snap accounts as applicable.

  3. Provide Pipeline parameters as applicable.

  File Modified

File Example_Email Archive.slp

May 03, 2023 by Amritesh Singh

Snap Pack History