...
...
...
...
| Note | ||
|---|---|---|
| ||
|
In this article
| Table of Contents | ||||
|---|---|---|---|---|
|
Overview
Use You can use this Snap to ..move an email to another folder.
...
Snap Type
Move Email is a Write-type Snap that moves an email to another email folder.
Prerequisites
- Valid client ID.
- A valid account with the required permissions.
...
Valid Exchange Online tenant.
Valid OAUth2 application in Azure Active Directory with all the required API permissions.
Support for Ultra Pipelines
Capture if Ultra Mode is supported. If the Snap requires certain configurations to support Ultra mention those as well.
Works in Ultra Pipelines.
...
See However, we recommend that you not use this Snap in an Ultra Pipeline. To know the list of Snaps that work in Ultra and the related caveats, see Snap Support for Ultra Pipelines.
Limitations
...
& Known Issues
None.
Snap
...
Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
Input |
Document
BinaryDocument |
|
|
|
Requires Existing User/Shared Email Id and Destination Folder name to move the email. | |
Output | Document |
Binary
Binary or Document
|
| Desired email moved to opted mailbox. | ||
Error | Error handling is a generic way to handle errors without losing data or failing the Snap execution. | |||
The EDI transaction ID and order confirmation.
Snap Settings
...
| title | Documenting Fields Based On Data Type/UI Element |
|---|
**Delete Before Publishing**
Choose from the following sentences to document specific field types.
...
You can handle the errors that the Snap might encounter when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:
Learn more about Error handling in Pipelines. |
Snap Settings
| Info |
|---|
|
Field Name | Field Type | Description |
|---|---|---|
Label* Default Value: Move Email | 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. |
User/Shared MailBox Default Value: N/A | String/Expression | Specify the mailbox from which you want to configure auto reply for emails received. If not provided, then the mailbox specified in the account settings is used. |
Existing Message ID* Default Value: N/A | String/Expression | Specify the ID of an existing message to mark it as read. |
Destination Folder* Default Value: N/A | String/Expression | Specify the name of the folder where you want to move the email. |
Snap Execution Default Value: Execute only | Dropdown list | Select one of the three following modes in which the Snap executes:
|
...
|
...
|
...
Check boxes:
- If selected, <Snap behavior>.
If selected, an empty file is written when the incoming document has no data. - If selected, <behavior>. If not selected/Otherwise, <behavior>
Use "If not selected" if the first sentence is long.
If selected, the Snap uses the file path value as is. Otherwise, the Snap uses the file path value in the URL.
If selected, an empty file is written when the incoming document has empty data. If there is no incoming document at the input view of the Snap, no file is written regardless of the value of the property.
- Select to <action>
Use this if the behavior is binary. Either this or that, where the converse behavior is apparent/obvious.
Select to execute the Pipeline during validation.
Text Fields
- Describe what the field represents/contains. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc.
The name of the account.
The account ID that you want to use to log in to the endpoint.
Required if IAM Role is selected.
Do not use this field if you are using batch processing.
Numeric Text Fields
- Describe what the field represents/contains. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc. Include special values that impact the field's behavior as a bullet list.
The number of records in a batch.
The number of seconds for which you want the Snap to wait between retries.
The number of seconds for which the Snap waits between retries.
Use the following special values:
* 0: Disables batching.
* 1: Includes all documents in a single request.
...
Field Sets
Specify advanced parameters that you want to include in the request.
This fieldset consists of the following fields:
- Field 1
- Field 2
- Field 3
Troubleshooting
...
Batch execution failed
...
The Pipeline ended before the batch could complete execution due to a connection error.
Verify that the Batch size field is configured to handle the inputs properly. If you are not sure when the input data is available, configure this field as zero to keep the connection always open.
Examples
Excluding Fields from the Input Data Stream
We can exclude the unrequired fields from the input data stream by omitting them in the Input schema field set. This example demonstrates how we can use the <Snap Name> to achieve this result:
...
|
Troubleshooting
Error | Reason | Resolution |
|---|---|---|
Destination Folder is required field for performing operation | Missing Destination Folder field. | Enter the folder name where you want to move the file. |
Examples
To manage an email in a mailbox
We are using an example of email management, where we have a chain of email Snaps functioning respectively to perform tasks for the mails in the mailbox.
In this example, our Pipeline activities are as follows:
Reading and email using Read Email Snap.
Marking an email as read using Mark Email As Read Snap.
Copying document stream using Copy Snap.
Flagging an email using Flag Email Snap.
Moving an email using Move Email Snap.
Here, let us look into Read Email Snap in this Pipeline.
We read an email from a mailbox, wherein we provide all the required details in the Snap Settings shown below:
Read Email Snap | Output |
|---|---|
 |  |
Upon execution, we see an output with email details from the desired folder.
Here, let us look into Flag Email Snap in this Pipeline.
We flag an email from a mailbox, wherein we provide all the required details in the Snap Settings shown below:
Flag Email Snap | Output |
|---|---|
 |  |
Upon execution, we see an output confirming the flagging of the desired email.
Here, let us look into Move Email Snap in this Pipeline.
We move an email from one folder to another folder, wherein we provide all the required details in the Snap Settings shown below:
Move Email Snap | Output |
|---|---|
 |  |
Upon execution, we see an output confirming that the email has moved to the destination folder.
Downloads
| Note |
|---|
| Info |
Important Steps to Successfully Reuse Pipelines
|
| Attachments | ||
|---|---|---|
|
Snap Pack History
| Expand | |
|---|---|
|
...
|
...
|
...
See Also
...