Mail Source
- Akash Kumar Jaiswal (Unlicensed)
- Ashhad Alam
Mail Source provides the ability to specify a file as a source and is accessible via email. This section describes how to create a Mail Source service.
Perform the following steps to create a mail source:
- Click Configure > SOURCES > Mail Source.
Click Create Mail Source.
On the Create Mail Source screen, enter the details explained in the table below:
Field Name
Description
Name Name of the new mail source. Description Description of the new mail source. Protocol Internet standard protocol to be used for retrieving incoming mails. The available options are POP3 and IMAP4. Based on the selected protocol, the default port number for that protocol is displayed in the Port text box. Incoming Mail Server Incoming mail (SMTP) Server address. Security Type Protocol that provide data encryption and authentication between applications and servers in scenarios where that data is being sent across an insecure network. The available options are SSL, TLS, None. Supported TLS version is 1.2. Port Port number of the Incoming Mail Server. Authentication Type Select the type of authentication from the Authentication Type field. The available options are Basic and OAuth 2.0. OAuth Account Select one of the available OAuth accounts from this field. It is available only when you select OAuth 2.0 as an authentication type.
OAuth Account field displays only those OAuth Accounts for which you have selected Use In Mail Activity check box while creating the account. Click here to know how to create an OAuth Account.User Id Username of the mail server.
In case you have selected OAuth authentication type, this field will not appear.Password Password of the mail server.
In case you have selected OAuth authentication type, this field will not appear.Confirm Password Password to confirm. Search Criteria Criteria for the email. The available options are: Sender E-mail, Subject, Mail Content. You can select more than one filter criteria. You can use asterisk and wild cards in the content of the email. Data Location Location of the data in the email whether sent as an Attachment or in the email Body. Select Multipart to send both attachments and email body in the mail source.
If you select Multipart option, perform the following steps:
- Connect the output stream of the source layout to the mail source. The output of the source layout is sent as an Attachment in the mail source.
Create a Put-Context Var activity before the mail source and set the variable and Message Body in Variable Value to send it as an email Body in the mail source.
For example,
VariableName: Service.<<MailSourceActivityName>>.MessageBody
Body Content Type Type of content of the body. The available options are text/html and text/plain. Â
File Name Name of the file, if the data is to be sent in the email as an attachment. Mail Source activity does not support more than one file attachment. Leave Copy on Server Copy of the email to leave on the server. - Connect the output stream of the source layout to the mail source. The output of the source layout is sent as an Attachment in the mail source.
- Expand Advanced Properties.
- Define the required character set encoding code in the Character Set Encoding Used text box.
- Select the project from the drop-down list of Project.
Click Save.
Click Test to verify the mail source service at design time. This verifies the values in the Incoming Mail (POP3) Server, Port, User ID and Password text boxes and checks whether the source service actually exists in the specified location or not.
When a mail event triggers process flows, each process flow uses a mail source. At times, when multiple process flows use a mail source, errors can occur. In such case, you can retry the action before exiting the mail source. You can also set the number of retries in the abpm.mailEvent.retry property.