Skip to content

14925824 a997 2bdd 0765 5e807f8986d6

Axel Kesseler edited this page Mar 1, 2023 · 4 revisions

MailLoggerSettings Class

The class to provide settings for all of the mail logging writers.

Inheritance Hierarchy

System.Object
  Plexdata.LogWriter.Settings.LoggerSettings
    Plexdata.LogWriter.Settings.MailLoggerSettings
Namespace: Plexdata.LogWriter.Settings
Assembly: Plexdata.LogWriter.Mail (in Plexdata.LogWriter.Mail.dll) Version: 1.0.7.1

Syntax

C#

public class MailLoggerSettings : LoggerSettings, 
	IMailLoggerSettings, ILoggerSettings, INotifyPropertyChanged

The MailLoggerSettings type exposes the following members.

Constructors

 

Name Description
Private methodStatic member MailLoggerSettings The static class constructor.
Public method MailLoggerSettings() The standard class constructor.
Public method MailLoggerSettings(ILoggerSettingsSection) The extended constructor that initializes all properties from provided configuration instance.
  Back to Top

Properties

 

Name Description
Public property Address Gets and sets the sender e-mail address.
Public property BlindCopies Gets and sets the list of copy e-mail recipients.
Public property ClearCopies Gets and sets the list of copy e-mail recipients.
Public property Culture Gets and sets the culture information to be used. (Inherited from LoggerSettings.)
Public property Encoding Gets or sets the used mail encoding.
Public property FullName Determines whether the full name is used in messages or not. (Inherited from LoggerSettings.)
Public property LogLevel Gets and sets the logging level to be used. (Inherited from LoggerSettings.)
Public property LogTime Gets and sets the type of time to be used. (Inherited from LoggerSettings.)
Public property LogType Gets and sets the output format to be used. (Inherited from LoggerSettings.)
Public property PartSplit Gets and sets the character to separate each of the message parts. (Inherited from LoggerSettings.)
Public property Password Gets and sets the e-mail account password.
Public property Receivers Gets and sets the list of main e-mail recipients.
Public property ShowKey Determines whether the message key is shown or not. (Inherited from LoggerSettings.)
Public property ShowTime Determines whether the message timestamp is shown or not. (Inherited from LoggerSettings.)
Public property SmtpHost Gets and sets the SMTP host name.
Public property SmtpPort Gets and sets the SMTP port name.
Public property Subject Gets or sets the used mail subject.
Public property TimeFormat Gets and sets the time format to be used. (Inherited from LoggerSettings.)
Public property Username Gets and sets the e-mail account username.
Public property UseSsl Determines whether the usage of SSL is enabled or not.
  Back to Top

Methods

 

Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Protected method GetSectionValues Gets the values from section for provided key. (Inherited from LoggerSettings.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method GetValue(TType) Gets the type-safe value of provided value. (Inherited from LoggerSettings.)
Private method IsValidCultureName Checks if value is a valid culture name. (Inherited from LoggerSettings.)
Protected method LoadSettings The method loads all settings from provided configuration and initializes all properties accordingly. (Overrides LoggerSettings.LoadSettings(ILoggerSettingsSection).)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method RaisePropertyChanged Informs listeners about property changes. (Inherited from LoggerSettings.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
  Back to Top

Events

 

Name Description
Public event PropertyChanged Occurs when a property value changes. (Inherited from LoggerSettings.)
  Back to Top

Fields

 

Name Description
Private field address This field holds the chosen address.
Private field blindCopies This field holds the chosen blind copies list.
Private field clearCopies This field holds the chosen clear copies list.
Private field culture This field represents currently assigned culture. (Inherited from LoggerSettings.)
Private fieldStatic member DefaultAddress The default address value.
Private fieldStatic member DefaultBlindCopies The default blind copies value.
Private fieldStatic member DefaultClearCopies The default clear copies value.
Private fieldStatic member DefaultEncoding The default encoding value.
Private fieldStatic member DefaultPassword The default password value.
Private fieldStatic member DefaultReceivers The default receivers value.
Private fieldStatic member DefaultSmtpHost The default SMTP host value.
Private fieldStatic member DefaultSmtpPort The default SMTP port value.
Private fieldStatic member DefaultSubject The default subject value.
Private fieldStatic member DefaultUsername The default username value.
Private fieldStatic member DefaultUseSsl The default value of SSL usage.
Private field encoding This field holds the chosen encoding.
Private field fullName This field represents current state of full name usage. (Inherited from LoggerSettings.)
Private field logLevel This field represents current logging level. (Inherited from LoggerSettings.)
Private field logTime This field represents current logging time. (Inherited from LoggerSettings.)
Private field logType This field represents current logging type. (Inherited from LoggerSettings.)
Private field partSplit This field represents current part split character. (Inherited from LoggerSettings.)
Private field password This field holds the chosen password.
Private field receivers This field holds the chosen receivers list.
Private field showKey This field represents current state of key visibility. (Inherited from LoggerSettings.)
Private field showTime This field represents current state of time stamp visibility. (Inherited from LoggerSettings.)
Private field smtpHost This field holds the chosen SMTP host.
Private field smtpPort This field holds the chosen SMTP port.
Private field subject This field holds the chosen subject.
Private field timeFormat This field represents current time stamp format. (Inherited from LoggerSettings.)
Private field username This field holds the chosen username.
Private field useSsl This field holds the chosen SSL enabled state.
  Back to Top

Remarks

This class allows a configuration of classes derived from mail logger interfaces. But keep in mind, the availability of particular setting items depends of which of the available mail loggers is actually used.

Attention, logging type RAW is used as the default logging type.

See Also

Reference

Plexdata.LogWriter.Settings Namespace

Clone this wiki locally