Click or drag to resize

EmailerSection Class

This class adds a custom section to the App.Config/Web.Config files labeled
Inheritance Hierarchy

Namespace:  Koden.Utils.Emailer.ConfigFileSections
Assembly:  Koden.Utils.Emailer (in Koden.Utils.Emailer.dll) Version: 1.0.6453.26061
Syntax
Copy
public class EmailerSection : ConfigurationSection

The EmailerSection type exposes the following members.

Constructors
  NameDescription
Public methodEmailerSection
Initializes a new instance of the EmailerSection class
Top
Properties
  NameDescription
Public propertyCurrentConfiguration
Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to.
(Inherited from ConfigurationElement.)
Public propertyDebugMsg
Gets or sets the debug MSG.
Public propertyElementInformation
Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object.
(Inherited from ConfigurationElement.)
Protected propertyElementProperty
Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself.
(Inherited from ConfigurationElement.)
Protected propertyEvaluationContext
Gets the ContextInformation object for the ConfigurationElement object.
(Inherited from ConfigurationElement.)
Public propertyFailureMsg
Gets or sets the failure MSG.
Protected propertyHasContext
Gets a value that indicates whether the CurrentConfiguration property is null.
(Inherited from ConfigurationElement.)
Protected propertyItemConfigurationProperty
Gets or sets a property or attribute of this configuration element.
(Inherited from ConfigurationElement.)
Protected propertyItemString
Gets or sets a property, attribute, or child element of this configuration element.
(Inherited from ConfigurationElement.)
Public propertyLockAllAttributesExcept
Gets the collection of locked attributes.
(Inherited from ConfigurationElement.)
Public propertyLockAllElementsExcept
Gets the collection of locked elements.
(Inherited from ConfigurationElement.)
Public propertyLockAttributes
Gets the collection of locked attributes
(Inherited from ConfigurationElement.)
Public propertyLockElements
Gets the collection of locked elements.
(Inherited from ConfigurationElement.)
Public propertyLockItem
Gets or sets a value indicating whether the element is locked.
(Inherited from ConfigurationElement.)
Protected propertyProperties
Gets the collection of properties.
(Inherited from ConfigurationElement.)
Public propertySectionInformation
Gets a SectionInformation object that contains the non-customizable information and functionality of the ConfigurationSection object.
(Inherited from ConfigurationSection.)
Public propertySMTPServer
Gets or sets the SMTP server.
Public propertySuccessMsg
Gets or sets the success MSG.
Top
Methods
  NameDescription
Protected methodDeserializeElement
Reads XML from the configuration file.
(Inherited from ConfigurationElement.)
Protected methodDeserializeSection
Reads XML from the configuration file.
(Inherited from ConfigurationSection.)
Public methodEquals
Compares the current ConfigurationElement instance to the specified object.
(Inherited from ConfigurationElement.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Gets a unique value representing the current ConfigurationElement instance.
(Inherited from ConfigurationElement.)
Protected methodGetRuntimeObject
Returns a custom object when overridden in a derived class.
(Inherited from ConfigurationSection.)
Protected methodGetTransformedAssemblyString
Returns the transformed version of the specified assembly name.
(Inherited from ConfigurationElement.)
Protected methodGetTransformedTypeString
Returns the transformed version of the specified type name.
(Inherited from ConfigurationElement.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodInit
Sets the ConfigurationElement object to its initial state.
(Inherited from ConfigurationElement.)
Protected methodInitializeDefault
Used to initialize a default set of values for the ConfigurationElement object.
(Inherited from ConfigurationElement.)
Protected methodIsModified
Indicates whether this configuration element has been modified since it was last saved or loaded when implemented in a derived class.
(Inherited from ConfigurationSection.)
Public methodIsReadOnly
Gets a value indicating whether the ConfigurationElement object is read-only.
(Inherited from ConfigurationElement.)
Protected methodListErrors
Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list.
(Inherited from ConfigurationElement.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnDeserializeUnrecognizedAttribute
Gets a value indicating whether an unknown attribute is encountered during deserialization.
(Inherited from ConfigurationElement.)
Protected methodOnDeserializeUnrecognizedElement
Gets a value indicating whether an unknown element is encountered during deserialization.
(Inherited from ConfigurationElement.)
Protected methodOnRequiredPropertyNotFound
Throws an exception when a required property is not found.
(Inherited from ConfigurationElement.)
Protected methodPostDeserialize
Called after deserialization.
(Inherited from ConfigurationElement.)
Protected methodPreSerialize
Called before serialization.
(Inherited from ConfigurationElement.)
Protected methodReset
Resets the internal state of the ConfigurationElement object, including the locks and the properties collections.
(Inherited from ConfigurationElement.)
Protected methodResetModified
Resets the value of the IsModified method to false when implemented in a derived class.
(Inherited from ConfigurationSection.)
Protected methodSerializeElement
Writes the contents of this configuration element to the configuration file when implemented in a derived class.
(Inherited from ConfigurationElement.)
Protected methodSerializeSection
Creates an XML string containing an unmerged view of the ConfigurationSection object as a single section to write to a file.
(Inherited from ConfigurationSection.)
Protected methodSerializeToXmlElement
Writes the outer tags of this configuration element to the configuration file when implemented in a derived class.
(Inherited from ConfigurationElement.)
Protected methodSetPropertyValue
Sets a property to the specified value.
(Inherited from ConfigurationElement.)
Protected methodSetReadOnly
Sets the IsReadOnly property for the ConfigurationElement object and all subelements.
(Inherited from ConfigurationElement.)
Protected methodShouldSerializeElementInTargetVersion
Indicates whether the specified element should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework.
(Inherited from ConfigurationSection.)
Protected methodShouldSerializePropertyInTargetVersion
Indicates whether the specified property should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework.
(Inherited from ConfigurationSection.)
Protected methodShouldSerializeSectionInTargetVersion
Indicates whether the current ConfigurationSection instance should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework.
(Inherited from ConfigurationSection.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodUnmerge
Modifies the ConfigurationElement object to remove all values that should not be saved.
(Inherited from ConfigurationElement.)
Top
Examples
This is an example of an App.Config file:
Copy
<configuration>
  <configSections>
    <sectionGroup name="KodenGroup">
      <section name="Email" type=" Koden.Utils.ConfigFileSections.EmailzSection,Koden.Utils" allowLocation="true" allowDefinition="Everywhere" />
    </sectionGroup>
  </configSections>
    <startup> 
        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5" />
    </startup>
  <KodenGroup>
    <Email>
      <SMTPServer hostname="smtp.fmgllc.com" />
      <DebugMsg enabled="false" from="_ETLNotify@fmgllc.com" to="developer@fmgllc.com" attachLog="true" />
      <SuccessMsg enabled="true" from="_ETLNotify@fmgllc.com" to="someone@fmgllc.com;someoneelse@fmgllc.com" attachLog="false" />
      <FailureMsg enabled="true" from="_ETLNotify@fmgllc.com" to="_ETLNotify@fmgllc.com" cc="somone@fmgllc.com" attachLog="true" />
    </Email>
   </KodenGroup>
</configuration>
See Also