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.

Mail Unencrypted Password

No

This user’s password, in plain text.

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.

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