Click or drag to resize

OutputEmailDevice Class

OutputEmailDevice is an implementation of a SMTP Server device to send report result by emails.
Inheritance Hierarchy
SystemObject
  Seal.ModelRootEditor
    Seal.ModelRootComponent
      Seal.ModelOutputDevice
        Seal.ModelOutputEmailDevice

Namespace: Seal.Model
Assembly: SealLibrary (in SealLibrary.dll) Version: 8.1.0.0+4fe7975a95558d7cdf0d4c425e2c3a22827d67dd
Syntax
C#
public class OutputEmailDevice : OutputDevice

The OutputEmailDevice type exposes the following members.

Constructors
 NameDescription
Public methodOutputEmailDeviceInitializes a new instance of the OutputEmailDevice class
Top
Properties
 NameDescription
Public propertyChangeSender If true, the Email Sender or Reply address can be changed in the Report Designer or the Web Report Designer
Public propertyClearPassword The clear password used to connect to the SMTP server
Public propertyClearSendGridKey The clear API Key used for SendGrid. An API Key can be get from https://sendgrid.com/ after registration (Free plan).
Public propertyDeliveryMethod Specifies how outgoing email messages will be handled
Public propertyEnableSsl If true, the client uses Secure Socket Layer
Public propertyError Last error message
Public propertyFullName Full name
(Overrides OutputDeviceFullName)
Public propertyGUID The unique identifier
(Inherited from RootComponent)
Public propertyHelperTestEmail Editor Helper: Send a test email with the current configuration
Public propertyInformation Last information message
Public propertyName The name
(Inherited from RootComponent)
Public propertyPassword The password
Public propertyPort SMTP Port used to connect to the server
Public propertyReplyTo The reply addresses used for the email
Public propertySenderEmail The sender email address used to send the email
Public propertySendGridKey The API Key for SendGrid
Public propertyServer SMTP Email Server name
Public propertySmtpClient Current SmtpClient
Public propertyTestEmailTo The destination email address used to send the test email
Public propertyTimeout Amount of time in milli-seconds after which the email is not sent
Public propertyUseDefaultCredentials If true, the default credentials are used
Public propertyUsedForNotification If true, this email device will be chosen first to be used for notifications. (e.g. sending an email in case of error in a schedule)
Public propertyUserName The user name used to connect to the SMTP server
Public propertyUseSendGrid If true, the SendGrid client is used instead of the SMTP client
Top
Methods
 NameDescription
Public methodStatic memberCreate Create a basic OutputEmailDevice
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodHandleZipOptions Handle the Output ZIP Options: Create a zip file if necessary
(Inherited from OutputDevice)
Public methodInit Init the editor objects
(Inherited from RootEditor)
Public methodInitDefaultValues Init the default values
(Inherited from RootEditor)
Public methodInitEditor Init the editor objects and the default values
(Inherited from RootEditor)
Public methodStatic memberLoadFromFile Load an OutputEmailDevice from a file
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodProcess Send the report result by email using the device configuration
(Overrides OutputDeviceProcess(Report))
Public methodSaveToFile Save to current file
(Overrides OutputDeviceSaveToFile)
Public methodSaveToFile(String) Save to a file
(Overrides OutputDeviceSaveToFile(String))
Public methodSendEmail(String, String, String, Boolean, String) Send an Email either through SMTP or SendGrid
Public methodSendEmail(String, String, String, String, String, String, Boolean, String, String, String) Send an Email either through SMTP or SendGrid
Public methodSendTestEmail Helper to send a test email
Public methodSetReadOnly Set all properties to readonly
(Inherited from RootEditor)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodUpdateEditor Update editor attributes
(Inherited from RootEditor)
Protected methodUpdateEditorAttributes Refresh properties attrivutes
(Inherited from RootEditor)
Public methodValidate Validate the device
(Overrides OutputDeviceValidate)
Top
Fields
 NameDescription
Protected field_dctd
(Inherited from RootEditor)
Protected field_GUID
(Inherited from RootComponent)
Protected field_name
(Inherited from RootComponent)
Public fieldFilePath Current file path
(Inherited from OutputDevice)
Public fieldLastModification Last modification date time
Public fieldStatic memberPasswordKeyName 
Public fieldStatic memberPasswordKeyValue 
Public fieldStatic memberSendGridKeyName 
Public fieldStatic memberSendGridKeyValue 
Top
See Also