Email Receiver (POP3) Driver

RSS

This POP3 (Post Office Protocol 3) driver can provides access to an email inbox.

Manufacturer: N/A

Primary Communications Port: Network

Table of Contents [Hide/Show]

Configuration Settings
Events
   Ready State Changed
   Received Email
Instance Properties
   EmailCount
   LastRetrievalAttempt
   LastSuccessfullRetrieval
   DeviceDisplayName
   DeviceStartTime
   DeviceLifecycleStage
   DeviceIsRunningAndReady
Instance Methods
   RetrieveNewEmailNow
   GetEmail ( String, String )
   DeleteEmail ( String )
   SetPropertyForDuration ( String, TimeSpan, Object, Object )
   SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )

Configuration Settings

Host Name : The host name or IP address of the POP3 server.
Port : (optional) The port number of the POP3 server. Default is 110 for non-SSL, and 995 for SSL.
Username : The user name of the email box.
Password : The password for the specified user name.
Use SSL : (optional) Place a check in the checkbox to indicate that Secure Socket Layer (SSL) should be used to encrypt the connection. If this is set, then the default port used will be 995, unless a different port is specified.
Retrieve Email Interval : (optional) The time duration between attempting to retrieve new email. Format: [days.]hours:minutes[:seconds] Days and seconds are optional, denoted by the square brackets. Example: 00:01:30 represents 1 minute and 30 seconds. Defaults to 1 minute.

Events

Ready State Changed

The device's running and ready state changed.

Whenever Filter:

none

EventArgs:

Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Received Email

Occurs after a new email has received.

Whenever Filter:

MessageContains : (optional) The message body must contain the specified text (case-insensitive).
SubjectContains : (optional) The subject must contain the specified text (case-insensitive).
SubjectEquals : (optional) The subject must match the specified text exactly (case-insensitive).
From : (optional) The email must be from the specified sender email address (case-insensitive).

EventArgs:

String From : The from email address.
Boolean IsMessageHtml : A value indicating if the message body is in html syntax.
String To : The recipient email address.
String CC : The carbon copy (CC) recipient email addresses
String BCC : The blind carbon copy (BCC) recipient email addresses.
String Subject : The email subject.
DateTime DeliveryDate : The delivery date.
String Message : The message body.
String MessageID : The unique message identifier

Instance Properties

EmailCount

Gets the total number of emails in the mailbox.

Accessibility : Read Only

Type: Number

LastRetrievalAttempt

Gets the date and time of the last email retrieval attempt.

Accessibility : Read Only

Type: DateTime

LastSuccessfullRetrieval

Gets the date and time of the last successful email retrieval attempt.

Accessibility : Read Only

Type: DateTime

DeviceDisplayName

The display name for this device.

Accessibility : Read Only

Type: String

DeviceStartTime

The date and time when this device was started.

Accessibility : Read Only

Type: DateTime

DeviceLifecycleStage

The current lifecycle stage of the device. The stages in order are: Pending Start, Starting, Running, Stopping

Accessibility : Read Only

Type: Number

DeviceIsRunningAndReady

Indicates if the device is ready for use, ie it is in the Running lifecycle stage and all properties are valid and all methods are ready to be used.

Accessibility : Read Only

Type: Boolean

Instance Methods

RetrieveNewEmailNow

Forces the driver to attempt to retrieve new email now.

Syntax

void RetrieveNewEmailNow( )

Parameters

none

GetEmail ( String, String )

Get's an email and returns a string in the specified format.

Syntax

String GetEmail( String messageID, String format )

Parameters

messageID : The message id of the email to get.

format : The format of the return result. The format string can contain the following macros: {From} {Date} {To} {CC} {BCC} {Subject} {Message}

DeleteEmail ( String )

Delete's an email.

Syntax

void DeleteEmail( String messageID )

Parameters

messageID : The message id of the email to delete.

SetPropertyForDuration ( String, TimeSpan, Object, Object )

Sets a property for a duration of time and then sets the property to a subequent value asynchronously. This action returns after setting the first value and the timer and subsequent property set run in the background. Subsequent sets of the same property will reset the timer if the subsequent value has not yet been set. This is an advanced feature, be sure to set the property name correctly.

Syntax

void SetPropertyForDuration( String propertyName, unknown duration, Object initialValue, Object finalValue )

Parameters

propertyName : The name of the property to set.

duration : The amount of time to wait after setting the initial value to set the subsequent value.

initialValue : The value to set the property to initially.

finalValue : The value to set the property to after the duration of time has passed.

SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )

void SetPropertyForDuration( String propertyName, Number arrayIndex, unknown duration, Object initialValue, Object finalValue )

Parameters

propertyName : The name of the property to set.

arrayIndex : The property's array index to set.

duration : The amount of time to wait after setting the initial value to set the subsequent value.

initialValue : The value to set the property to initially.

finalValue : The value to set the property to after the duration of time has passed.