This is documentation for Semarchy xDI 5.3 or earlier, which is no longer supported.

For more information, see our Global Support and Maintenance Policy.

Read Emails

GetMails32x32

Description

Reads emails from an email server. These emails can be written to a file or stored in a table.

Parameters

Name	Mandatory	Default	Description
Mail Hostname	Yes		Email server host name or IP address.
Mail Port	No	110 (or 995 if Mail Use SSL is set to true).	Email server host name or IP address.
Mail Protocol	No	pop3	Protocol used with the email server: pop3 or imap.
Mail User	No		User connecting to the email server.
Mail Password	No		This user’s password, encrypted. E-mail account providers such as Google or Microsoft may require to use an App Password in third-party applications such as Semarchy xDI instead of the real user’s password, for security purposes. See App Passwords for further details.
Mail Unencrypted Password	No		This user’s password, in plain text. E-mail account providers such as Google or Microsoft may require to use an App Password in third-party applications such as Semarchy xDI instead of the real user’s password, for security purposes. See App Passwords for further details.
Mail Server Folder	No	INBOX	Folder in the email server from which emails are read.
Mail Keep on Server	No	false	Preserve a copy of the emails on the mail server.
Mail No Mail Error	No	false	If set to true, the action raises an error if no email is found on the server.
Mail From Filter	No		Filter applied to the email senders.
Mail To Filter	No		Filter applied to the email recipients.
Mail Cc Filter	No		Filter applied to the email Cc recipients.
Mail Subject Filter	No		Filter applied to the email subject text.
Mail Extract Message	No	true	Set to true to extract the email message to a file.
Mail Message Prefix	No	MSG	Prefix used for the email messages files.
Mail Extract Attachments	No	true	Set to true to extract the email attachments to a file.
Mail Attachment Prefix	No		Prefix used for the email attachments files.
Mail Files Folder	No	Temporary directory of the Runtime engine.	Directory into which the files are extracted.
Mail Folder Options	No	None	Organize the extracted files into subfolders named after the sender or subject. By default, all extracted files are in the Mail Files Folder (none).
Mail Use Ucase	No	false	Use uppercase names for the file names.
Mail Wait Mode	No	false	Waits for emails to appear on the server.
Mail Timeout	No	–1	Timeout for waiting for emails to appear on the server. –1 stands for an infinite timeout.
Mail Pollint	No	1000	Emails polling interval.
Mail Nb Msg	No	1 if Mail Wait Mode is true, infinite otherwise.	Number of messages to wait for.
Mail Use SSL	No	False	Set to true if the email server requires a secured connection.
Mail SSL Protocol	No	SSL	Secured protocol used for the connection. SSL or TLS.
Mail Mark As	No		After the email has been read, mark it as READ, UNREAD, DELETED, FLAGGED, ANSWERED, DRAFT or RECENT.
SQL Connection	No		SQL connection into which the list of downloaded emails is published.
SQL Schema Name	No		SQL schema into which the list of downloaded emails is published.
SQL Transaction Name	No		SQL transaction into which the list of downloaded emails is published.
Session Properties	No		Additional connection properties.

Name

Mandatory

Default

Description

Mail Hostname

Yes

Email server host name or IP address.

Mail Port

110 (or 995 if Mail Use SSL is set to true).

Email server host name or IP address.

Mail Protocol

pop3

Protocol used with the email server: pop3 or imap.

Mail User

User connecting to the email server.

Mail Password

This user’s password, encrypted.

E-mail account providers such as Google or Microsoft may require to use an App Password in third-party applications such as Semarchy xDI instead of the real user’s password, for security purposes. See App Passwords for further details.

Mail Unencrypted Password

This user’s password, in plain text.

E-mail account providers such as Google or Microsoft may require to use an App Password in third-party applications such as Semarchy xDI instead of the real user’s password, for security purposes. See App Passwords for further details.

Mail Server Folder

INBOX

Folder in the email server from which emails are read.

Mail Keep on Server

false

Preserve a copy of the emails on the mail server.

Mail No Mail Error

false

If set to true, the action raises an error if no email is found on the server.

Mail From Filter

Filter applied to the email senders.

Mail To Filter

Filter applied to the email recipients.

Mail Cc Filter

Filter applied to the email Cc recipients.

Mail Subject Filter

Filter applied to the email subject text.

Mail Extract Message

true

Set to true to extract the email message to a file.

Mail Message Prefix

MSG

Prefix used for the email messages files.

Mail Extract Attachments

true

Set to true to extract the email attachments to a file.

Mail Attachment Prefix

Prefix used for the email attachments files.

Mail Files Folder

Temporary directory of the Runtime engine.

Directory into which the files are extracted.

Mail Folder Options

None

Organize the extracted files into subfolders named after the sender or subject. By default, all extracted files are in the Mail Files Folder (none).

Mail Use Ucase

false

Use uppercase names for the file names.

Mail Wait Mode

false

Waits for emails to appear on the server.

Mail Timeout

–1

Timeout for waiting for emails to appear on the server. –1 stands for an infinite timeout.

Mail Pollint

1000

Emails polling interval.

Mail Nb Msg

1 if Mail Wait Mode is true, infinite otherwise.

Number of messages to wait for.

Mail Use SSL

False

Set to true if the email server requires a secured connection.

Mail SSL Protocol

SSL

Secured protocol used for the connection. SSL or TLS.

Mail Mark As

After the email has been read, mark it as READ, UNREAD, DELETED, FLAGGED, ANSWERED, DRAFT or RECENT.

SQL Connection

SQL connection into which the list of downloaded emails is published.

SQL Schema Name

SQL schema into which the list of downloaded emails is published.

SQL Transaction Name

SQL transaction into which the list of downloaded emails is published.

Session Properties

Additional connection properties.

Passwords are encrypted using the encrypt <password> command on the Runtime engine console (engine command line tool).

App Passwords

E-mail account providers such as Google or Microsoft may require to use an App Password in third-party applications such as Semarchy xDI instead of the real user’s password, for security purposes.

When this is the case, you will have authentication errors if you try connecting with the real user’s password. In such a situation, you have to login to your account on a web browser, create an app password for your account, then use it as password inside Semarchy xDI.

See Google’s documentation, Microsoft’s documentation, or any of your e-mail provider’s documentation to learn how to create app passwords, if necessary.