Email - Get message(s)

Declaration

<AMEMAIL ACTIVITY="all_messages" SESSION="text" PROTOCOLTYPE="text (options)" EMAILADDRESS="text" USEHTTP="YES/NO" SERVER="text" PORT="number" AUTODISCOVERURL="YES/NO" IMPERSONATE="YES/NO" AUTHTYPE="text (options)" USERNAME="text" PASSWORD="text (encrypted)" DOMAINNAME="text" TENANTID="text (encrypted)" CLIENTID="text (encrypted)" CLIENTSECRET="text (encrypted)" CURRENTFOLDER="text" TIMEOUT="number" SECURITY="text (options)" CERTIFICATE="text" CERTIFICATEPASSPHRASE="text (encrypted)" IGNOREINVALIDCERTIFICATE="YES/NO" TLSCIPHERS="text (options)" TLSVERSIONS="text (options)" PROXYTYPE="text (options)" PROXYSERVER="text" PROXYPORT="number" PROXYUSERNAME="text" PROXYPASSWORD="text (encrypted)" RESULTDATASET="text" REMOVEMESSAGE="YES/NO" ATTACHMENTDEST="text" SAVEMODE="text (options)" FROM="text" TO="text" SUBJECT="text" BODY="text" CC="text" HASATTACHMENT="text (options)" HASBEENREAD="text (options)" IFNEWERTHAN="text (date expression)" IFOLDERTHAN="text (date expression)" />

Related Topics

Description

Retrieves one or more messages from the specified server and populates a dataset with the results. This activity contains a filtering function that allows retrieval of specific messages based on the criteria specified.

Practical usage

Commonly used to retrieve multiple or all messages from the server.

Parameters

Connection

Property Type Required Default Markup Description
Connection --- --- --- --- Indicates where user credentials, server settings, and other preferences required to establish a connection to the email server originate. The available options are:
  • Host (default) - Specifies that user credentials, server settings, and advanced preferences are configured individually for this activity. This option is normally chosen if only a single activity is required to complete an operation.
  • Session - Specifies that user credentials, server settings, and advanced preferences are obtained from a preconfigured session created in an earlier step with the use of the Email - Create session activity. This option is normally chosen if a combination of related activities is required to complete an operation. Linking several activities to a single session eliminates redundancy. Additionally, a single task supports construction and simultaneous execution of multiple sessions, improving efficiency.
NOTE: This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes.

Connection - Session

Property Type Required Default Markup Description
Session Text Yes, if Connection is set to Session EmailSession1 SESSION="emailSess1" The existing Email-based session to use with this activity. The default value is EmailSession1. This parameter becomes available and is required if the Connection parameter is set to Session.

Connection - Host > Server

Property Type Required Default Markup Description
Protocol Text (options) Yes SMTP
  • PROTOCOLTYPE="imap"
  • PROTOCOLTYPE="webdav"
  • PROTOCOLTYPE="ews"
  • PROTOCOLTYPE="ewsonline"
 Specifies the protocol to use to connect to the email server. The available options are:
  • POP3 (default) - Uses the Post Office Protocol version 3 (POP3).
  • IMAP - Uses the Internet Message Access Protocol (IMAP).
  • WEBDAV (Exchange 2003, 2007) - Uses the Web Distributed Authoring and Provisioning (WEBDAV) protocol. Compatible with Microsoft Exchange Server 2003 and Exchange Server 2007.
  • EWS (Exchange 2007 & newer, Online) - Uses the Exchange Web Services (EWS) protocol. Compatible with Microsoft Exchange Server 2007 and newer versions, and Exchange Online.
  • EWS Online - Uses the EWS protocol to access Microsoft Exchange Online by way of Modern Authentication.
Refer to these parameters when Protocol is set to POP3 or IMAP.
Server Text Yes (Empty) SERVER="mail.server.com Specifies the email server address to use with the connection.
Port Number Yes 25 PORT="3333" The port to use to connect to the email server. The default port value varies for each protocol, but this parameter can be customized to connect to another port, if required. The default port numbers are:
  • POP3 - 110
  • IMAP - 143
Security Text (options) Yes No security
  • SECURITY="explicit"
  • SECURITY="implicit"
 The type of security to use with the connection to the email server. The available options are:
  • No Security (default) - No security is used.
  • Explicit TLS/SSL - Uses Explicit Transport Layer (TLS) and Secure Sockets Layer (SSL) security.
  • Implicit TLS/SSL - Uses Implicit Transport Layer (TLS) and Secure Sockets Layer (SSL) security.
Authentication Type Text (options) Yes Auto
  • AUTHTYPE="Plain"
  • AUTHTYPE="DigestMD5"
  • AUTHTYPE="CramMD5"
  • AUTHTYPE="Login"
  • AUTHTYPE="ClearText"
  • AUTHTYPE="Ntlm"
  • AUTHTYPE="External"
  • AUTHTYPE="GssApi"
  • AUTHTYPE="OAuth20"
 Specifies the authentication protocol to use. The following options are:
  • Auto (default) - Automate Desktop automatically determines the authentication type to use.
  • Plain - Authentication is through the PLAIN protocol.
  • DigestMD5 - Authentication is through the DIGEST-MD5 protocol.
  • CramMD5 - Authentication is through the CRAM-MD5 protocol.
  • Login - Authentication is through the LOGIN protocol.
  • ClearText - Authentication is through the ClearText protocol.
  • Ntlm - Authentication is through the NTML protocol.
  • External - Authentication is through the use of an external third-party authentication source.
  • GssApi - Authentication is through the GSSAPI protocol.
  • OAuth20 - Authentication is through the OAuth 2.0 protocol.
Username Text Yes (Empty) USERNAME="theuser" The username to use to for authentication.
Password Text Yes (Empty) PASSWORD="text (encrypted)" The password that corresponds with the Username parameter to use for authentication.
Certificate Text No (Empty) CERTIFICATE="c:\folder\certname.pfx" Specifies the path and file name of the certificate (.cer or .pfx extension) to use to authenticate. This parameter is only available if the Security parameter is set to Explicit TLS/SSL or Implicit TLS/SSL.
Passphrase Text No (Empty) CERTIFICATEPASSPHRASE="text (encrypted)" The certificate passphrase to use to authenticate. This parameter is only available if the Security parameter is to Explicit TLS/SSL or Implicit TLS/SSL.
Refer to these parameters when Protocol is set to WEBDAV (Exchange 2003, 2007).
Email address Text Yes (Empty) EMAILADDRESS="test@netauto.com" A valid email address to use to authenticate the connection to the Exchange server.
HTTPS/HTTP Yes/No Yes HTTPS USEHTTP="YES" Indicates whether to use HTTP (normal HTTP) or HTTPS (secure HTTP) as the Exchange server protocol type.
Exchange server Text Yes (Empty) SERVER="server.domain.com" Specifies the address of the Exchange server.
Authentication type Text (options) Yes Basic
  • AUTHTYPE="default"
  • AUTHTYPE="form"
 Specifies the type of authentication to use to connect to the Exchange server. The available options are:
  • Basic - Processes basic authentication credentials presented in HTTP headers.
  • Default - Authentication is through the stored Windows credentials of the current user. Selecting this option disables the Domain name, Username, and Password parameters.
  • Form - Authentication is forms-based which lets you use an HTML form to obtain credentials from users who are attempting to access the Exchange server.
NOTE: If you are unsure of the option to use for this parameter, contact your network administrator
Domain name Text Yes (Empty)
  • DOMAINNAME="server.domain.com"
  • DOMAINNAME="xxx.xxx.xxx.xxx"
 The domain name (for example, domain.exchangeServer.com) or IP address to use to connect to the Exchange server.
Username Text Yes (Empty) USERNAME="theUser" A valid username to use to authenticate the connection to the Exchange server. This value may or may not be identical to the value set in the Email address field.
Password Text Yes (Empty) PASSWORD="text (encrypted)" A valid password, corresponding to the Username parameter, to use to authenticate Exchange connection. This parameter is encrypted in Task Builder.
Refer to these parameters when Protocol is set to EWS (Exchange 2007 & newer, Online).
Email address Text Yes (Empty) EMAILADDRESS="test@netauto.com" A valid email address to use to authenticate the connection to the Exchange server.
Username Text Yes (Empty) USERNAME="theUser" The username to use to authenticate the connection to the Exchange server.
Password Text Yes (Empty) PASSWORD="text (encrypted)" The password that corresponds with the Username parameter to use to authenticate Exchange connection. This parameter is encrypted in Task Builder.
Domain name (optional) Text No (Empty)
  • DOMAINNAME="server.domain.com"
  • DOMAINNAME="xxx.xxx.xxx.xxx"
 The domain name (for example, domain.exchangeServer.com) or IP address to use to connect to the Exchange server.
HTTPS/HTTP Yes/No Yes HTTPS USEHTTP="YES" Indicates whether to use HTTP (normal HTTP) or HTTPS (secure HTTP) as the Exchange server protocol type.
Exchange server Text Yes (Empty) SERVER="server.domain.com" Specifies the address of the Exchange server. Click Discover to automatically discover the server based on the information entered in the Email address, User, and Password parameters.
Authenticate as current windows user Yes/No No Disabled AUTHTYPE="default" If selected, authentication to the Exchange server is by way of the current Windows user's credentials, and the Username, Password and Domain name parameters are disabled. This parameter is disabled by default.
Rediscover server at runtime Yes/No No No AUTODISCOVERURL="YES" If selected, the Autodiscover service automatically performs at runtime (disabled by default). The Autodiscover service makes it easier to configure Outlook 2007 or newer, as well as some mobile phones, by using a user's email address and password to automatically configure a user's profile. Setting this parameter to YES disables the Exchange server parameter.
Refer to these parameters when Protocol is set to EWS Online.
Email address Text Yes (Empty) EMAILADDRESS="test@netauto.com" A valid email address to use to authenticate the connection to the Exchange server.
Tenant ID Text Yes (Empty) TENANTID="text (encrypted)" The Directory (tenant) ID to use for authentication. This parameter is encrypted in Task Builder.
Client ID Text Yes (Empty) CLIENTID="text (encrypted)" The Application (client) ID to use for authentication. This parameter is encrypted in Task Builder.
Client secret Text Yes (Empty) CLIENTSECRET="text (encrypted)" The client secret Value to use for authentication. This parameter is encrypted in Task Builder.

Once the Email address, Tenant ID, Client ID, and Client secret parameters are populated, click Verify to perform a test connection to the Exchange Online server.

Connection - Host > Advanced

Property Type Required Default Markup Description
Current folder Text Yes Calendar CURRENTFOLDER="Contact" The Exchange folder of where to perform this activity. This parameter is disabled if the Protocol parameter is set to POP3.
Timeout (seconds) Number Yes 100 TIMEOUT="120" The total amount of time in seconds that this activity is allowed to execute before a time out error occurs.
TLS cipher(s) Text (options) Yes, if Protocol is set to SMTP, POP3, or IMAP and Security is set to Explicit TLS/SSL or Implicit TLS/SSL All
  • TLSCIPHERS="All"
  • TLSCIPHERS="Anonymous"
  • TLSCIPHERS="DH_anon_EXPORT_WITH_DES40_CBC_SHA"
  • TLSCIPHERS="DH_anon_EXPORT_WITH_RC4_40_MD5"
  • TLSCIPHERS="DH_anon_WITH_3DES_EDE_CBC_SHA"
  • TLSCIPHERS="DH_anon_WITH_AES_128_CBC_SHA"
  • TLSCIPHERS="DH_anon_WITH_AES_128_CBC_SHA256"
  • TLSCIPHERS="DH_anon_WITH_AES_256_CBC_SHA"
  • TLSCIPHERS="DH_anon_WITH_AES_256_CBC_SHA256"
  • TLSCIPHERS="DH_anon_WITH_DES_CBC_SHA"
  • TLSCIPHERS="DH_anon_WITH_RC4_128_MD5"
  • TLSCIPHERS="DHE_DSS_EXPORT_WITH_DES40_CBC_SHA"
  • TLSCIPHERS="DHE_DSS_EXPORT1024_WITH_DES_CBC_SHA"
  • TLSCIPHERS="DHE_DSS_EXPORT1024_WITH_RC4_56_SHA"
  • TLSCIPHERS="DHE_DSS_WITH_3DES_EDE_CBC_SHA"
  • TLSCIPHERS="DHE_DSS_WITH_AES_128_CBC_SHA"
  • TLSCIPHERS="DHE_DSS_WITH_AES_128_CBC_SHA256"
  • TLSCIPHERS="DHE_DSS_WITH_AES_128_GCM_SHA256"
  • TLSCIPHERS="DHE_DSS_WITH_AES_256_CBC_SHA"
  • TLSCIPHERS="DHE_DSS_WITH_AES_256_CBC_SHA256"
  • TLSCIPHERS="DHE_DSS_WITH_AES_256_GCM_SHA384"
  • TLSCIPHERS="DHE_DSS_WITH_DES_CBC_SHA"
  • TLSCIPHERS="DHE_DSS_WITH_RC4_128_SHA"
  • TLSCIPHERS="DHE_RSA_EXPORT_WITH_DES40_CBC_SHA"
  • TLSCIPHERS="DHE_RSA_WITH_3DES_EDE_CBC_SHA"
  • TLSCIPHERS="DHE_RSA_WITH_AES_128_CBC_SHA"
  • TLSCIPHERS="DHE_RSA_WITH_AES_128_CBC_SHA256"
  • TLSCIPHERS="DHE_RSA_WITH_AES_128_GCM_SHA256"
  • TLSCIPHERS="DHE_RSA_WITH_AES_256_CBC_SHA"
  • TLSCIPHERS="DHE_RSA_WITH_AES_256_CBC_SHA256"
  • TLSCIPHERS="DHE_RSA_WITH_AES_256_GCM_SHA384"
  • TLSCIPHERS="DHE_RSA_WITH_DES_CBC_SHA"
  • TLSCIPHERS="ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA"
  • TLSCIPHERS="ECDHE_ECDSA_WITH_AES_128_CBC_SHA"
  • TLSCIPHERS="ECDHE_ECDSA_WITH_AES_128_CBC_SHA256"
  • TLSCIPHERS="ECDHE_ECDSA_WITH_AES_128_GCM_SHA256"
  • TLSCIPHERS="ECDHE_ECDSA_WITH_AES_256_CBC_SHA"
  • TLSCIPHERS="ECDHE_ECDSA_WITH_AES_256_CBC_SHA384"
  • TLSCIPHERS="ECDHE_ECDSA_WITH_AES_256_GCM_SHA384"
  • TLSCIPHERS="ECDHE_ECDSA_WITH_RC4_128_SHA"
  • TLSCIPHERS="ECDHE_RSA_WITH_3DES_EDE_CBC_SHA"
  • TLSCIPHERS="ECDHE_RSA_WITH_AES_128_CBC_SHA"
  • TLSCIPHERS="ECDHE_RSA_WITH_AES_128_CBC_SHA256"
  • TLSCIPHERS="ECDHE_RSA_WITH_AES_128_GCM_SHA256"
  • TLSCIPHERS="ECDHE_RSA_WITH_AES_256_CBC_SHA"
  • TLSCIPHERS="ECDHE_RSA_WITH_AES_256_CBC_SHA384"
  • TLSCIPHERS="ECDHE_RSA_WITH_AES_256_GCM_SHA384"
  • TLSCIPHERS="ECDHE_RSA_WITH_RC4_128_SHA"
  • TLSCIPHERS="RSA_EXPORT_WITH_DES40_CBC_SHA"
  • TLSCIPHERS="RSA_EXPORT_WITH_RC2_CBC_40_MD5"
  • TLSCIPHERS="RSA_EXPORT_WITH_RC4_40_MD5"
  • TLSCIPHERS="RSA_EXPORT1024_WITH_DES_CBC_SHA"
  • TLSCIPHERS="RSA_EXPORT1024_WITH_RC4_56_SHA"
  • TLSCIPHERS="RSA_WITH_3DES_EDE_CBC_SHA"
  • TLSCIPHERS="RSA_WITH_AES_128_CBC_SHA"
  • TLSCIPHERS="RSA_WITH_AES_128_CBC_SHA256"
  • TLSCIPHERS="RSA_WITH_AES_128_GCM_SHA256"
  • TLSCIPHERS="RSA_WITH_AES_256_CBC_SHA"
  • TLSCIPHERS="RSA_WITH_AES_256_CBC_SHA256"
  • TLSCIPHERS="RSA_WITH_AES_256_GCM_SHA384"
  • TLSCIPHERS="RSA_WITH_DES_CBC_SHA"
  • TLSCIPHERS="RSA_WITH_RC4_128_MD5"
  • TLSCIPHERS="RSA_WITH_RC4_128_SHA"
  • TLSCIPHERS="Secure"
  • TLSCIPHERS="Vulnerable"
  • TLSCIPHERS="Weak"
 Specifies the TLS/SSL cipher to use. This parameter is only available and required if the Protocol parameter is set to POP3 or IMAP and the Security parameter to Explicit TLS/SSL or Implicit TLS/SSL. The following cipher options are:
  • All - Specifies all ciphers, including the weak ciphers, excluding anonymous ciphers.
  • Anonymous - Specifies anonymous ciphers.
  • DH_anon_EXPORT_WITH_DES40_CBC_SHA - Anonymous exportable 40-bit DES in CBC mode with SHA-1 hash and message authentication code.
  • DH_anon_EXPORT_WITH_RC4_40_MD5 - Anonymous exportable 40-bit RC4 with MD5 hash and message authentication code.
  • DH_anon_WITH_3DES_EDE_CBC_SHA - Anonymous TripleDES in CBC mode with SHA-1 hash and message authentication code.
  • DH_anon_WITH_AES_128_CBC_SHA - Anonymous 128-bit AES in CBC mode with SHA-1 hash and message authentication code.
  • DH_anon_WITH_AES_128_CBC_SHA256 - Anonymous 128-bit AES in CBC mode with SHA256 hash and message authentication code.
  • DH_anon_WITH_AES_256_CBC_SHA - Anonymous 256-bit AES in CBC mode with SHA-1 hash and message authentication code.
  • DH_anon_WITH_AES_256_CBC_SHA256 - Anonymous 256-bit AES in CBC mode with SHA256 hash and message authentication code.
  • DH_anon_WITH_DES_CBC_SHA - Anonymous DES in CBC mode with SHA-1 hash and message authentication code.
  • DH_anon_WITH_RC4_128_MD5 - Anonymous 128-bit RC4 with MD5 hash and message authentication code.
  • DHE_DSS_EXPORT_WITH_DES40_CBC_SHA - Exportable 40-bit DES in CBC mode with SHA-1 hash and message authentication code.
  • DHE_DSS_EXPORT1024_WITH_DES_CBC_SHA - Exportable 56-bit DES in CBC mode with SHA-1 hash and message authentication code.
  • DHE_DSS_EXPORT1024_WITH_RC4_56_SHA - Exportable 40-bit RC4 with SHA-1 hash and message authentication code.
  • DHE_DSS_WITH_3DES_EDE_CBC_SHA - TripleDES in CBC mode with SHA-1 hash and message authentication code.
  • DHE_DSS_WITH_AES_128_CBC_SHA - 128-bit AES in CBC mode with SHA-1 hash and message authentication code.
  • DHE_DSS_WITH_AES_128_CBC_SHA256 - 128-bit AES in CBC mode with SHA-256 hash and message authentication code.
  • DHE_DSS_WITH_AES_128_GCM_SHA256 - 128-bit AES in GCM mode with SHA-256 hash and authenticated encryption (AEAD).
  • DHE_DSS_WITH_AES_256_CBC_SHA - 256-bit AES in CBC mode with SHA-1 hash and message authentication code.
  • DHE_DSS_WITH_AES_256_CBC_SHA256 - 256-bit AES in CBC mode with SHA-256 hash and message authentication code.
  • DHE_DSS_WITH_AES_256_GCM_SHA384 - 256-bit AES in GCM mode with SHA-384 hash and authenticated encryption (AEAD).
  • DHE_DSS_WITH_DES_CBC_SHA - 56-bit DES in CBC mode with SHA-1 hash and message authentication code.
  • DHE_DSS_WITH_RC4_128_SHA - 128-bit RC4 with SHA-1 hash and message authentication code.
  • DHE_RSA_EXPORT_WITH_DES40_CBC_SHA - Exportable 40-bit DES in CBC mode with SHA-1 hash and message authentication code.
  • DHE_RSA_WITH_3DES_EDE_CBC_SHA - TripleDES in CBC mode with SHA-1 hash and message authentication code.
  • DHE_RSA_WITH_AES_128_CBC_SHA - 128-bit AES in CBC mode with SHA-1 hash and message authentication code.
  • DHE_RSA_WITH_AES_128_CBC_SHA256 - 128-bit AES in CBC mode with SHA-256 hash and message authentication code.
  • DHE_RSA_WITH_AES_128_GCM_SHA256 - 128-bit AES in GCM mode with SHA-256 hash and authenticated encryption (AEAD).
  • DHE_RSA_WITH_AES_256_CBC_SHA - 256-bit AES in CBC mode with SHA-1 hash and message authentication code.
  • DHE_RSA_WITH_AES_256_CBC_SHA256 - 256-bit AES in CBC mode with SHA-256 hash and message authentication code.
  • DHE_RSA_WITH_AES_256_GCM_SHA384 - 256-bit AES in GCM mode with SHA-384 hash and authenticated encryption (AEAD).
  • DHE_RSA_WITH_DES_CBC_SHA - 56-bit DES in CBC mode with SHA-1 hash and message authentication code.
  • ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - TripleDES in CBC mode with SHA-1 hash and message authentication code.
  • ECDHE_ECDSA_WITH_AES_128_CBC_SHA - 128-bit AES in CBC mode with SHA-1 hash and message authentication code.
  • ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - 128-bit AES in CBC mode with SHA-256 hash and message authentication code.
  • ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - 128-bit AES in GCM mode with SHA-256 hash and authenticated encryption (AEAD).
  • ECDHE_ECDSA_WITH_AES_256_CBC_SHA - 256-bit AES in CBC mode with SHA-1 hash and message authentication code.
  • ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - 256-bit AES in CBC mode with SHA-384 hash and message authentication code.
  • ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - 256-bit AES in GCM mode with SHA-384 hash and authenticated encryption (AEAD).
  • ECDHE_ECDSA_WITH_RC4_128_SHA - 128-bit RC4 with SHA-1 hash and message authentication code.
  • ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - TripleDES in CBC mode with SHA-1 hash and message authentication code.
  • ECDHE_RSA_WITH_AES_128_CBC_SHA - 128-bit AES in CBC mode with SHA-1 hash and message authentication code.
  • ECDHE_RSA_WITH_AES_128_CBC_SHA256 - 128-bit AES in CBC mode with SHA-256 hash and message authentication code.
  • ECDHE_RSA_WITH_AES_128_GCM_SHA256 - 128-bit AES in GCM mode with SHA-256 hash and authenticated encryption (AEAD).
  • ECDHE_RSA_WITH_AES_256_CBC_SHA - 256-bit AES in CBC mode with SHA-1 hash and message authentication code.
  • ECDHE_RSA_WITH_AES_256_CBC_SHA384 - 256-bit AES in CBC mode with SHA-384 hash and message authentication code.
  • ECDHE_RSA_WITH_AES_256_GCM_SHA384 - 256-bit AES in GCM mode with SHA-384 hash and authenticated encryption (AEAD).
  • ECDHE_RSA_WITH_RC4_128_SHA - 128-bit RC4 with SHA-1 hash and message authentication code.
  • None - No cipher suite.
  • RSA_EXPORT_WITH_DES40_CBC_SHA - Exportable 40-bit DES in CBC mode with SHA-1 hash and message authentication code.
  • RSA_EXPORT_WITH_RC2_CBC_40_MD5 - Exportable 40-bit RC2 in CBC mode with MD5 hash and message authentication code.
  • RSA_EXPORT_WITH_RC4_40_MD5 - Exportable 40-bit RC4 with MD5 hash and message authentication code.
  • RSA_EXPORT1024_WITH_DES_CBC_SHA - Exportable 56-bit DES in CBC mode with SHA-1 hash and message authentication code.
  • RSA_EXPORT1024_WITH_RC4_56_SHA - Exportable 56-bit RC4 mode with SHA-1 hash and message authentication code.
  • RSA_WITH_3DES_EDE_CBC_SHA -TripleDES in CBC mode with SHA-1 hash and message authentication code.
  • RSA_WITH_AES_128_CBC_SHA - 128-bit AES in CBC mode with SHA-1 hash and message authentication code.
  • RSA_WITH_AES_128_CBC_SHA256 - 256-bit AES in CBC mode with SHA-256 hash and message authentication code.
  • RSA_WITH_AES_128_GCM_SHA256 - 128-bit AES in GCM mode with SHA-256 hash and authenticated encryption (AEAD).
  • RSA_WITH_AES_256_CBC_SHA - 256-bit AES in CBC mode with SHA-1 hash and message authentication code.
  • RSA_WITH_AES_256_CBC_SHA256 - 128-bit AES in CBC mode with SHA-256 hash and message authentication code.
  • RSA_WITH_AES_256_GCM_SHA384- 256-bit AES in GCM mode with SHA-384 hash and authenticated encryption (AEAD).
  • RSA_WITH_DES_CBC_SHA - 56-bit DES in CBC mode with SHA-1 hash and message authentication code.
  • RSA_WITH_RC4_128_MD5 - 128-bit RC4 with MD5 hash and message authentication code.
  • RSA_WITH_RC4_128_SHA - 128-bit RC4 with SHA-1 hash and message authentication code.
  • Secure - Specifies all ciphers that are currently considered secure.
  • Vulnerable - Specifies all ciphers that are currently considered vulnerable.
  • Weak - Specifies all ciphers that are considered weak.
TLS option(s) Text (options) Yes, if Protocol is set to SMTP, POP3, or IMAP and Security is set to Explicit TLS/SSL or Implicit TLS/SSL Any
  • TLSVERSIONS="Any"
  • TLSVERSIONS="None"
  • TLSVERSIONS="SSL30"
  • TLSVERSIONS="TLS10"
  • TLSVERSIONS="TLS11"
  • TLSVERSIONS="TLS12"
 Specifies the TLS/SSL versions allowed. This parameter is only available and required if the Protocol parameter is set to POP3 or IMAP and the Security parameter to Explicit TLS/SSL or Implicit TLS/SSL. The available options are:
  • Any - Use any supported protocol.
  • None - None.

  • SSL30 - SSL 3.0 protocol.

    WARNING: According to RFC 7568, SSL 3.0 is comprehensively broken and must not be used.
  • TLS10 - TLS 1.0 protocol.
  • TLS11 - TLS 1.1 protocol.
  • TLS12 - TLS 1.2 protocol.
Impersonate Yes/No No No IMPERSONATE="YES" If selected, this parameter allows an account on an Exchange server to perform actions by using the permissions that are associated with another account, instead of the permissions that are associated with the caller's account. This parameter is disabled by default. This parameter is only available if the Protocol parameter is set to EWS (Exchange 2007 & newer, Online).
NOTE: With Exchange Impersonation, one account is acting as another account. When an account is impersonated, the system logs the access as if the account that is specified in the header were acting on the system. The calling account must have the appropriate permissions to perform impersonation.
Ignore invalid server certificate Yes/No No No IGNOREINVALIDCERTIFICATE="YES" If selected, invalid or expired SSL server certificates are ignored. If disabled (default) and an invalid server certificate is found, this step throws an error stating that the security certificate on the server is not valid. This parameter is only available if the Protocol parameter is set to EWS (Exchange 2007 & newer, Online).
Proxy type Text (options) No System default
  • PROXYTYPE="none"
  • PROXYTYPE="socks4"
  • PROXYTYPE="socks4a"
  • PROXYTYPE="socks5"
  • PROXYTYPE="http"
 Specifies the proxy type for Automate Desktop to use when attempting network communications through a proxy server. The available options are:
  • System default - Uses the default configurations set for Proxy in the Default Properties section of the Task Administrator (Options > Default Properties > Proxy).
  • None - Explicitly instructs the action not to use a proxy server regardless of the system default.
  • SOCKS 4 - Instructs the action to go through a SOCKS 4-compliant server.
  • SOCKS 4a - Instructs the action to go through a SOCKS 4a -compliant server.
  • SOCKS 5 - Instructs the action to go through a SOCKS 5-compliant server.
  • HTTP - Instructs the action to go through an HTTP-compliant server.
NOTE:
  • To create the most portable tasks, it is recommended to select System default and specify proxy settings globally in the Default Properties section. By proceeding in this manner, tasks created in one environment that may have a proxy server will be portable to others that do not, and vice-versa.
  • If you are unsure of the value to use in this parameter, contact your network administrator.
Proxy server Text Yes, if Proxy type is set to SOCKS 4, SOCKS 4A, SOCKS 5, or HTTP (Empty)
  • PROXYSERVER="proxy.host.com"
  • PROXYSERVER="xxx.xxx.xxx.xxx"
 The hostname (server.domain.com) or IP address of the proxy server. This parameter is only available and required if the Proxy type parameter is set to SOCKS 4, SOCKS 4A, SOCKS 5, or HTTP.
Proxy port Number Yes, if Proxy type set to SOCKS 4, SOCKS 4A, SOCKS 5, or HTTP 1028 PROXYPORT="3000" The proxy port number to use to connect to the proxy server. Most proxy servers operate on port 1028 ( default), however, a proxy server can operate on other ports. This parameter is only available and required if the Proxy type parameter is set to SOCKS 4, SOCKS 4A, SOCKS 5, or HTTP.
Proxy username (optional) Text No (Empty) PROXYUSERNAME="username" The username to use to authenticate when connecting through the proxy server. This parameter is only available if Proxy type is set to SOCKS 5 or HTTP.
Proxy password (optional) Text No (Empty) PROXYPASSWORD="text (encrypted)" The password corresponding with the Proxy username parameter to use to authenticate when connecting through the proxy server. This parameter is encrypted in Task Builder. This parameter is only available if Proxy type is set to SOCKS 5 or HTTP.

Email

Property Type Required Default Markup Description
Create and populate dataset Text Yes (Empty) RESULTDATASET="mydataset" The name of the dataset to create and populate with the results of this activity.
Remove mail from server Yes/No No No REMOVEMESSAGE="yes" If selected, specifies that mail is permanently removed from the server. This parameter is disabled by default.
Save attachment(s) in folder Text No (Empty) ATTACHMENTDEST="c:\temp" If enabled, specifies the folder of where to save attachments. Click the folder icon to navigate to the desired save location where or manually enter the location in the provided text box.
If filename already exists Text (options) No Do not save
  • SAVEMODE="unique"
  • SAVEMODE="overwrite"
 Determines the action to perform if an attachment with the same name already exists in the destination folder. Determines the action to perform if an attachment with the same name already exists in the destination folder. This parameter is disabled if the Save attachment(s) in folder parameter is cleared. The available options are:
  • Do not save (default) - Does not save the archive file.
  • Save with unique file name - Saves the archive file with a unique file name.
  • Overwrite existing file - Overwrites existing archive file with the new file.

Filter

Property Type Required Default Markup Description
From Text No (Empty) FROM="me" Applies a filter to only retrieve messages containing the same "From" email address as specified in this parameter.
To Text No (Empty) TO="you" Applies a filter to only retrieve messages containing the same "To" email address as specified in this parameter.
Subject Text No (Empty) SUBJECT="Hello" Applies a filter to only retrieve messages containing the same words in the "Subject" field as specified in this parameter.
Body Text No (Empty) BODY="text2" Applies a filter to only retrieve messages containing the same words in the body of the message as specified in this parameter.
CC Text No (Empty) CC="text3" Applies a filter to only retrieve messages containing the same "Cc" email address as specified in this parameter.
Has attachments Text (options) No No
  • HASATTACHMENT="yes"
  • HASATTACHMENT="no"
 Determines how messages with attachments are filtered. The available options are:
  • Doesn't matter (default) - No filter is applied. Messages with or without attachments are not filtered.
  • Yes - Applies a filter to only retrieve messages with attachments.
  • No - Applies a filter to only retrieve messages without attachments.
Has been read Text (options) No No
  • HASBEENREAD="yes"
  • HASBEENREAD="no"
 Determines how messages that have been read are filtered. This parameter is disabled if the Protocol parameter is set to POP3. The available options are:
  • Doesn't matter (default) - No filter is applied. Read and unread messages are not filtered.
  • Yes - Applies a filter to only retrieve messages that have been read.
  • No - Applies a filter to only retrieve messages that have not been read.
Only if newer than Date No (Empty) IFNEWERTHAN="%DateSerial(2010,12,22)+TimeSerial(14,21,03)%" If selected, a filter is applied to only retrieve messages newer than the date/time specified. Click Custom to select from a list of custom date/time intervals. Select Expression to enter a specific date/time expression. This parameter is cleared by default.
Only if older than Date No (Empty) IFOLDERTHAN="%DateSerial(2010,12,22)+TimeSerial(14,21,03)%" If selected, a filter is applied to only retrieve messages older than the date/time specified. Click Custom to select from a list of custom date/time intervals. Select Expression to enter a specific date/time expression. This parameter is cleared by default.

Description

Error Causes

On Error

Additional notes

Well-known mailbox folders

Each user's mailbox folder has a set of properties that you can use to retrieve well-known folders, such as Inbox, Calendar, Drafts, and Tasks. Specifying a subfolder requires first specifying the name of the folder from the well-known folders level as the parent folder, followed by a / character as the delimiter, and then the subfolder name (for example, Inbox/SubFolderName). To specify a folder that you created in the well-known folders level, you must specify the root of the message folder hierarchy (for example, MsgFolderRoot/SubFolderName). The table below defines common folder names (in alphabetical order) that are used in users mailboxes.

Name Description
ArchiveDeletedItems The Deleted Items folder in the archive mailbox.
ArchiveMsgFolderRoot The root of the message folder hierarchy in the archive mailbox.
ArchiveRecoverableItemsDeletions The root of the folder hierarchy of recoverable items that have been soft-deleted from the Deleted Items folder of the archive mailbox.
ArchiveRecoverableItemsPurges The root of the hierarchy of recoverable items that have been hard-deleted from the Deleted Items folder of the archive mailbox.
ArchiveRecoverableItemsRoot The root of the Recoverable Items folder hierarchy in the archive mailbox.
ArchiveRecoverableItemsVersions The root of the Recoverable Items versions folder hierarchy in the archive mailbox.
ArchiveRoot The root of the folder hierarchy in the archive mailbox.
Calendar The Calendar folder.
Contacts The Contacts folder.
DeletedItems The Deleted Items folder.
Drafts The Drafts folder.
Inbox The Inbox folder.
Journal The Journal folder.
JunkEmail The Junk email folder.
MsgFolderRoot The root of the message folder hierarchy.
Notes The Notes folder.
Outbox The Outbox folder.
PublicFoldersRoot The root of the Public Folders hierarchy.
RecoverableItemsDeletions The root of the folder hierarchy of recoverable items that have been soft-deleted from the Deleted Items folder.
RecoverableItemsPurges The root of the folder hierarchy of recoverable items that have been hard-deleted from the Deleted Items folder.
RecoverableItemsRoot The root of the Recoverable Items folder hierarchy.
RecoverableItemsVersions The root of the Recoverable Items versions folder hierarchy in the archive mailbox.
Root The root of the mailbox.
SearchFolders The Search Folders folder, also known as the Finder folder.
SentItems The Sent Items folder.
Tasks The Tasks folder.
Voicemail The Voicemail folder.

Example

NOTE:
  • Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
  • To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.

Description

This sample task retrieves all messages from a POP3 email server, creates and populates a dataset with the results, and saves all attachments in a specified folder.

Copy 
<AMEMAIL ACTIVITY="all_messages" SERVER="mail.server.com" USERNAME="username" PASSWORD="AM54OLPWf5KfjEl9wTvTuDFSl57ufF43L4Tcjd/5xKrqIo=aME" TIMEOUT="30" SECURITY="explicit" TLSCIPHERS="All" TLSVERSIONS="Any" RESULTDATASET="theDataset" ATTACHMENTDEST="c:\temp" FROM="Admin" />