SendMailTask Classe

Référence

Définition

Espace de noms:: Microsoft.SqlServer.Dts.Tasks.SendMailTask

Assembly:: Microsoft.SqlServer.SendMailTask.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Envoie un message électronique. Cette classe ne peut pas être héritée.

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

Héritage: Object

DtsObject

Task
SendMailTask

Attributs: DtsTaskAttribute

Implémente: IDTSBreakpointSite IDTSComponentPersist IDTSSuspend IDTSSendMailTask

Exemples

L’exemple de code suivant crée, configure et exécute un nouveau 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

Remarques

À l’aide de la tâche Envoyer un courrier, un package peut envoyer des messages de notification lorsque les tâches du flux de travail du package réussissent ou échouent. Pour plus d’informations, consultez Envoyer une tâche de courrier.

Constructeurs

SendMailTask()

Initialise une nouvelle instance de la classe SendMailTask.

Propriétés

BCCLine	Obtient ou définit les adresses de messagerie des destinataires en copie conforme invisible, séparées par des points-virgules s'il y en a plusieurs.
CCLine	Obtient ou définit les adresses de messagerie des destinataires en copie, séparées par des points-virgules s'il y en a plusieurs.
DebugMode	Obtient ou définit une valeur booléenne indiquant si l’objet est en mode débogage et s’il doit déclencher l’événement lors de l’exécution OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) .
ExecutionValue	Retourne un objet défini par l'utilisateur. Ce champ est en lecture seule. (Hérité de Task)
FileAttachments	Obtient ou définit les noms des fichiers joints au message électronique, séparés par une barre verticale (\|) lorsqu'il y a plusieurs fichiers.
FromLine	Obtient ou définit l'adresse de messagerie de l'expéditeur.
MessageSource	Obtient ou définit le corps du message ou le nom de la source qui contient le corps du message.
MessageSourceType	Obtient ou définit une valeur qui contient le type de source du corps du message.
Priority	Obtient ou définit la priorité du message.
SmtpConnection	Obtient ou définit le nom ou l'adresse IP du serveur SMTP (Simple Mail Transfer Protocol).
Subject	Obtient ou définit l'objet du message électronique.
SuspendRequired	Obtient ou définit une valeur booléenne qui indique si les tâches doivent s’interrompre lorsqu’elles rencontrent un point d’arrêt. Cette valeur est définie par le moteur du runtime pour les tâches et les conteneurs lorsqu'un point d'arrêt est rencontré.
TargetServerVersion	Envoie un message électronique. Cette classe ne peut pas être héritée. (Hérité de Task)
ToLine	Obtient ou définit les adresses de messagerie des destinataires, séparées par des points-virgules s'il y a plusieurs destinataires.
Version	* Membre déconseillé ; consultez les Remarques. * Retourne la version de la tâche. Cette propriété est en lecture seule. (Hérité de Task)

Méthodes

AcceptBreakpointManager(BreakpointManager)	Transmet un objet BreakpointManager à la tâche Envoyer un message. Cette méthode est appelée par le runtime et n'est pas utilisée dans le code.
CanUpdate(String)	*** Membre déconseillé ; consultez les Remarques. Valeur booléenne qui indique si le nouveau package XML peut mettre à jour l’ancien xml de package. (Hérité de Task)
Equals(Object)	Détermine si les deux instances d'objet sont égales. (Hérité de DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)	Exécute la tâche Envoyer un message.
GetConnectionID(Connections, String)	Obtient une chaîne contenant l’ID de la connexion. (Hérité de Task)
GetConnectionName(Connections, String)	Obtient une chaîne contenant le nom de la connexion. (Hérité de Task)
GetHashCode()	Retourne le code de hachage de cette instance. (Hérité de DtsObject)
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)	Initialise les propriétés associées à la tâche. Cette méthode est appelée par le runtime et n'est pas utilisée dans le code.
LoadFromXML(XmlElement, IDTSInfoEvents)	Cette méthode ne peut pas être appelée par votre code d'application. Pour charger un package enregistré en tant que .xml, utilisez la méthode LoadPackage(String, IDTSEvents).
ResumeExecution()	Reprend l'exécution de la tâche après une suspension. Le moteur du runtime reprend la tâche ou le conteneur.
SaveToXML(XmlDocument, IDTSInfoEvents)	Cette méthode ne peut pas être appelée par votre code d'application. Pour enregistrer un package en tant que .xml, utilisez la méthode SaveToXml(String, Package, IDTSEvents).
SuspendExecution()	Indique que l'exécutable doit s'interrompre. Cette méthode est appelée par le moteur du runtime.
Update(String)	*** Membre déconseillé ; consultez les Remarques. Cette méthode met à jour l’ancien xml de package avec le nouveau xml de package s’il CanUpdate(String) est défini sur true. (Hérité de Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)	Vérifie que la tâche est configurée correctement.

S’applique à