SendMailTask Klasse

  • Referenz

Definition

Namespace:
Microsoft.SqlServer.Dts.Tasks.SendMailTask
Assembly:
Microsoft.SqlServer.SendMailTask.dll

Sendet eine E-Mail-Nachricht. Diese Klasse kann nicht vererbt werden.

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
Vererbung
Object
DtsObject
Task
SendMailTask
Attribute
DtsTaskAttribute
Implementiert
IDTSBreakpointSite IDTSComponentPersist IDTSSuspend IDTSSendMailTask

Beispiele

Im folgenden Codebeispiel wird ein neues SendMailTaskCodebeispiel erstellt, konfiguriert und ausgeführt.

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

Hinweise

Mithilfe der Aufgabe "E-Mail senden" kann ein Paket Benachrichtigungsnachrichten senden, wenn Aufgaben im Paketarbeitsfluss erfolgreich oder fehlschlagen. Weitere Informationen finden Sie unter "E-Mail-Aufgabe senden".

Konstruktoren

SendMailTask()

Initialisiert eine neue Instanz der SendMailTask-Klasse.

Eigenschaften

BCCLine

Ruft die E-Mail-Adressen der Empfänger ab, die eine Blindkopie der Nachricht erhalten, oder legt sie fest. Falls mehrere Adressen vorhanden sind, werden sie durch ein Semikolon getrennt.
CCLine

Ruft die E-Mail-Adressen der Empfänger ab, die eine Kopie der Nachricht erhalten, oder legt sie fest. Falls mehrere Adressen vorhanden sind, werden sie durch ein Semikolon getrennt.
DebugMode

Ruft einen booleschen Wert ab, der angibt, ob sich das OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) Objekt im Debugmodus befindet und ob das Ereignis beim Ausführen ausgelöst werden soll, oder legt ihn fest.
ExecutionValue

Gibt ein benutzerdefiniertes Objekt zurück. Dieses Feld ist schreibgeschützt.

(Geerbt von Task)
FileAttachments

Ruft die Namen der an die E-Mail-Nachricht angefügten Dateien ab oder legt sie fest. Falls mehrere Dateinamen vorhanden sind, werden sie durch einen senkrechten Strich (|) getrennt.
FromLine

Ruft die E-Mail-Adresse des Absenders ab oder legt sie fest.
MessageSource

Ruft den Nachrichtentext oder den Namen der Quelle ab, die den Nachrichtentext enthält, oder legt ihn fest.
MessageSourceType

Ruft einen Wert ab, der den Quelltyp des Nachrichtentexts enthält, oder legt ihn fest.
Priority

Ruft die Priorität der Nachricht ab oder legt sie fest.
SmtpConnection

Ruft den Namen oder die IP-Adresse des SMTP-Servers (Simple Mail Transfer Protocol) ab oder legt sie fest.
Subject

Ruft den Betreff der E-Mail-Nachricht ab oder legt ihn fest.
SuspendRequired

Ruft einen Booleschen Wert ab oder legt diesen fest, der angibt, ob Aufgaben angehalten werden sollen, wenn ein Haltepunkt auftritt. Dieser Wert wird von der Runtime-Engine für Tasks und Container festgelegt, wenn ein Breakpoint erreicht wird.
TargetServerVersion

Sendet eine E-Mail-Nachricht. Diese Klasse kann nicht vererbt werden.

(Geerbt von Task)
ToLine

Ruft die E-Mail-Adressen der Empfänger ab oder legt sie fest. Falls mehrere Empfänger vorhanden sind, werden die Adressen durch ein Semikolon getrennt.
Version

Mitglied veraltet; siehe Hinweise. *** Gibt die Version des Tasks zurück. Diese Eigenschaft ist schreibgeschützt.

(Geerbt von Task)

Methoden

AcceptBreakpointManager(BreakpointManager)

Übergibt BreakpointManager an den Task "Mail senden". Diese Methode wird von der Laufzeit aufgerufen und wird nicht in Code verwendet.
CanUpdate(String)

Mitglied veraltet; siehe Hinweise. Ein Boolescher Wert, der angibt, ob der neue Paket-XML-Code das alte Paket-XML aktualisieren kann.

(Geerbt von Task)
Equals(Object)

Stellt fest, ob zwei Objektinstanzen gleich sind.

(Geerbt von DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)

Führt den Task "Mail senden" aus.
GetConnectionID(Connections, String)

Ruft eine Zeichenfolge ab, die die ID der Verbindung enthält.

(Geerbt von Task)
GetConnectionName(Connections, String)

Ruft eine Zeichenfolge ab, die den Namen der Verbindung enthält.

(Geerbt von Task)
GetHashCode()

Gibt den Hashcode für diese Instanz zurück.

(Geerbt von DtsObject)
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)

Initialisiert die dem Task zugeordneten Eigenschaften. Diese Methode wird von der Laufzeit aufgerufen und wird nicht in Code verwendet.
LoadFromXML(XmlElement, IDTSInfoEvents)

Diese Methode kann durch den Anwendungscode nicht aufgerufen werden. Um ein im XML-Format gespeichertes Paket zu laden, verwenden Sie die LoadPackage(String, IDTSEvents)-Methode.
ResumeExecution()

Setzt die Taskausführung nach einer Unterbrechung fort. Die Runtime-Engine setzt die Ausführung des Tasks oder Containers fort.
SaveToXML(XmlDocument, IDTSInfoEvents)

Diese Methode kann durch den Anwendungscode nicht aufgerufen werden. Um ein Paket als XML-Datei zu speichern, verwenden Sie die SaveToXml(String, Package, IDTSEvents)-Methode.
SuspendExecution()

Gibt an, dass das ausführbare Element angehalten werden muss. Diese Methode wird von der Runtime-Engine aufgerufen.
Update(String)

Mitglied veraltet; siehe Hinweise. Diese Methode aktualisiert das alte Paket-XML mit dem neuen Paket-XML, wenn CanUpdate(String) er auf true festgelegt ist.

(Geerbt von Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)

Überprüft, ob der Task ordnungsgemäß konfiguriert ist.

Gilt für: