Codecore Logo
Quick Search
»
Advanced Search »

Email Sender (SMTP) Driver

RSS
This outgoing email driver supports sending email using SMTP (Simple Mail Transfer Protocol).

Manufacturer: N/A

Primary Communications Port: Network


Configuration Settings

  • Mail Server Host Name : The host name or IP address of the outgoing mail server (SMTP).
  • Mail Server Port : (optional) The port number of the outgoing mail server (SMTP). Default is 25.
  • Username : (optional) If a username and password are required, enter the username for authentication here.
  • Password : (optional) If a username and password are required, enter the password for authentication here.
  • From Email Address : The email address to put in the FROM: field of the email.
  • Use SSL (TLS/STARTTLS) : Place a check in the checkbox to indicate that Secure Socket Layer (SSL) should be used to encrypt the connection. This can also be called TLS or STARTTLS.

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.

Instance Properties

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

SendEmail ( String, String, String )

Sends an email.

Syntax

void SendEmail( String recipients, String subject, String body )

Parameters

recipients : A comma delimited list of email addresses to send the message to. Ex: jsmith@example.com
subject : The subject line for the message.
body : The message body.

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 )

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, 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.

Privacy Policy | Conditions Of Use

Copyright ©2014 Codecore Technologies, All rights reserved.