SendMailTask 类

定义

命名空间:

Microsoft.SqlServer.Dts.Tasks.SendMailTask

程序集:

Microsoft.SqlServer.SendMailTask.dll

发邮件。 此类不能被继承。

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 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 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）服务器的名称或IP地址。
Subject	接收或设置邮件主题。
SuspendRequired	获得或设置一个布尔值，指示任务在遇到断点时是否应暂停。 当遇到断点时，运行时引擎为任务和容器设置该值。
TargetServerVersion	发邮件。 此类不能被继承。 (继承自 Task)
ToLine	获取或设置收件人的电子邮件地址，如果有多个收件人则用分号分隔。
Version	成员被淘汰;参见备注。 返回任务版本。 此属性为只读。 (继承自 Task)

方法

名称	说明
AcceptBreakpointManager(BreakpointManager)	将 a BreakpointManager 传递给发送邮件任务。 该方法由运行时调用，不用于代码中。
CanUpdate(String)	成员被淘汰;参见备注。 一个布尔值，表示新包的 XML 是否可以更新旧包的 XML。 (继承自 Task)
Equals(Object)	确定两个对象实例是否相等。 (继承自 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)	成员被淘汰;参见备注。 如果 CanUpdate(String) 将 设置为 true，该方法将旧包 XML 更新为新的包 XML。 (继承自 Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)	验证任务配置正确。