SendMailTask クラス

電子メール メッセージを送信します。このクラスは継承できません。

継承階層

System. . :: . .Object
  Microsoft.SqlServer.Dts.Runtime. . :: . .DtsObject
    Microsoft.SqlServer.Dts.Runtime. . :: . .Task
      Microsoft.SqlServer.Dts.Tasks.SendMailTask..::..SendMailTask

名前空間:  Microsoft.SqlServer.Dts.Tasks.SendMailTask
アセンブリ:  Microsoft.SqlServer.SendMailTask (Microsoft.SqlServer.SendMailTask.dll)

構文

'宣言
Public NotInheritable Class SendMailTask _
    Inherits Task _
    Implements IDTSComponentPersist, IDTSSendMailTask, IDTSBreakpointSite, IDTSSuspend
'使用
Dim instance As SendMailTask

public sealed class SendMailTask : Task, 
    IDTSComponentPersist, IDTSSendMailTask, IDTSBreakpointSite, IDTSSuspend

public ref class SendMailTask sealed : public Task, 
    IDTSComponentPersist, IDTSSendMailTask, IDTSBreakpointSite, IDTSSuspend

[<SealedAttribute>]
type SendMailTask =  
    class
        inherit Task
        interface IDTSComponentPersist
        interface IDTSSendMailTask
        interface IDTSBreakpointSite
        interface IDTSSuspend
    end

public final class SendMailTask extends Task implements IDTSComponentPersist, IDTSSendMailTask, IDTSBreakpointSite, IDTSSuspend

SendMailTask 型は、以下のメンバーを公開しています。

コンストラクター

	名前	説明
	SendMailTask	SendMailTask クラスの新しいインスタンスを初期化します。

先頭に戻る

プロパティ

	名前	説明
	BCCLine	ブラインド カーボン コピー受信者の電子メール アドレスを取得します (受信者が複数存在する場合はセミコロンで区切られます)。値の設定も可能です。
	CCLine	カーボン コピー受信者の電子メール アドレスを取得します (受信者が複数存在する場合はセミコロンで区切られます)。値の設定も可能です。
	DebugMode	オブジェクトがデバッグ モードであるかどうか、および実行中に OnBreakpointHit イベントを発生させる必要があるかどうかを示す Boolean を取得します。値の設定も可能です。
	ExecutionValue	ユーザー定義のオブジェクトを返します。このフィールドは読み取り専用です。 (Task から継承されています。)
	FileAttachments	電子メール メッセージに添付されたファイルの名前を取得します。値の設定も可能です。ファイルが複数ある場合はパイプ文字 (|) で区切られます。
	FromLine	送信者の電子メール アドレスを取得します。値の設定も可能です。
	MessageSource	メッセージ本文またはメッセージ本文を含むソースの名前を取得します。値の設定も可能です。
	MessageSourceType	メッセージ本文のソースの種類を含む値を取得します。値の設定も可能です。
	Priority	メッセージの優先度を取得します。値の設定も可能です。
	SmtpConnection	SMTP (Simple Mail Transfer Protocol) サーバーの名前または IP アドレスを取得します。値の設定も可能です。
	Subject	電子メール メッセージの件名を取得します。値の設定も可能です。
	SuspendRequired	ブレークポイントに到達したときにタスクを中断するかどうかを示す Boolean を取得します。値の設定も可能です。この値は、ブレークポイントに到達したときにタスクおよびコンテナに対してランタイム エンジンで設定されます。
	ToLine	受信者の電子メール アドレスを取得します (受信者が複数存在する場合はセミコロンで区切られます)。値の設定も可能です。
	Version	*** このメンバーは非推奨です。「解説」を参照してください。 ***    タスクのバージョンを返します。このプロパティは読み取り専用です。 (Task から継承されています。)

先頭に戻る

メソッド

	名前	説明
	AcceptBreakpointManager	メール送信タスクに BreakpointManager を渡します。このメソッドはランタイムから呼び出されるメソッドであり、コードでは使用されません。
	CanUpdate	*** このメンバーは非推奨です。「解説」を参照してください。 ***    新しいパッケージの XML で古いパッケージの XML を更新できるかどうかを示す Boolean 値。 (Task から継承されています。)
	Equals	2 つのオブジェクト インスタンスが等しいかどうかを示します。 (DtsObject から継承されています。)
	Execute	メール送信タスクを実行します。 (Task. . :: . .Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object) をオーバーライドします。)
	Finalize	(Object から継承されています。)
	GetConnectionID	接続の ID を含む String を取得します。 (Task から継承されています。)
	GetConnectionName	接続の名前を含む String を取得します。 (Task から継承されています。)
	GetHashCode	このインスタンスのハッシュ コードを返します。 (DtsObject から継承されています。)
	GetType	(Object から継承されています。)
	InitializeTask	タスクに関連付けられたプロパティを初期化します。このメソッドはランタイムから呼び出されるメソッドであり、コードでは使用されません。 (Task. . :: . .InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker) をオーバーライドします。)
	LoadFromXML	このメソッドをアプリケーション コードから呼び出すことはできません。.xml として保存されたパッケージを読み込むには、Application..::..LoadPackage メソッドを使用します。
	MemberwiseClone	(Object から継承されています。)
	ResumeExecution	一時停止したタスクの実行を再開します。タスクまたはコンテナは、ランタイム エンジンによって再開されます。
	SaveToXML	このメソッドをアプリケーション コードから呼び出すことはできません。パッケージを .xml として保存するには、Application..::..SaveToXml メソッドを使用します。
	SuspendExecution	実行可能ファイルを中断する必要があることを示します。このメソッドはランタイム エンジンから呼び出されます。
	ToString	(Object から継承されています。)
	Update	*** このメンバーは非推奨です。「解説」を参照してください。 ***    CanUpdate が true に設定されている場合、このメソッドによって、古いパッケージ XML が新しいパッケージ XML で更新されます。 (Task から継承されています。)
	Validate	タスクが正しく構成されていることを確認します。 (Task. . :: . .Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging) をオーバーライドします。)

先頭に戻る

説明

メール送信タスクを使用して、パッケージ ワーク フローでのタスクが成功または失敗したときにパッケージから通知メッセージを送信できます。詳細については、「メール送信タスク」を参照してください。

使用例

次のコード サンプルでは、新しい SendMailTask を作成し、構成して実行します。

using Microsoft.SqlServer.Dts.Runtime;
using Microsoft.SqlServer.Dts.Tasks.SendMailTask;

class TestSendMailTask
{

  public static void Main()
  {

    Package pkg = new Package();

    ConnectionManager smtpCM;
    smtpCM = pkg.Connections.Add("SMTP");
    smtpCM.Name = "SMTP Connection Manager";
    smtpCM.ConnectionString = "smtphost";

    Executable exe = pkg.Executables.Add("STOCK:SendMailTask");
    TaskHost thSendMailTask = (TaskHost)exe;
    {
      thSendMailTask.Properties["SmtpConnection"].SetValue(thSendMailTask, "SMTP Connection Manager");
      thSendMailTask.Properties["ToLine"].SetValue(thSendMailTask, "someone1@example.com");
      thSendMailTask.Properties["CCLine"].SetValue(thSendMailTask, "someone2@example.com");
      thSendMailTask.Properties["BCCLine"].SetValue(thSendMailTask, "someone3@example.com");
      thSendMailTask.Properties["FromLine"].SetValue(thSendMailTask, "someone4@example.com");
      thSendMailTask.Properties["Priority"].SetValue(thSendMailTask, MailPriority.Normal);
      thSendMailTask.Properties["FileAttachments"].SetValue(thSendMailTask, "C:\\test_image.jpg");
      thSendMailTask.Properties["Subject"].SetValue(thSendMailTask, "Testing the SendMail Task");
      thSendMailTask.Properties["MessageSourceType"].SetValue(thSendMailTask, SendMailMessageSourceType.DirectInput);
      thSendMailTask.Properties["MessageSource"].SetValue(thSendMailTask, "This is only a test.");
    }

    DTSExecResult valResults = pkg.Validate(pkg.Connections, pkg.Variables, null, null);

    if (valResults == DTSExecResult.Success)
    {
      pkg.Execute();
    }

  }

}

Imports Microsoft.SqlServer.Dts.Runtime
Imports Microsoft.SqlServer.Dts.Tasks.SendMailTask

Module TestSendMailTask

  Sub Main()

    Dim pkg As New Package

    Dim smtpCM As ConnectionManager
    smtpCM = pkg.Connections.Add("SMTP")
    smtpCM.Name = "SMTP Connection Manager"
    smtpCM.ConnectionString = "smtphost"

    Dim exe As Executable = pkg.Executables.Add("STOCK:SendMailTask")
    Dim thSendMailTask As TaskHost = CType(exe, TaskHost)
    With thSendMailTask
      .Properties("SmtpConnection").SetValue(thSendMailTask, "SMTP Connection Manager")
      .Properties("ToLine").SetValue(thSendMailTask, "someone1@example.com")
      .Properties("CCLine").SetValue(thSendMailTask, "someone2@example.com")
      .Properties("BCCLine").SetValue(thSendMailTask, "someone3@example.com")
      .Properties("FromLine").SetValue(thSendMailTask, "someone4@example.com")
      .Properties("Priority").SetValue(thSendMailTask, MailPriority.Normal)
      .Properties("FileAttachments").SetValue(thSendMailTask, "C:\test_image.jpg")
      .Properties("Subject").SetValue(thSendMailTask, "Testing the SendMail Task")
      .Properties("MessageSourceType").SetValue(thSendMailTask, SendMailMessageSourceType.DirectInput)
      .Properties("MessageSource").SetValue(thSendMailTask, "This is only a test.")
    End With

    Dim valResults As DTSExecResult = pkg.Validate(pkg.Connections, pkg.Variables, Nothing, Nothing)

    If valResults = DTSExecResult.Success Then
      pkg.Execute()
    End If

  End Sub

End Module

スレッド セーフ

この型の public static (Visual Basic では Shared) のメンバーはすべて、スレッド セーフです。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。

関連項目

参照

Microsoft.SqlServer.Dts.Tasks.SendMailTask 名前空間