SendMailErrorEventArgs クラス

リファレンス

定義

名前空間:: System.Web.UI.WebControls

アセンブリ:: System.Web.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

ChangePassword、CreateUserWizard、PasswordRecovery など各コントロールの SendMailError イベントのデータを提供します。

public ref class SendMailErrorEventArgs : EventArgs

public class SendMailErrorEventArgs : EventArgs

type SendMailErrorEventArgs = class
    inherit EventArgs

Public Class SendMailErrorEventArgs
Inherits EventArgs

継承: Object

EventArgs
SendMailErrorEventArgs

例

次のコード例は、Web コントロールを使用 ChangePassword し、SendMailError という名前のイベントのイベントハンドラーを含む ASP.NET ページを SendMailError 示しています。このコード例では、ASP.NET Web サイトが ASP.NET メンバーシップとフォーム認証を使用するように構成されていること、および名前とパスワードが既知のユーザーが作成されていることを前提としています。詳細については、「方法: 簡易フォーム認証を実装する」を参照してください。

パスワードの変更が成功した場合、イベントハンドラーの SendingMail コードは、変更を確認するためにユーザーに電子メールメッセージを送信しようとします。このコード例を機能させるには、サーバーで SMTP が既に構成されている必要があります。 SMTP サーバーを構成する方法の詳細については、「方法: IIS 6.0 で SMTP 仮想サーバーをインストールおよび構成する」を参照してください。この例では、SMTP サーバーを構成する必要はありません。この例は、電子メールメッセージの送信失敗をテストするために構築されています。

メールサーバーが正しく構成されていない場合、または他のエラーが発生し、電子メールメッセージを送信できない場合は、 SendMailError 関数が呼び出されます。ユーザーにメッセージが表示されます。さらに、MySamplesSite という名前のイベントソースが既に存在することを前提として、イベントが Windows アプリケーションイベントログに記録されます。指定したイベントソースを作成するには、次のコード例を参照してください。イベントソースの作成の詳細については、「 ASP.NET Web フォームページでのサーバーイベント処理」を参照してください。 Handledオブジェクトの SendMailErrorEventArgs プロパティは、にtrue設定され、エラーが処理されたことを示します。

<%@ Page Language="C#" AutoEventWireup="True" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  void MySendingMail(object sender, MailMessageEventArgs e)
  {
    Message1.Text = "Sent mail to you to confirm the password change.";
  }

  void MySendMailError(object sender, SendMailErrorEventArgs e)
  {
    Message1.Text = "Could not send email to confirm password change.";

    // The MySamplesSite event source has already been created by an administrator.
    System.Diagnostics.EventLog myLog = new System.Diagnostics.EventLog();
    myLog.Log = "Application";
    myLog.Source = "MySamplesSite";
    myLog.WriteEntry(
        "Sending mail via SMTP failed with the following error: " + 
        e.Exception.Message.ToString(), 
        System.Diagnostics.EventLogEntryType.Error);

    e.Handled = true;
  }

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
  <title>ChangePassword including a SendMailError Event</title>
</head>
<body>
  <form id="form1" runat="server">
  <div style="text-align:center">

    <h1>ChangePassword</h1>
    
    <asp:LoginView ID="LoginView1" Runat="server" 
      Visible="true">
      <LoggedInTemplate>
        <asp:LoginName ID="LoginName1" Runat="server" FormatString="You are logged in as {0}." />
        <br />
      </LoggedInTemplate>
      <AnonymousTemplate>
        You are not logged in
      </AnonymousTemplate>
    </asp:LoginView><br />
    
    <asp:ChangePassword ID="ChangePassword1" Runat="server"
      BorderStyle="Solid" 
      BorderWidth="1" 
      CancelDestinationPageUrl="~/Default.aspx" 
      DisplayUserName="true"
      OnSendingMail="MySendingMail" 
      OnSendMailError="MySendMailError" 
      ContinueDestinationPageUrl="~/Default.aspx" >
      <MailDefinition 
        BodyFileName="~\MailFiles\ChangePasswordMail.htm" 
        Subject="Activity information for you">
        <EmbeddedObjects>
          <asp:EmbeddedMailObject Name="LoginGif" Path="~\MailFiles\Login.gif" />
          <asp:EmbeddedMailObject Name="PrivacyNoticeTxt" Path="~\MailFiles\PrivacyNotice.txt" />
        </EmbeddedObjects>
      </MailDefinition>
    </asp:ChangePassword><br />
  
    <asp:Label ID="Message1" Runat="server" ForeColor="Red" /><br />

    <asp:HyperLink ID="HyperLink1" Runat="server" 
      NavigateUrl="~/Default.aspx">
      Home
    </asp:HyperLink>
    
  </div>
  </form>
</body>
</html>

<%@ Page Language="VB" AutoEventWireup="True" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

  Public Sub MySendingMail(ByVal Sender As Object, ByVal e As MailMessageEventArgs)
    Message1.Text = "Sent mail to you to confirm the password change."
  End Sub

  Public Sub MySendMailError(ByVal Sender As Object, ByVal e As SendMailErrorEventArgs)
    Message1.Text = "Could not send mail to confirm the password change."
    
    ' The MySamplesSite event source has already been created by an administrator.
    Dim myLog As System.Diagnostics.EventLog
    myLog = new System.Diagnostics.EventLog
    myLog.Log = "Application"
    myLog.Source = "MySamplesSite"
    myLog.WriteEntry("Sending mail via SMTP failed with the following error: " & e.Exception.Message.ToString(), System.Diagnostics.EventLogEntryType.Error)

    e.Handled = True
    
  End Sub

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
  <title>ChangePassword including a SendMailError Event</title>
</head>
<body>
  <form id="form1" runat="server">
  <div style="text-align:center">

    <h1>ChangePassword</h1>
    
    <asp:LoginView ID="LoginView1" Runat="server" 
      Visible="true">
      <LoggedInTemplate>
        <asp:LoginName ID="LoginName1" Runat="server" FormatString="You are logged in as {0}." />
        <br />
      </LoggedInTemplate>
      <AnonymousTemplate>
        You are not logged in
      </AnonymousTemplate>
    </asp:LoginView><br />
    
    <asp:ChangePassword ID="ChangePassword1" Runat="server"
      BorderStyle="Solid" 
      BorderWidth="1" 
      CancelDestinationPageUrl="~/Default.aspx" 
      DisplayUserName="true"
      OnSendingMail="MySendingMail" 
      OnSendMailError="MySendMailError" 
      ContinueDestinationPageUrl="~/Default.aspx" >
      <MailDefinition 
        BodyFileName="~\MailFiles\ChangePasswordMail.htm" 
        Subject="Activity information for you">
        <EmbeddedObjects>
          <asp:EmbeddedMailObject Name="LoginGif" Path="~\MailFiles\Login.gif" />
          <asp:EmbeddedMailObject Name="PrivacyNoticeTxt" Path="~\MailFiles\PrivacyNotice.txt" />
        </EmbeddedObjects>
      </MailDefinition>
    </asp:ChangePassword><br />
  
    <asp:Label ID="Message1" Runat="server" ForeColor="Red" /><br />

    <asp:HyperLink ID="HyperLink1" Runat="server" 
      NavigateUrl="~/Default.aspx">
      Home
    </asp:HyperLink>
    
  </div>
  </form>
</body>
</html>

MySamplesSite という名前のイベントソースをアプリケーションログにプログラムで追加する必要がある場合は、次のコード例を使用します。最初のコード例が正しく機能するためには、このイベントソースが存在する必要があります。次のコード例では、管理者特権が必要です。

#region Using directives

using System;
using System.Collections.Generic;
using System.Text;
using System.Diagnostics;

#endregion

namespace CreateEventSource
{
    class Program
    {
        static void Main(string[] args)
        {

            try
            {
                // Create the source, if it does not already exist.
                if (!EventLog.SourceExists("MySamplesSite"))
                {
                    EventLog.CreateEventSource("MySamplesSite", "Application");
                    Console.WriteLine("Creating Event Source");
                }

                // Create an EventLog instance and assign its source.
                EventLog myLog = new EventLog();
                myLog.Source = "MySamplesSite";

                // Write an informational entry to the event log.    
                myLog.WriteEntry("Testing writing to event log.");

                Console.WriteLine("Message written to event log.");
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception:");
                Console.WriteLine("{0}", e.ToString());
            }
        }
    }
}

Imports System.Collections.Generic
Imports System.Text
Imports System.Diagnostics


Namespace CreateEventSource
  Class Program
    Sub Main()

        Try
            ' Create the source, if it does not already exist.
            If Not (EventLog.SourceExists("MySamplesSite")) Then
                EventLog.CreateEventSource("MySamplesSite", "Application")
                Console.WriteLine("Creating Event Source")
            End If

            ' Create an EventLog instance and assign its source.
            Dim myLog As New EventLog
            myLog.Source = "MySamplesSite"

            ' Write an informational entry to the event log.
            myLog.WriteEntry("Testing writing to event log.")

            Console.WriteLine("Message written to event log.")
        Catch e As Exception
            Console.WriteLine("Exception:")
            Console.WriteLine(e.ToString)
        End Try

    End Sub
  End Class
End Namespace

注釈

オブジェクトには SendMailErrorEventArgs 、コントロールまたはコントロールから電子メールメッセージを送信できない場合に SMTP メールプロバイダーによって ChangePassword 発生するエラーメッセージが CreateUserWizard 含まれています。このような場合、 SendMailErrorEventArgs オブジェクトはに SendMailErrorEventHandler送信されます。

イベントを SendMailErrorEventHandler 処理するデリゲートを作成します。イベントを処理すると、例外が発生した場合でも Web アプリケーションを引き続き実行できます。これは、電子メールメッセージを送信することが重要でない場合に便利です。たとえば、ユーザーがマルチステップウィザードを使用しているときに例外が発生した場合、エラーをログに記録し、ユーザーに有益なメッセージを表示し、ユーザーがウィザードを完了できるようにすると便利な場合があります。

プロパティを Exception 調べて、例外の実際の原因を特定します。例外の最も一般的な理由は、マシン構成ファイルの <smtp> 要素 (ネットワーク設定) の構成エラーです。このようなエラーは通常、アプリケーションの開発とデバッグ中に検出されますが、メールサーバーは運用環境で予期せず失敗する可能性があり、その状況でアプリケーション全体を失敗させるかどうかを判断する必要があります。そうでない場合は、イベントを処理すると、アプリケーションを続行できます。

例外が処理されたことを通知するには、 Handled プロパティをに true 設定する必要があります。それ以外の場合は、例外が再スローされ、元の呼び出し履歴とエラーメッセージが含まれます。

イベントの SendMailError イベントハンドラーを作成しない場合、またはイベントハンドラーを作成してもプロパティをに設定したまま Handled にすると、電子メールメッセージの送信時に falseエラーが発生すると Web アプリケーションの実行が停止し、ASP.NET にエラーメッセージが表示されます。

また、 OnSendMailError メソッドを使用すると、によって実行されるのではなく、派生クラスでイベントを SendMailErrorEventHandler処理できます。これは、または CreateUserWizardからChangePassword派生したクラスでイベントを処理する場合に推奨される手法です。

イベントの処理の詳細については、「 ASP.NET Web フォームページでのサーバーイベント処理」を参照してください。

注意 (継承者)

派生クラスでオーバーライドする OnSendMailError(SendMailErrorEventArgs) 場合は、必ず基底クラスのメソッドを OnSendMailError(SendMailErrorEventArgs) 呼び出して、登録されたデリゲートがイベントを受け取るようにしてください。

コンストラクター

SendMailErrorEventArgs(Exception)

SendMailErrorEventArgs クラスの新しいインスタンスを初期化します。

プロパティ

Exception	電子メールメッセージを送信できなかったときに、SMTP メールサービスによってスローされる例外を返します。
Handled	Exception プロパティに格納されている SMTP 例外が処理されたかどうかを示します。

メソッド

Equals(Object)	指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

適用対象

次の方法で共有