In this article
...
Limitations & Known Issues
None.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| A document containing the email folder from which you want to retrieve the emails. |
Output | Document Binary |
|
| Document containing a list of emails from the target mailbox. |
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 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: Read 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 retrieve the list of emails. Alternatively, click the Suggestionicon to select the email folder in the mailbox. For example, RecommendationIf you do not provide a user/shared mailbox, the mailbox associated with the user account of the OAuth2 User account (signed in user) is considered. However, if you use an OAuth2 Application account, you must select a User/Shared Mailbox to retrieve the mailboxes associated with the user. | |
Email Folder* Default Value: Inbox | String/Expression | Enter the name of the email folder. | |
Filter Conditions | Use this fieldset to specify the email filter conditions you want to include. Click + to add a row. | ||
Email Field Default Value: N/A | String/Expression | Specify the email field’s name upon which to apply the filter. Available options are as follows:
| |
Operator Default Value: N/A | String/Expression | Specify a conditional operator. Available options are as follows:
| |
Email Field Value Default Value: N/A | String/Expression | Specify a value for the email field to add a condition. | |
Fetch only focused emails Default Value: Deselected | Checkbox | Select to retrieve the emails which are marked as Focused. This is applicable only in the inbox folder. | |
Fetch only unread emails Default Value: Deselected | Checkbox | Select to retrieve the mails to retrieve only unread emails. | |
Older messages on top Default Value: Deselected | Checkbox | Select to sort the older messages by date. | |
Download attachments Default Value: Deselected | Checkbox | Select to download attachments into binary output view. If not selected attachments will not be downloaded. | |
Mark email as read Default Value: Deselected | Checkbox | Select to mark the email as read. | |
Number of Messages to Fetch Default Value: N/A | Integer/Expression | Enter the maximum number of messages to be retrieved. If left blank, then it fetches all messages. | |
Snap Execution Default Value: Validate & Execute | Dropdown list | Select one of the three following modes in which the Snap executes:
|
Troubleshooting
Error | Reason | Resolution |
---|---|---|
Select valid MailBox Email ID | The email ID you have provided is invalid. | Verify and enter the correct email ID. |
Select valid Email Folder Name | The name of the Email Folder you have provided is invalid. | Verify and enter the correct name of the email folder. |
Examples
To manage an email in a mailbox
...
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.
...
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 flagging 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
Info |
---|
Important Steps to Successfully Reuse Pipelines
|
Attachments | ||
---|---|---|
|
Snap Pack History
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
...
See Also
...