Get Email Action

The Get E-mail action is a powerful solution for managing and streamlining the retrieval of inbound e-mail. It encompasses a variety of activities that can detect e-mail contents and automatically download specific messages from multiple servers and/or accounts as a result. Additionally, it can save attachments into selected folders and remove unnecessary messages directly from the server. This action supports all major protocols including POP3, IMAP, WEBDAV (Exchange 2003) and EWS (Exchange 2007/2010). When you apply criteria to an IMAP or WebDav mail request, it is sent as a query to the mail server and only the relative results are returned. POP3 now uses a regular expression-based filter. This action's advanced security features provide secure transport of data over SMTP, IMAP, and POP3 protocols via Explicit and Implicit Transport Layer Security (TLS) and/or Secure Sockets Layer (SSL).

Combined with the Send E-mail and Exchange actions, AWE presents a powerful e-mail attendant that allows you to automate common e-mail operations and simultaneously manage several e-mail accounts from as many mail servers as you want. For instance, Get E-mail along with the Send E-mail action can be used as an auto-responder or data could be written to a database (using SQL Query). Also provides the ability to send different auto-responses based on the content of the incoming e-mail.

Retrieves and/or removes e-mail messages from a POP3/IMAP/WEBDAV (Exchange Server) mail box. A dataset is created and populated with the message information. The dataset can be scanned using the Loop Dataset action and accessed by referencing %datasetname.field%. Note that messages will be processed even if they have already been processed unless the Remove mail from server parameter is checked.

See Also: Send E-mail, Exchange, Twitter, MSMQ, FTP

Properties Tab

In the Activity to perform box, select an activity, then configure the properties for that activity. The available properties depend on the activity selected.

To set properties

  1. In the Available Actions pane, open the Network folder and double-click the Get Email action or drag it into the Steps pane.

  2. On the Properties tab, select an Activity to perform.

  3. Specify the properties that appear, depending on the activity selected.

  4. To set the Description tab properties, refer to Description Tab Options.

  5. To set the Error Causes and On Error tab properties, refer to Step Error Handling.

  6. When finished, click OK to save settings and close the properties dialog box.

Available Activities

The following table briefly describes the available activities for this action as specified in the Activity to perform box.

Activity

Description

Delete Messages

Deletes one or more messages from the specified server. This activity contains a filtering function that allows removal of specific messages based on the filter specified.

Delete Single Message

Deletes/removes a single message as designated in the Message ID / Message sequence number parameter.

Get all headers (faster)

Retrieves all message headers (subject, date, to and from information). If the task in question does not need the full message to accomplish the goal, downloading only the header of messages is faster than retrieving the full email message content.

Get Messages

Retrieves all messages, including message headers, bodies and attachments.

Get Single Message

Retrieves a single message as indicated in the Message ID / Message sequence number parameter.

Email Properties

Property

Type

Required

Default

Markup

Description

Create and populate dataset

 

 

 

 

Specifies a name for the dataset to be populated with the downloaded data. You can then access the data using this dataset name by placing it between percent signs in subsequent actions (% datasetname.fieldname%).

Remove mail from server

 

 

 

 

Removes the files from the server after downloading.  If you download all messages and select Remove mail from server, all attachments will be lost unless Save attachment is selected.

Message id or

Message sequence no

 

 

 

 

Specifies the sequential number of a single message among the messages on the mail server. This property is only used in conjunction with Get single message or Delete single message. The number can be obtained by downloading the message headers.

Save attachment

check box

Yes

Selected

 

Saves the attachment attached to the downloaded email.  If you download all messages and select Remove mail from server, all attachments will be lost unless this option is selected.

Save attachments in folder

 

 

Empty

 

Specifies the directory into which to save the attachment(s).

If filename already exist

Text (options)

 

Do not save

 

Options include Do not save, Save with unique filename, or overwrite existing file

Server Properties

Property

Type

Required

Default

Markup

Description

Protocol

Text (options)

Yes

POP3

PROTOCOLTYPE="IMAP"

The type of protocol to communicate with. Certain parameters may or may not be available depending on the protocol type selected. The available options are:

  • POP3

  • IMAP

  • Exchange 2003 (WEBDAV)

  • Exchange 2007 (EWS)

  • Exchange 2010 (EWS)

When you apply criteria to an IMAP or WebDav mail request, it is sent as a query to the mail server and only the relative results are returned. POP3 now uses a regular expression-based filter.

Server

Text

Yes

 

 

Specifies the mail server to access.

Port

Number

No

110

 

The port that should be used to connect to the mail server. If the protocol type selected is POP3, this value is 110 by default. If the protocol type selected is IMAP, this value is 143 by default. This parameter is unavailable if the protocol type selected is Exchange 2003 (WEBDAV), Exchange 2007 (EWS) or Exchange 2010 (EWS).

Security

Text (options)

 

No Security

 

Specifies the type of security protocol the mail server uses, if any. This parameter is unavailable if the protocol type selected is Exchange 2003 (WEBDAV), Exchange 2007 (EWS), Exchange 2010 (EWS). The available options are:

  • No security (default)

  • Explicit TLS/SSL

  • Implicit TLS/SSL

Email address

Text

Yes

(Empty)

EMAILADDRESS="test@netauto.com"

The e-mail address to perform the selected activity on.

Exchange server

Text

Yes

(Empty)

SERVER="server.domain.com"

The name of the Exchange server to perform the selected activity on.

HTTPS/HTTP

Yes/No

No

HTTPS

USEHTTP="yes"

Indicates whether to use HTTP or HTTPS as the Exchange server protocol type.

Autodiscover service URL

Yes/No

No

No

AUTODISCOVERURL="yes"

If set to YES, turns on Autodiscover service. The Autodiscover service makes it easier to configure Outlook 2007, 2010 and some mobile phones by using a user's e-mail address and password to automatically configure a user's profile. This parameter is set to NO by default and only available if the Protocol parameter is set to EWS2007 or EWS2010.

Allow redirection

Yes/No

No

No

ALLOWREDIRECTION="yes"

If set to YES, allows redirection of incoming requests to another file or URL. This parameter is set to NO by default and only available if the Autodiscover service URL parameter is set to YES.

Ignore invalid server certificates

Yes/No

No

No

IGNOREINVALIDCERTIFICATE="yes"

If set to YES, invalid server certificates are ignored. In some cases the SSL certificate may be expired or become invalid and an exception is thrown due to invalid SSL certificate. You may avoid such SSL certificate errors by choosing to ignore invalid server certificates. This parameter is set to NO by default and only available if the Protocol parameter is set to EWS2007 or EWS2010.

Current folder

Text

Yes

(Empty)

CURRENTFOLDER="Contact"

The Exchange folder in which to perform the selected activity on.

Timeout

Number

No

100

TIMEOUT="120"

The total amount of time in seconds that this activity should be allowed to execute before a time out error occurs.

Authentication type

Text (options)

No

Basic

AUTHTYPE="Default"

The Exchange server authentication type. The available options are:

  • Basic

  • Default - The authentication type set globally.

  • Form (Exchange 2003 - WEBDAV only) - A security feature in Exchange 2003 that disables the Remember my password check box and allows inactive sessions to expire requiring re-authentication.

Domain name

Text

Yes

(Empty)

DOMAINNAME="domain"

The domain name corresponding to the e-mail address to perform the selected action on.

Username

Text

Yes

(Empty)

USERNAME="username"

The username corresponding to the e-mail address to perform the selected action on.

Password

Text

Yes

(Empty)

PASSWORD="password"

The password corresponding to the e-mail address to perform the selected action on.

Filter Properties

Property

Type

Required

Default

Markup

Description

From

Text

Yes

(Empty)

EMAILADDRESS="test@netauto.com"

Specify a From address to filter

To

Text

Yes

(Empty)

EMAILADDRESS="test@netauto.com"

Specify a To address to filter

Subject

Text

Yes

(Empty)

  

Specify a Subject  to filter

Body

Text

Yes

(Empty)

  

Specify Body text to filter

Cc

Text

Yes

(Empty)

EMAILADDRESS="test@netauto.com"

Specify a Cc address to filter

Bcc

Text

Yes

(Empty)

EMAILADDRESS="test@netauto.com"

Specify a Bcc address to filter

Has attachments

 

 

 

 

Specify Yes, No, or Doesn't matter

Has been read

 

 

 

 

Specify Yes, No, or Doesn't matter

Only if newer than

 

 

 

 

Select the check box then specify  a date and time or a Custom period (Now, Last 30 seconds, Last 30 minutes, Last 24 hours, Last 30 days, Last 12 months, Last 5 years, Next 30 seconds, Next 30 minutes, Next 24 hours, Next 30 days, Next 12 months, or Next 5 years)

Only if older than

 

 

 

 

Select the check box then specify  a date and time or a Custom period (Now, Last 30 seconds, Last 30 minutes, Last 24 hours, Last 30 days, Last 12 months, Last 5 years, Next 30 seconds, Next 30 minutes, Next 24 hours, Next 30 days, Next 12 months, or Next 5 years)

Proxy Properties

Property

Type

Required

Default

Markup

Description

Proxy Type

Options

No

None

PROXYTYPE="Socks5"

The proxy protocol that should be used. If you are unsure of the value to use in this parameter, contact your network administrator.

The available options are:

  • System Default -

  • None (Default) - Instructs the activity not to use a proxy server regardless of the system default.

  • Socks 4: Instructs the activity to go through a Socks 4 compliant server.

  • Socks 4a: Instructs the activity to go through a Socks 4a compliant server.

  • Socks 5: Instructs the activity to go through a Socks 5 compliant server.

  • HTTP - Instructs the activity to go through a HTTP compliant server.

Proxy Host

Text

No

(Empty)

PROXYSERVER="proxy.host.com"

The hostname (i.e. server.domain.com) or IP address i.e. (xxx.xxx.xxx.xxx) of the proxy server.

Proxy Port

Text

Yes

21

PORT="1000"

The port that should be used to connect to the FTP server. Most standard FTP servers operate on port 21 (the default port specified) however, this parameter can be customized in case the FTP server operates on other ports.

NOTE: Other default ports may be assigned depending on the server connection type selected.

Use authentication

 

 

 

 

Available only when Socks 5 or HTTP is specified for Proxy type.

Proxy Username

Text

No

(Empty)

PROXYUSERNAME="username"

The username that should be used to authenticate when connecting through the proxy server. This option is only valid when Socks 5 is specified in the Proxy type as it is the only version that supports authentication.

Proxy Password

text

No

(Empty)

PROXYPASSWORD="encrypted"

The password that should be used to authenticate when connecting through the proxy server. When the step is created using the Task Builder it is written to the task encrypted. This option is only valid when Socks 5 is specified in the Proxy type as it is the only version that supports authentication.