T_NChronicle_SMTP_Configuration_SmtpChronicleLibraryConfiguration

SmtpChronicleLibraryConfiguration Class

Container for SmtpChronicleLibrary configuration.

Inheritance Hierarchy

System.Object
  NChronicle.SMTP.Configuration.SmtpChronicleLibraryConfiguration
Namespace: NChronicle.SMTP.Configuration
Assembly: NChronicle.SMTP (in NChronicle.SMTP.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C#

public class SmtpChronicleLibraryConfiguration : IXmlSerializable

VB

Public Class SmtpChronicleLibraryConfiguration
	Implements IXmlSerializable

F#

type SmtpChronicleLibraryConfiguration =  
    class
        interface IXmlSerializable
    end

The SmtpChronicleLibraryConfiguration type exposes the following members.

Methods

 

	Name	Description
	AllowingRecurrences	Do not suppress the sending of emails for recurring chronicle records. The default is to suppress for 24 hours.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetSchema	Required for XML serialization, this method offers no functionality.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Ignoring(ChronicleLevel[])	Ignore records of the specified levels.
	Ignoring(String[])	Ignore records with at least one of the specified tags.
	ListeningTo(ChronicleLevel[])	Listen to records of the specified levels.
	ListeningTo(String[])	Listen to records with at least one of the specified tags.
	ListeningToAllLevels	Listen to records of all ChronicleLevels.
	ListeningToAllTags	Listen to all records regardless of their tags.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NotListening	Disable library - ignore records of all ChronicleLevels.
	NotUsingSsl	Set all emails to be sent via an insecure connection. Any certificates set for authentication, will be cleared.
	ReadXml	Populate configuration from XML via the specified XmlReader.
	SendingAsynchronously	Send emails asynchronously; allowing more than one to be sent at any given time. This may also result in memory usage and connection stacking, and suppresses exceptions but is much faster. This is default.
	SendingSynchronously	Send emails synchronously; forcing all emails to be sent one at a time, synchronously.
	SuppressingRecurrences()	Suppress the sending of emails for chronicle records that recur within 24 hours after. This is the default.
	SuppressingRecurrences(TimeSpan)	Suppress the sending of emails for chronicle records that recur within the specified maximumSuppressionTime after. The default is to suppress for 24 hours.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UsingNetworkMethod(String, Int32, Boolean)	Set all emails to be sent via a network connection to an SMTP server.
	UsingNetworkMethod(String, Int32, X509Certificate[])	Set all emails to be sent via a network connection to an SMTP server.
	UsingNetworkMethod(String, Int32, String, SecureString, Boolean)	Set all emails to be sent via a network connection to an SMTP server.
	UsingNetworkMethod(String, Int32, String, SecureString, X509Certificate[])	Set all emails to be sent via a network connection to an SMTP server.
	UsingNetworkMethod(String, Int32, String, String, Boolean)	Set all emails to be sent via a network connection to an SMTP server.
	UsingNetworkMethod(String, Int32, String, String, X509Certificate[])	Set all emails to be sent via a network connection to an SMTP server.
	UsingNetworkMethod(String, Int32, String, SecureString, String, Boolean)	Set all emails to be sent via a network connection to an SMTP server.
	UsingNetworkMethod(String, Int32, String, SecureString, String, X509Certificate[])	Set all emails to be sent via a network connection to an SMTP server.
	UsingNetworkMethod(String, Int32, String, String, String, Boolean)	Set all emails to be sent via a network connection to an SMTP server.
	UsingNetworkMethod(String, Int32, String, String, String, X509Certificate[])	Set all emails to be sent via a network connection to an SMTP server.
	UsingPickupDirectoryMethod()	Set all emails to be sent via copying them into the directory used by IIS for delivery by an external application. Requires SMTP Service to be installed.
	UsingPickupDirectoryMethod(String, Boolean)	Set all emails to be sent via copying them into an pickupDirectory for delivery by an external application.
	UsingSsl	Set all emails to be sent via a secure SSL connection. This applies only whilst using the Network method, and is enabled by default.
	WithBody	Specify the HTML email body in which records are sent.
	WithBodyFromFile	Specify from the specified file path the HTML email body in which records are sent.
	WithCredentials(X509Certificate[])	Set certificate(s) to use to authenticate the sender when sending emails. This applies only whilst using the Network method, and automatically sets all emails to be sent via a secure SSL connection. This is not persisted when writing the SmtpChronicleLibrary to XML.
	WithCredentials(String, SecureString, String)	Set the credentials to use to authenticate the sender when sending emails. This applies only whilst using the Network method.
	WithCredentials(String, String, String)	Set the credentials to use to authenticate the sender when sending emails. This applies only whilst using the Network method.
	WithCriticalMailPriority	Mark all emails for Critical level records with the specified priority. The default is High.
	WithDebugMailPriority	Mark all emails for Debug level records with the specified priority. The default is Low.
	WithInfoMailPriority	Mark all emails for Info level records with the specified priority. The default is Normal.
	WithLocalTime	Set all dates in the output to be rendered in the environments local time zone.
	WithNoRecipients	Clear all recipients (no email is sent).
	WithRecipients(MailAddress[])	Set the recipients to which records are emailed. The default is no recipients (no email is sent).
	WithRecipients(String[])	Set the recipients to which records are emailed. The default is no recipients (no email is sent).
	WithSender(MailAddress)	Set the fromAddress from which records are emailed. The default is no from address (no email is sent).
	WithSender(String, String)	Set the senderAddress from which records are emailed. The default is no from address (no email is sent).
	WithSilentTimeout	Set the time to wait in milliseconds before sending an email times out, and suppress exceptions from those time outs (only effects synchronous sending, asynchronous sending will always suppress exceptions). This applies only whilst using the Network method, and the default is 100,000 milliseconds (100 seconds).
	WithSubjectLine	Specify the email subject line with which records are sent.
	WithSuccessMailPriority	Mark all emails for Success level records with the specified priority. The default is Normal.
	WithTimeout	Set the time to wait in milliseconds before sending an email times out. This applies only whilst using the Network method, and the default is 100,000 milliseconds (100 seconds).
	WithTimeZone	Set all dates in the output to be rendered in the specified timeZone.
	WithUtcTime	Set all dates in the output to be rendered in UTC+0.
	WithWarningMailPriority	Mark all emails for Warning level records with the specified priority. The default is Normal.
	WriteXml	Write configuration to XML via the specified XmlWriter.

  Back to Top

See Also

Reference

NChronicle.SMTP.Configuration Namespace