SmtpAppender ClassApache log4net™ SDK Documentation
Send an e-mail when a specific logging event occurs, typically on errors or fatal errors.
Inheritance Hierarchy

SystemObject
  log4net.AppenderAppenderSkeleton
    log4net.AppenderBufferingAppenderSkeleton
      log4net.AppenderSmtpAppender

Namespace: log4net.Appender
Assembly: log4net (in log4net.dll) Version: 2.0.6.0-.NET 4.0
Syntax

public class SmtpAppender : BufferingAppenderSkeleton

The SmtpAppender type exposes the following members.

Constructors

  NameDescription
Public methodSmtpAppender
Default constructor
Top
Properties

  NameDescription
Public propertyAuthentication
The mode to use to authentication with the SMTP server
Public propertyBcc
Gets or sets a semicolon-delimited list of recipient e-mail addresses that will be blind carbon copied.
Public propertyBodyEncoding
Gets or sets the body encoding to be used.
Public propertyBufferSize
Gets or sets the size of the cyclic buffer used to hold the logging events.
(Inherited from BufferingAppenderSkeleton.)
Public propertyCc
Gets or sets a comma- or semicolon-delimited list of recipient e-mail addresses that will be carbon copied (use semicolon on .NET 1.1 and comma for later versions).
Public propertyEnableSsl
Enable or disable use of SSL when sending e-mail message
Public propertyErrorHandler
Gets or sets the IErrorHandler for this appender.
(Inherited from AppenderSkeleton.)
Public propertyEvaluator
Gets or sets the ITriggeringEventEvaluator that causes the buffer to be sent immediately.
(Inherited from BufferingAppenderSkeleton.)
Public propertyFilterHead
The filter chain.
(Inherited from AppenderSkeleton.)
Public propertyFix
Gets or sets a the fields that will be fixed in the event
(Inherited from BufferingAppenderSkeleton.)
Public propertyFrom
Gets or sets the e-mail address of the sender.
Public propertyLayout
Gets or sets the ILayout for this appender.
(Inherited from AppenderSkeleton.)
Public propertyLocationInfo Obsolete.
Obsolete
Public propertyLossy
Gets or sets a value that indicates whether the appender is lossy.
(Inherited from BufferingAppenderSkeleton.)
Public propertyLossyEvaluator
Gets or sets the value of the ITriggeringEventEvaluator to use.
(Inherited from BufferingAppenderSkeleton.)
Public propertyName
Gets or sets the name of this appender.
(Inherited from AppenderSkeleton.)
Public propertyOnlyFixPartialEventData Obsolete.
Gets or sets a value indicating if only part of the logging event data should be fixed.
(Inherited from BufferingAppenderSkeleton.)
Public propertyPassword
The password to use to authenticate with the SMTP server
Public propertyPort
The port on which the SMTP server is listening
Public propertyPriority
Gets or sets the priority of the e-mail message
Public propertyReplyTo
Gets or sets the reply-to e-mail address.
Protected propertyRequiresLayout
This appender requires a log4net.Layout to be set.
(Overrides AppenderSkeletonRequiresLayout.)
Public propertySmtpHost
Gets or sets the name of the SMTP relay mail server to use to send the e-mail messages.
Public propertySubject
Gets or sets the subject line of the e-mail message.
Public propertySubjectEncoding
Gets or sets the subject encoding to be used.
Public propertyThreshold
Gets or sets the threshold Level of this appender.
(Inherited from AppenderSkeleton.)
Public propertyTo
Gets or sets a comma- or semicolon-delimited list of recipient e-mail addresses (use semicolon on .NET 1.1 and comma for later versions).
Public propertyUsername
The username to use to authenticate with the SMTP server
Top
Methods

  NameDescription
Public methodActivateOptions
Initialize the appender based on the options set
(Inherited from BufferingAppenderSkeleton.)
Public methodAddFilter
Adds a filter to the end of the filter chain.
(Inherited from AppenderSkeleton.)
Protected methodAppend(LoggingEvent)
Append a bulk array of logging events.
(Inherited from AppenderSkeleton.)
Protected methodAppend(LoggingEvent)
This method is called by the DoAppend(LoggingEvent) method.
(Inherited from BufferingAppenderSkeleton.)
Public methodClearFilters
Clears the filter list for this appender.
(Inherited from AppenderSkeleton.)
Public methodClose
Closes the appender and release resources.
(Inherited from AppenderSkeleton.)
Public methodDoAppend(LoggingEvent)
Performs threshold checks and invokes filters before delegating actual logging to the subclasses specific [M:Append(LoggingEvent)] method.
(Inherited from AppenderSkeleton.)
Public methodDoAppend(LoggingEvent)
Performs threshold checks and invokes filters before delegating actual logging to the subclasses specific [M:Append(LoggingEvent[])] method.
(Inherited from AppenderSkeleton.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFilterEvent
Test if the logging event should we output by this appender
(Inherited from AppenderSkeleton.)
Protected methodFinalize
Finalizes this appender by calling the implementation's Close method.
(Inherited from AppenderSkeleton.)
Public methodFlush
Flush the currently buffered events
(Inherited from BufferingAppenderSkeleton.)
Public methodFlush(Boolean)
Flush the currently buffered events
(Inherited from BufferingAppenderSkeleton.)
Public methodFlush(Int32)
Flushes any buffered log data.
(Inherited from BufferingAppenderSkeleton.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodIsAsSevereAsThreshold
Checks if the message level is below this appender's threshold.
(Inherited from AppenderSkeleton.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnClose
Close this appender instance.
(Inherited from BufferingAppenderSkeleton.)
Protected methodPreAppendCheck
Called before [M:Append(LoggingEvent)] as a precondition.
(Inherited from AppenderSkeleton.)
Protected methodRenderLoggingEvent(LoggingEvent)
Renders the LoggingEvent to a string.
(Inherited from AppenderSkeleton.)
Protected methodRenderLoggingEvent(TextWriter, LoggingEvent)
Renders the LoggingEvent to a string.
(Inherited from AppenderSkeleton.)
Protected methodSendBuffer
Sends the contents of the cyclic buffer as an e-mail message.
(Overrides BufferingAppenderSkeletonSendBuffer(LoggingEvent).)
Protected methodSendEmail
Send the email message
Protected methodSendFromBuffer
Sends the contents of the buffer.
(Inherited from BufferingAppenderSkeleton.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Top
Remarks

The number of logging events delivered in this e-mail depend on the value of BufferSize option. The SmtpAppender keeps only the last BufferSize logging events in its cyclic buffer. This keeps memory requirements at a reasonable level while still delivering useful application context.

Caution note Caution
Authentication and setting the server Port are only available on the MS .NET 1.1 runtime. For these features to be enabled you need to ensure that you are using a version of the log4net assembly that is built against the MS .NET 1.1 framework and that you are running the your application on the MS .NET 1.1 runtime. On all other platforms only sending unauthenticated messages to a server listening on port 25 (the default) is supported.

Authentication is supported by setting the Authentication property to either Basic or Ntlm. If using Basic authentication then the Username and Password properties must also be set.

To set the SMTP server port use the Port property. The default port is 25.

See Also

Reference