blob: 3c81928755bb458d181e0165b6660bd4856d5861 [file] [log] [blame]
<html><head><meta http-equiv="X-UA-Compatible" content="IE=edge" /><link rel="shortcut icon" href="../icons/favicon.ico" /><style type="text/css">.OH_CodeSnippetContainerTabLeftActive, .OH_CodeSnippetContainerTabLeft,.OH_CodeSnippetContainerTabLeftDisabled { }.OH_CodeSnippetContainerTabRightActive, .OH_CodeSnippetContainerTabRight,.OH_CodeSnippetContainerTabRightDisabled { }.OH_footer { }</style><link rel="stylesheet" type="text/css" href="../styles/branding.css" /><link rel="stylesheet" type="text/css" href="../styles/branding-en-US.css" /><script type="text/javascript" src="../scripts/branding.js"> </script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>SmtpAppender Class</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="SmtpAppender class" /><meta name="System.Keywords" content="log4net.Appender.SmtpAppender class" /><meta name="System.Keywords" content="SmtpAppender class, about SmtpAppender class" /><meta name="Microsoft.Help.F1" content="log4net.Appender.SmtpAppender" /><meta name="Microsoft.Help.Id" content="T:log4net.Appender.SmtpAppender" /><meta name="Description" content="Send an e-mail when a specific logging event occurs, typically on errors or fatal errors." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="log4net.Appender" /><meta name="file" content="T_log4net_Appender_SmtpAppender" /><meta name="guid" content="T_log4net_Appender_SmtpAppender" /></head><body onload="OnLoad('cs')"><input type="hidden" id="userDataCache" class="userDataStyle" /><div class="OH_outerDiv"><div class="OH_outerContent"><table class="TitleTable"><tr><td class="OH_tdTitleColumn">SmtpAppender Class</td><td class="OH_tdRunningTitleColumn">Apache log4net™ SDK Documentation</td></tr></table><div id="mainSection"><div id="mainBody"><span class="introStyle"></span><div class="summary">
Send an e-mail when a specific logging event occurs, typically on errors
or fatal errors.
</div><div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">Inheritance Hierarchy</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"> </div><a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">System<span id="LST36FBA9F_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST36FBA9F_0?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Object</a><br />  <a href="T_log4net_Appender_AppenderSkeleton.htm">log4net.Appender<span id="LST36FBA9F_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST36FBA9F_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>AppenderSkeleton</a><br />    <a href="T_log4net_Appender_BufferingAppenderSkeleton.htm">log4net.Appender<span id="LST36FBA9F_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST36FBA9F_2?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>BufferingAppenderSkeleton</a><br />      <span class="selflink">log4net.Appender<span id="LST36FBA9F_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST36FBA9F_3?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>SmtpAppender</span><br /><p> </p><strong>Namespace:</strong> <a href="N_log4net_Appender.htm">log4net.Appender</a><br /><strong>Assembly:</strong> log4net (in log4net.dll) Version: 2.0.8.0-.NET 4.0<div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">Syntax</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"> </div><div class="OH_CodeSnippetContainer"><div class="OH_CodeSnippetContainerTabs"><div class="OH_CodeSnippetContainerTabLeft" id="ID0EDCA_tabimgleft"> </div><div id="ID0EDCA_tab1" class="OH_CodeSnippetContainerTabFirst"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','cs','1','4');return false;">C#</a></div><div id="ID0EDCA_tab2" class="OH_CodeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','vb','2','4');return false;">VB</a></div><div id="ID0EDCA_tab3" class="OH_CodeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','cpp','3','4');return false;">C++</a></div><div id="ID0EDCA_tab4" class="OH_CodeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','fs','4','4');return false;">F#</a></div><div class="OH_CodeSnippetContainerTabRight" id="ID0EDCA_tabimgright"> </div></div><div class="OH_CodeSnippetContainerCodeCollection"><div class="OH_CodeSnippetToolBar"><div class="OH_CodeSnippetToolBarText"><a id="ID0EDCA_copyCode" href="#" onclick="javascript:CopyToClipboard('ID0EDCA');return false;" title="Copy">Copy</a></div></div><div id="ID0EDCA_code_Div1" class="OH_CodeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">SmtpAppender</span> : <span class="identifier">BufferingAppenderSkeleton</span></pre></div><div id="ID0EDCA_code_Div2" class="OH_CodeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">Public</span> <span class="keyword">Class</span> <span class="identifier">SmtpAppender</span>
<span class="keyword">Inherits</span> <span class="identifier">BufferingAppenderSkeleton</span></pre></div><div id="ID0EDCA_code_Div3" class="OH_CodeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">ref class</span> <span class="identifier">SmtpAppender</span> : <span class="keyword">public</span> <span class="identifier">BufferingAppenderSkeleton</span></pre></div><div id="ID0EDCA_code_Div4" class="OH_CodeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">type</span> <span class="identifier">SmtpAppender</span> =
<span class="keyword">class</span>
<span class="keyword">inherit</span> <span class="identifier">BufferingAppenderSkeleton</span>
<span class="keyword">end</span></pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EDCA");</script><p>The <span class="selflink">SmtpAppender</span> type exposes the following members.</p><div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">Constructors</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"> </div><table id="memberList" class="members"><tr><th class="ps_iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Appender_SmtpAppender__ctor.htm">SmtpAppender</a></td><td><div class="summary">
Default constructor
</div></td></tr></table><a href="#mainBody">Top</a><div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">Properties</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"> </div><table id="memberList" class="members"><tr><th class="ps_iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_SmtpAppender_Authentication.htm">Authentication</a></td><td><div class="summary">
The mode to use to authentication with the SMTP server
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_SmtpAppender_Bcc.htm">Bcc</a></td><td><div class="summary">
Gets or sets a semicolon-delimited list of recipient e-mail addresses
that will be blind carbon copied.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_SmtpAppender_BodyEncoding.htm">BodyEncoding</a></td><td><div class="summary">
Gets or sets the body encoding to be used.
</div></td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_BufferingAppenderSkeleton_BufferSize.htm">BufferSize</a></td><td><div class="summary">
Gets or sets the size of the cyclic buffer used to hold the
logging events.
</div> (Inherited from <a href="T_log4net_Appender_BufferingAppenderSkeleton.htm">BufferingAppenderSkeleton</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_SmtpAppender_Cc.htm">Cc</a></td><td><div class="summary">
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).
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_SmtpAppender_EnableSsl.htm">EnableSsl</a></td><td><div class="summary">
Enable or disable use of SSL when sending e-mail message
</div></td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_AppenderSkeleton_ErrorHandler.htm">ErrorHandler</a></td><td><div class="summary">
Gets or sets the <a href="T_log4net_Core_IErrorHandler.htm">IErrorHandler</a> for this appender.
</div> (Inherited from <a href="T_log4net_Appender_AppenderSkeleton.htm">AppenderSkeleton</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_BufferingAppenderSkeleton_Evaluator.htm">Evaluator</a></td><td><div class="summary">
Gets or sets the <a href="T_log4net_Core_ITriggeringEventEvaluator.htm">ITriggeringEventEvaluator</a> that causes the
buffer to be sent immediately.
</div> (Inherited from <a href="T_log4net_Appender_BufferingAppenderSkeleton.htm">BufferingAppenderSkeleton</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_AppenderSkeleton_FilterHead.htm">FilterHead</a></td><td><div class="summary">
The filter chain.
</div> (Inherited from <a href="T_log4net_Appender_AppenderSkeleton.htm">AppenderSkeleton</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_BufferingAppenderSkeleton_Fix.htm">Fix</a></td><td><div class="summary">
Gets or sets a the fields that will be fixed in the event
</div> (Inherited from <a href="T_log4net_Appender_BufferingAppenderSkeleton.htm">BufferingAppenderSkeleton</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_SmtpAppender_From.htm">From</a></td><td><div class="summary">
Gets or sets the e-mail address of the sender.
</div></td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_AppenderSkeleton_Layout.htm">Layout</a></td><td><div class="summary">
Gets or sets the <a href="T_log4net_Layout_ILayout.htm">ILayout</a> for this appender.
</div> (Inherited from <a href="T_log4net_Appender_AppenderSkeleton.htm">AppenderSkeleton</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_SmtpAppender_LocationInfo.htm">LocationInfo</a></td><td> <strong>Obsolete. </strong><div class="summary">
Obsolete
</div></td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_BufferingAppenderSkeleton_Lossy.htm">Lossy</a></td><td><div class="summary">
Gets or sets a value that indicates whether the appender is lossy.
</div> (Inherited from <a href="T_log4net_Appender_BufferingAppenderSkeleton.htm">BufferingAppenderSkeleton</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_BufferingAppenderSkeleton_LossyEvaluator.htm">LossyEvaluator</a></td><td><div class="summary">
Gets or sets the value of the <a href="T_log4net_Core_ITriggeringEventEvaluator.htm">ITriggeringEventEvaluator</a> to use.
</div> (Inherited from <a href="T_log4net_Appender_BufferingAppenderSkeleton.htm">BufferingAppenderSkeleton</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_AppenderSkeleton_Name.htm">Name</a></td><td><div class="summary">
Gets or sets the name of this appender.
</div> (Inherited from <a href="T_log4net_Appender_AppenderSkeleton.htm">AppenderSkeleton</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_BufferingAppenderSkeleton_OnlyFixPartialEventData.htm">OnlyFixPartialEventData</a></td><td> <strong>Obsolete. </strong><div class="summary">
Gets or sets a value indicating if only part of the logging event data
should be fixed.
</div> (Inherited from <a href="T_log4net_Appender_BufferingAppenderSkeleton.htm">BufferingAppenderSkeleton</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_SmtpAppender_Password.htm">Password</a></td><td><div class="summary">
The password to use to authenticate with the SMTP server
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_SmtpAppender_Port.htm">Port</a></td><td><div class="summary">
The port on which the SMTP server is listening
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_SmtpAppender_Priority.htm">Priority</a></td><td><div class="summary">
Gets or sets the priority of the e-mail message
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_SmtpAppender_ReplyTo.htm">ReplyTo</a></td><td><div class="summary">
Gets or sets the reply-to e-mail address.
</div></td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protproperty.gif" alt="Protected property" title="Protected property" /></td><td><a href="P_log4net_Appender_SmtpAppender_RequiresLayout.htm">RequiresLayout</a></td><td><div class="summary">
This appender requires a <a href="N_log4net_Layout.htm">log4net.Layout</a> to be set.
</div> (Overrides <a href="P_log4net_Appender_AppenderSkeleton_RequiresLayout.htm">AppenderSkeleton<span id="LST36FBA9F_4"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST36FBA9F_4?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>RequiresLayout</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_SmtpAppender_SmtpHost.htm">SmtpHost</a></td><td><div class="summary">
Gets or sets the name of the SMTP relay mail server to use to send
the e-mail messages.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_SmtpAppender_Subject.htm">Subject</a></td><td><div class="summary">
Gets or sets the subject line of the e-mail message.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_SmtpAppender_SubjectEncoding.htm">SubjectEncoding</a></td><td><div class="summary">
Gets or sets the subject encoding to be used.
</div></td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_AppenderSkeleton_Threshold.htm">Threshold</a></td><td><div class="summary">
Gets or sets the threshold <a href="T_log4net_Core_Level.htm">Level</a> of this appender.
</div> (Inherited from <a href="T_log4net_Appender_AppenderSkeleton.htm">AppenderSkeleton</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_SmtpAppender_To.htm">To</a></td><td><div class="summary">
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).
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_SmtpAppender_Username.htm">Username</a></td><td><div class="summary">
The username to use to authenticate with the SMTP server
</div></td></tr></table><a href="#mainBody">Top</a><div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">Methods</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"> </div><table id="memberList" class="members"><tr><th class="ps_iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Appender_BufferingAppenderSkeleton_ActivateOptions.htm">ActivateOptions</a></td><td><div class="summary">
Initialize the appender based on the options set
</div> (Inherited from <a href="T_log4net_Appender_BufferingAppenderSkeleton.htm">BufferingAppenderSkeleton</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Appender_AppenderSkeleton_AddFilter.htm">AddFilter</a></td><td><div class="summary">
Adds a filter to the end of the filter chain.
</div> (Inherited from <a href="T_log4net_Appender_AppenderSkeleton.htm">AppenderSkeleton</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_log4net_Appender_AppenderSkeleton_Append_1.htm">Append(<span id="LST36FBA9F_5"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST36FBA9F_5?cpp=array&lt;");</script>LoggingEvent<span id="LST36FBA9F_6"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST36FBA9F_6?cpp=&gt;|cs=[]|vb=()|nu=[]|fs=[]");</script>)</a></td><td><div class="summary">
Append a bulk array of logging events.
</div> (Inherited from <a href="T_log4net_Appender_AppenderSkeleton.htm">AppenderSkeleton</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_log4net_Appender_BufferingAppenderSkeleton_Append.htm">Append(LoggingEvent)</a></td><td><div class="summary">
This method is called by the <span class="nolink">DoAppend(LoggingEvent)</span> method.
</div> (Inherited from <a href="T_log4net_Appender_BufferingAppenderSkeleton.htm">BufferingAppenderSkeleton</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Appender_AppenderSkeleton_ClearFilters.htm">ClearFilters</a></td><td><div class="summary">
Clears the filter list for this appender.
</div> (Inherited from <a href="T_log4net_Appender_AppenderSkeleton.htm">AppenderSkeleton</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Appender_AppenderSkeleton_Close.htm">Close</a></td><td><div class="summary">
Closes the appender and release resources.
</div> (Inherited from <a href="T_log4net_Appender_AppenderSkeleton.htm">AppenderSkeleton</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Appender_AppenderSkeleton_DoAppend.htm">DoAppend(LoggingEvent)</a></td><td><div class="summary">
Performs threshold checks and invokes filters before
delegating actual logging to the subclasses specific
<span class="nolink">[M:Append(LoggingEvent)]</span> method.
</div> (Inherited from <a href="T_log4net_Appender_AppenderSkeleton.htm">AppenderSkeleton</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Appender_AppenderSkeleton_DoAppend_1.htm">DoAppend(<span id="LST36FBA9F_7"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST36FBA9F_7?cpp=array&lt;");</script>LoggingEvent<span id="LST36FBA9F_8"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST36FBA9F_8?cpp=&gt;|cs=[]|vb=()|nu=[]|fs=[]");</script>)</a></td><td><div class="summary">
Performs threshold checks and invokes filters before
delegating actual logging to the subclasses specific
<span class="nolink">[M:Append(LoggingEvent[])]</span> method.
</div> (Inherited from <a href="T_log4net_Appender_AppenderSkeleton.htm">AppenderSkeleton</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/bsc2ak47" target="_blank">Equals</a></td><td><div class="summary">
Determines whether the specified <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a> is equal to the current <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.
</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_log4net_Appender_AppenderSkeleton_FilterEvent.htm">FilterEvent</a></td><td><div class="summary">
Test if the logging event should we output by this appender
</div> (Inherited from <a href="T_log4net_Appender_AppenderSkeleton.htm">AppenderSkeleton</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_log4net_Appender_AppenderSkeleton_Finalize.htm">Finalize</a></td><td><div class="summary">
Finalizes this appender by calling the implementation's
<a href="M_log4net_Appender_AppenderSkeleton_Close.htm">Close<span id="LST36FBA9F_9"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST36FBA9F_9?cs=()|vb=|cpp=()|nu=()|fs=()");</script></a> method.
</div> (Inherited from <a href="T_log4net_Appender_AppenderSkeleton.htm">AppenderSkeleton</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Appender_BufferingAppenderSkeleton_Flush.htm">Flush<span id="LST36FBA9F_10"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST36FBA9F_10?cs=()|vb=|cpp=()|nu=()|fs=()");</script></a></td><td><div class="summary">
Flush the currently buffered events
</div> (Inherited from <a href="T_log4net_Appender_BufferingAppenderSkeleton.htm">BufferingAppenderSkeleton</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Appender_BufferingAppenderSkeleton_Flush_1.htm">Flush(Boolean)</a></td><td><div class="summary">
Flush the currently buffered events
</div> (Inherited from <a href="T_log4net_Appender_BufferingAppenderSkeleton.htm">BufferingAppenderSkeleton</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Appender_BufferingAppenderSkeleton_Flush_2.htm">Flush(Int32)</a></td><td><div class="summary">
Flushes any buffered log data.
</div> (Inherited from <a href="T_log4net_Appender_BufferingAppenderSkeleton.htm">BufferingAppenderSkeleton</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/zdee4b3y" target="_blank">GetHashCode</a></td><td><div class="summary">
Serves as a hash function for a particular type.
</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/dfwy45w9" target="_blank">GetType</a></td><td><div class="summary">
Gets the <a href="http://msdn2.microsoft.com/en-us/library/42892f65" target="_blank">Type</a> of the current instance.
</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_log4net_Appender_AppenderSkeleton_IsAsSevereAsThreshold.htm">IsAsSevereAsThreshold</a></td><td><div class="summary">
Checks if the message level is below this appender's threshold.
</div> (Inherited from <a href="T_log4net_Appender_AppenderSkeleton.htm">AppenderSkeleton</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/57ctke0a" target="_blank">MemberwiseClone</a></td><td><div class="summary">
Creates a shallow copy of the current <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.
</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_log4net_Appender_BufferingAppenderSkeleton_OnClose.htm">OnClose</a></td><td><div class="summary">
Close this appender instance.
</div> (Inherited from <a href="T_log4net_Appender_BufferingAppenderSkeleton.htm">BufferingAppenderSkeleton</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_log4net_Appender_AppenderSkeleton_PreAppendCheck.htm">PreAppendCheck</a></td><td><div class="summary">
Called before <span class="nolink">[M:Append(LoggingEvent)]</span> as a precondition.
</div> (Inherited from <a href="T_log4net_Appender_AppenderSkeleton.htm">AppenderSkeleton</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_log4net_Appender_AppenderSkeleton_RenderLoggingEvent.htm">RenderLoggingEvent(LoggingEvent)</a></td><td><div class="summary">
Renders the <a href="T_log4net_Core_LoggingEvent.htm">LoggingEvent</a> to a string.
</div> (Inherited from <a href="T_log4net_Appender_AppenderSkeleton.htm">AppenderSkeleton</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_log4net_Appender_AppenderSkeleton_RenderLoggingEvent_1.htm">RenderLoggingEvent(TextWriter, LoggingEvent)</a></td><td><div class="summary">
Renders the <a href="T_log4net_Core_LoggingEvent.htm">LoggingEvent</a> to a string.
</div> (Inherited from <a href="T_log4net_Appender_AppenderSkeleton.htm">AppenderSkeleton</a>.)</td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_log4net_Appender_SmtpAppender_SendBuffer.htm">SendBuffer</a></td><td><div class="summary">
Sends the contents of the cyclic buffer as an e-mail message.
</div> (Overrides <a href="M_log4net_Appender_BufferingAppenderSkeleton_SendBuffer.htm">BufferingAppenderSkeleton<span id="LST36FBA9F_11"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST36FBA9F_11?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>SendBuffer(<span id="LST36FBA9F_12"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST36FBA9F_12?cpp=array&lt;");</script>LoggingEvent<span id="LST36FBA9F_13"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST36FBA9F_13?cpp=&gt;|cs=[]|vb=()|nu=[]|fs=[]");</script>)</a>.)</td></tr><tr data="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_log4net_Appender_SmtpAppender_SendEmail.htm">SendEmail</a></td><td><div class="summary">
Send the email message
</div></td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_log4net_Appender_BufferingAppenderSkeleton_SendFromBuffer.htm">SendFromBuffer</a></td><td><div class="summary">
Sends the contents of the buffer.
</div> (Inherited from <a href="T_log4net_Appender_BufferingAppenderSkeleton.htm">BufferingAppenderSkeleton</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/7bxwbwt2" target="_blank">ToString</a></td><td><div class="summary">
Returns a <a href="http://msdn2.microsoft.com/en-us/library/s1wwdcbf" target="_blank">String</a> that represents the current <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.
</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr></table><a href="#mainBody">Top</a><div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">Remarks</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"> </div><p>
The number of logging events delivered in this e-mail depend on
the value of <a href="P_log4net_Appender_BufferingAppenderSkeleton_BufferSize.htm">BufferSize</a> option. The
<span class="selflink">SmtpAppender</span> keeps only the last
<a href="P_log4net_Appender_BufferingAppenderSkeleton_BufferSize.htm">BufferSize</a> logging events in its
cyclic buffer. This keeps memory requirements at a reasonable level while
still delivering useful application context.
</p><div class="alert"><table><tr><th><img src="../icons/alert_caution.gif" alt="Caution note" /> Caution</th></tr><tr><td>
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.
</td></tr></table></div><p>
Authentication is supported by setting the <a href="P_log4net_Appender_SmtpAppender_Authentication.htm">Authentication</a> property to
either <a href="T_log4net_Appender_SmtpAppender_SmtpAuthentication.htm">Basic</a> or <a href="T_log4net_Appender_SmtpAppender_SmtpAuthentication.htm">Ntlm</a>.
If using <a href="T_log4net_Appender_SmtpAppender_SmtpAuthentication.htm">Basic</a> authentication then the <a href="P_log4net_Appender_SmtpAppender_Username.htm">Username</a>
and <a href="P_log4net_Appender_SmtpAppender_Password.htm">Password</a> properties must also be set.
</p><p>
To set the SMTP server port use the <a href="P_log4net_Appender_SmtpAppender_Port.htm">Port</a> property. The default port is 25.
</p><div class="OH_CollapsibleAreaRegion" id="seeAlsoSection"><div class="OH_regiontitle">See Also</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"> </div><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="N_log4net_Appender.htm">log4net.Appender Namespace</a></div></div></div></div></div><div id="OH_footer" class="OH_footer">Apache log4net, Apache and log4net are trademarks of The Apache Software Foundation.<p><a href="http://logging.apache.org/log4net/" target="_blank">Copyright 2004-2017 The Apache Software Foundation</a></p><div class="OH_feedbacklink">Send comments on this topic to
<a id="HT_MailLink" href="mailto:http%3A%2F%2Flogging.apache.org%2Flog4net%2Fmail-lists.html?Subject=Apache log4net™ SDK Documentation">http://logging.apache.org/log4net/mail-lists.html</a></div><script type="text/javascript">
var HT_mailLink = document.getElementById("HT_MailLink");
var HT_mailLinkText = HT_mailLink.innerHTML;
HT_mailLink.href += ": " + document.title + "\u0026body=" + encodeURIComponent("Your feedback is used to improve the documentation and the product. Your e-mail address will not be used for any other purpose and is disposed of after the issue you report is resolved. While working to resolve the issue that you report, you may be contacted via e-mail to get further details or clarification on the feedback you sent. After the issue you report has been addressed, you may receive an e-mail to let you know that your feedback has been addressed.");
HT_mailLink.innerHTML = HT_mailLinkText;
</script> </div></body></html>