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	Получает или устанавливает имя или IP-адрес сервера Simple Mail Transfer Protocol (SMTP).
Subject	Получает или устанавливает тему письма.
SuspendRequired	Получает или устанавливает булевый индикатор, который показывает, должны ли задачи приостановиться при возникновении точки остановки. Это значение задаётся движком выполнения для задач и контейнеров при обнаружении точки остановки.
TargetServerVersion	Отправляет электронное письмо. Этот класс не наследуется. (Унаследовано от Task)
ToLine	Получает или устанавливает адреса электронной почты получателей, разделяемых точками с запятой, если получателей более одного.
Version	Член уходил из употребления; см. Примечания. Возвращает версию задачи. Это свойство доступно только для чтения. (Унаследовано от Task)

Методы

Имя	Описание
AcceptBreakpointManager(BreakpointManager)	Передаёт задачу BreakpointManager отправить почту. Этот метод вызывается в среде выполнения и не используется в коде.
CanUpdate(String)	Член уходил из употребления; см. Примечания. Булевое значение, указывающее, может ли новый XML пакета обновлять старый XML пакета. (Унаследовано от Task)
Equals(Object)	Определяет, равны ли два экземпляра объекта. (Унаследовано от DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)	Выполняет задачу отправить почту.
GetConnectionID(Connections, String)	Получает строку с идентификатором соединения. (Унаследовано от 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)	Член уходил из употребления; см. Примечания. Этот метод обновляет XML старого пакета с новым XML пакета, если CanUpdate(String) установлен true. (Унаследовано от Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)	Проверяет, правильно ли настроена задача.