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-адрес протокола 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)	Проверяет, правильно ли настроена задача.