Skip to main content

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 NameDescription
General Tab:General mail server connection settings.
1Step NameSpecify the name of the step. This name has to be unique in a single workflow.
Server Settings:
2Source hostProvide the mail server host.
3Use SSL?Enable this checkbox if your server needs an SSL connection.
4UsernameSpecify the username of the mailbox to connect to.
5PasswordSpecify the password for the username.
6Use proxy?Check the checkbox if you want to connect through a proxy.
7Proxy HostSpecify the Server Name or IP of the proxy.
8Proxy PortSpecify the port number of the proxy.
9Proxy UsernameSpecify the username to connect to the proxy server.
10Proxy PasswordSpecify the password of the proxy server to connect.
11Retrieve emails in reverse orderEnable this checkbox to retrieve email in reverse order i.e latest to oldest.
12Fetch in batches?Enable this checkbox if you want to retrieve larger volumes of mails in batches.
13Save AttachmentsEnable this checkbox to save attachments.
14Attachment FolderClick Select folder to specify the folder name to save the attachments.
15Ignore errors reading fieldsSometimes a server doesn't support the retrieval of a particular piece of information. Enable this option to ignore these errors.
16ProtocolSelect 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:
14Connection timeout (in milliseconds)Specify the socket connection timeout value in milliseconds.

Default value: Infinite

15ProtocolsSelect 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.
16Test Connection buttonClick 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.
1RetrieveSpecify either "All emails" or "Retrieve first... emails"
2Retrieve the ... first emailsIf 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.

3Delete emails afterEnable checkbox to Delete emails after retrieval.
IMAP Settings:IMAP Settings are enabled if you chose IMAP as the protocol.
1Get folder from fieldEnable this option if you wish to retrieve the IMAP folder name from an input field.
2Folder fieldSelect a field containing the folder name.
3IMAP folderType or browse for the IMAP folder to retrieve mails from.
4Test folder... buttonClick Test folder button to test if the folder is valid.
5Open buttonClick Open button to select the IMAP folder.
6Include subfoldersCheck this option to retrieve mails from sub-folders as well.
7RetrieveSpecify which mails to retrieve: Get all, new, old, read, unread, flagged, not flagged, draft, not draft, answered or not answered messages.
8Retrieve the first ... emailsSpecify the number emails to retrieve at most.

Note: This field is enabled Protocol chosen is IMAP in the General settings tab.

Batch Settings:
1Batch sizeSpecify the number of emails to retrieve at once in one batch.
2Start at message numberSpecify the first message number to start retrieving at.
3End at message numberSpecify the last message number to end retrieving with.
Filters Tab:These are the filters you can set on the header of the mail message.
1Sender (FROM)If check box is ticked then filter by Sender (FROM).
2Recipient(To)If check box is ticked then filter by Recipient(To).
3SubjectIf check box is ticked then filter by Subject.
4Received DateChoose a condition on Received Date from the list.
5Limit SizePut a size limit on the mail with attachments.
Fields Tab:
1NameChoose email attributes to be available as fields.
2Keep HTML Tags in the BodySelect the checkbox if you want the HTML tags to be displayed in the output view.

Note: The checkbox is clear by default.