Email Message Input
Description:
Email messages input is a step in the Input Plugin for Process Studio Workflows. This step is used to retrieve messages and their attachments from a mail server using the POP3, IMAP or MBOX standard protocols. This step is similar to ‘Get emails from POP’ entry in a process.
Configurations:
No. | Field Name | Description |
---|---|---|
General Tab: | General mail server connection settings. | |
1 | Step Name | Specify the name of the step. This name has to be unique in a single workflow. |
Server Settings: | ||
2 | Source host | Provide the mail server host. |
3 | Use SSL? | Enable this checkbox if your server needs an SSL connection. |
4 | Username | Specify the username of the mailbox to connect to. |
5 | Password | Specify the password for the username. |
6 | Use proxy? | Check the checkbox if you want to connect through a proxy. |
7 | Proxy Host | Specify the Server Name or IP of the proxy. |
8 | Proxy Port | Specify the port number of the proxy. |
9 | Proxy Username | Specify the username to connect to the proxy server. |
10 | Proxy Password | Specify the password of the proxy server to connect. |
11 | Retrieve emails in reverse order | Enable this checkbox to retrieve email in reverse order i.e latest to oldest. |
12 | Fetch in batches? | Enable this checkbox if you want to retrieve larger volumes of mails in batches. |
13 | Save Attachments | Enable this checkbox to save attachments. |
14 | Attachment Folder | Click Select folder to specify the folder name to save the attachments. |
15 | Ignore errors reading fields | Sometimes a server doesn't support the retrieval of a particular piece of information. Enable this option to ignore these errors. |
16 | Protocol | Select a standard protocol POP3, IMAP or MBOX to retrieve mails. Note: To use a pop protocol, you need to configure your application for pop protocol, or for a web application you need to enable pop protocol which can differ for different service providers. For example:For web-based Gmail, you need to set the following, 1. Go to settings. 2. Go to Forwarding and POP/IMAP. 3. Enable POP for mail that arrives from now on. |
Timeout and Protocols: | ||
14 | Connection timeout (in milliseconds) | Specify the socket connection timeout value in milliseconds. Default value: Infinite |
15 | Protocols | Select the checkbox of the TLS version for sending the email message. The available versions are: TLSv1, TLSv1.1, TLSv1.2, or TLSv1.3. You can select one or all versions. |
16 | Test Connection button | Click this button to connect to the mail server with the connection details specified. This button does not retrieve mails. |
Settings Tab: | ||
POP3 Settings: | POP3 Settings are enabled if you chose POP3 as the protocol. | |
1 | Retrieve | Specify either "All emails" or "Retrieve first... emails" |
2 | Retrieve the ... first emails | If you chose "Retrieve first... emails", in the field above this field is enabled. Specify the number of mails you want to retrieve. Note: The value should be less than or equal to number of email present in INBOX. |
3 | Delete emails after | Enable checkbox to Delete emails after retrieval. |
IMAP Settings: | IMAP Settings are enabled if you chose IMAP as the protocol. | |
1 | Get folder from field | Enable this option if you wish to retrieve the IMAP folder name from an input field. |
2 | Folder field | Select a field containing the folder name. |
3 | IMAP folder | Type or browse for the IMAP folder to retrieve mails from. |
4 | Test folder... button | Click Test folder button to test if the folder is valid. |
5 | Open button | Click Open button to select the IMAP folder. |
6 | Include subfolders | Check this option to retrieve mails from sub-folders as well. |
7 | Retrieve | Specify which mails to retrieve: Get all, new, old, read, unread, flagged, not flagged, draft, not draft, answered or not answered messages. |
8 | Retrieve the first ... emails | Specify the number emails to retrieve at most. Note: This field is enabled Protocol chosen is IMAP in the General settings tab. |
Batch Settings: | ||
1 | Batch size | Specify the number of emails to retrieve at once in one batch. |
2 | Start at message number | Specify the first message number to start retrieving at. |
3 | End at message number | Specify the last message number to end retrieving with. |
Filters Tab: | These are the filters you can set on the header of the mail message. | |
1 | Sender (FROM) | If check box is ticked then filter by Sender (FROM). |
2 | Recipient(To) | If check box is ticked then filter by Recipient(To). |
3 | Subject | If check box is ticked then filter by Subject. |
4 | Received Date | Choose a condition on Received Date from the list. |
5 | Limit Size | Put a size limit on the mail with attachments. |
Fields Tab: | ||
1 | Name | Choose email attributes to be available as fields. |
2 | Keep HTML Tags in the Body | Select the checkbox if you want the HTML tags to be displayed in the output view. Note: The checkbox is clear by default. |