SendMailTask クラス

リファレンス

定義

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

アセンブリ:: Microsoft.SqlServer.SendMailTask.dll

重要

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

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

public ref class SendMailTask sealed : Microsoft::SqlServer::Dts::Runtime::Task, Microsoft::SqlServer::Dts::Runtime::IDTSBreakpointSite, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist, Microsoft::SqlServer::Dts::Tasks::SendMailTask::IDTSSendMailTask

[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.sendmailtask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.SendMailTask.SendMailTaskMessages), SamplesTag="SsisSendMailTask", TaskContact="Send Mail Task; Microsoft Corporation; SQL Server 2016; © 2015 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.SendMailTask.SendMailTaskUI, Microsoft.SqlServer.SendMailTaskUI, Version=13.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
public sealed class SendMailTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.SendMailTask.IDTSSendMailTask

[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.sendmailtask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.SendMailTask.SendMailTaskMessages), SamplesTag="SsisSendMailTask", TaskContact="Send Mail Task; Microsoft Corporation; SQL Server 2017; © 2017 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.SendMailTask.SendMailTaskUI, Microsoft.SqlServer.SendMailTaskUI, Version=14.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
public sealed class SendMailTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.SendMailTask.IDTSSendMailTask

[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.sendmailtask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.SendMailTask.SendMailTaskMessages), SamplesTag="SsisSendMailTask", TaskContact="Send Mail Task; Microsoft Corporation; SQL Server 2019; © 2019 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.SendMailTask.SendMailTaskUI, Microsoft.SqlServer.SendMailTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
public sealed class SendMailTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.SendMailTask.IDTSSendMailTask

[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.sendmailtask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.SendMailTask.SendMailTaskMessages), SamplesTag="SsisSendMailTask", TaskContact="Send Mail Task; Microsoft Corporation; SQL Server 2016; © 2015 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.SendMailTask.SendMailTaskUI, Microsoft.SqlServer.SendMailTaskUI, Version=13.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
type SendMailTask = class
    inherit Task
    interface IDTSComponentPersist
    interface IDTSSendMailTask
    interface IDTSBreakpointSite
    interface IDTSSuspend

[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.sendmailtask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.SendMailTask.SendMailTaskMessages), SamplesTag="SsisSendMailTask", TaskContact="Send Mail Task; Microsoft Corporation; SQL Server 2017; © 2017 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.SendMailTask.SendMailTaskUI, Microsoft.SqlServer.SendMailTaskUI, Version=14.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
type SendMailTask = class
    inherit Task
    interface IDTSComponentPersist
    interface IDTSSendMailTask
    interface IDTSBreakpointSite
    interface IDTSSuspend

[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.sendmailtask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.SendMailTask.SendMailTaskMessages), SamplesTag="SsisSendMailTask", TaskContact="Send Mail Task; Microsoft Corporation; SQL Server 2019; © 2019 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.SendMailTask.SendMailTaskUI, Microsoft.SqlServer.SendMailTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
type SendMailTask = class
    inherit Task
    interface IDTSComponentPersist
    interface IDTSSendMailTask
    interface IDTSBreakpointSite
    interface IDTSSuspend

Public NotInheritable Class SendMailTask
Inherits Task
Implements IDTSBreakpointSite, IDTSComponentPersist, IDTSSendMailTask

継承: Object

DtsObject

Task
SendMailTask

属性: DtsTaskAttribute

実装: IDTSBreakpointSite IDTSComponentPersist IDTSSuspend IDTSSendMailTask

例

次のコードサンプルでは、新しい 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

注釈

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

コンストラクター

SendMailTask()

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

プロパティ

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

メソッド

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

適用対象

SendMailTask クラス

定義

例

注釈

コンストラクター

プロパティ

メソッド

適用対象

その他のリソース