XenoGuard 4.0 Documentation

Receive

ActionStep Reference » Windows » Network » EMAIL » Receive

The Email Receive ActionStep retrieves unread or new email messages from your email account using the Internet Message Access Protocol (IMAP).

[+] How to add the Receive ActionStep to the ActionScript:

[-] Hide

Open the Windows node in the Workspace Explorer.
Open the Network node.
In the EMAIL node, select the Receive ActionStep.

Parameters:

The ActionStep has the following input parameters:

name	Description
Server	The mail server to use. Allowed Context Scopes [Fixed, Local, Global, Reference] Allowed Context Types [Fixed, Variable, Parameter, Result, Enum] Allowed Context Values [String]
Username	The username of your mail server account. Allowed Context Scopes [Fixed, Local, Global, Reference] Allowed Context Types [Fixed, Variable, Parameter, Result, Enum] Allowed Context Values [String]
Password	The password of your mail server account. Allowed Context Scopes [Fixed, Local, Global, Reference] Allowed Context Types [Fixed, Variable, Parameter, Result, Enum] Allowed Context Values [String]
Port	The mail server port. Allowed Context Scopes [Fixed, Local, Global, Reference] Allowed Context Types [Fixed, Variable, Parameter, Result, Enum] Allowed Context Values [Int64]
SSL Connection	Enable or disable SSL connection. Allowed Context Scopes [Fixed, Local, Global, Reference] Allowed Context Types [Fixed, Variable, Parameter, Result, Enum] Allowed Context Values [Boolean]

	Allowed Context Scopes [Fixed, Local, Global] Allowed Context Types [Variable, Parameter, Enum] All other values of the parameters are determined by the specified format.

Results:

The ActionStep returns the following results:

name	description
	The id that identifies the Inbox. Allowed Context Scopes [Fixed, Local, Global] Allowed Data Type [Variable, Parameter]
Mail Count	The number of emails received. Allowed Context Scopes [Fixed, Local, Global] Allowed Data Type [Variable, Parameter]
Emails	The received email from the sender. Parameters of the Row sub-branch: Mail Id - the id of the sent email Sender - the email address of the sender Subject - the reason for sending the email Content- the content of the email Date Sent - the date when the email was sent Has Attachment - indicates whether the email contains an attachment Allowed Context Scope [Fixed] Allowed Context Types [Variable, Parameter]

name

description

The id that identifies the Inbox.

Allowed Context Scopes [Fixed, Local, Global]
Allowed Data Type [Variable, Parameter]

Mail Count

The number of emails received.

Allowed Context Scopes [Fixed, Local, Global]
Allowed Data Type [Variable, Parameter]

Emails

The received email from the sender.

Parameters of the Row sub-branch:

Mail Id - the id of the sent email
Sender - the email address of the sender
Subject - the reason for sending the email
Content- the content of the email
Date Sent - the date when the email was sent
Has Attachment - indicates whether the email contains an attachment

Allowed Context Scope [Fixed]
Allowed Context Types [Variable, Parameter]

Example 1 (Get incoming messages of the Inbox):

This example retrieves email messages using the Internet Message Access Protocol (IMAP) from an email account. If the Mail Count parameter is equal to zero, it waits for 5000 milliseconds and returns to check for incoming email messages. Otherwise, the email list is then iterated and the details of each email are displayed in Message Box.

See other EMAIL operations:

Send
Get Attachment