SendMailTask Clase

Referencia

Definición

Espacio de nombres:: Microsoft.SqlServer.Dts.Tasks.SendMailTask

Ensamblado:: Microsoft.SqlServer.SendMailTask.dll

Importante

Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.

Envía un mensaje de correo electrónico. Esta clase no puede heredarse.

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

Herencia: Object

DtsObject

Task
SendMailTask

Atributos: DtsTaskAttribute

Implementaciones: IDTSBreakpointSite IDTSComponentPersist IDTSSuspend IDTSSendMailTask

Ejemplos

El ejemplo de código siguiente crea, configura y ejecuta un nuevo 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

Comentarios

Mediante la tarea Enviar correo, un paquete puede enviar mensajes de notificación cuando las tareas del flujo de trabajo del paquete se realizan correctamente o producen un error. Para obtener más información, vea Enviar tarea de correo.

Constructores

SendMailTask()

Inicializa una nueva instancia de la clase SendMailTask.

Propiedades

BCCLine	Obtiene o establece las direcciones de correo electrónico de los destinatarios del campo Con Copia Oculta, delimitados por punto y coma cuando hay más de uno.
CCLine	Obtiene o establece las direcciones de correo electrónico de los destinatarios del campo Con Copia, delimitados por puntos y coma cuando hay más de uno.
DebugMode	Obtiene o establece un valor booleano que indica si el objeto está en modo de depuración y si debe generar el OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) evento mientras se ejecuta.
ExecutionValue	Devuelve un objeto definido por el usuario. Este campo es de solo lectura. (Heredado de Task)
FileAttachments	Obtiene o establece los nombres de los archivos adjuntos al mensaje de correo electrónico, delimitados por el carácter de barra vertical (\|) cuando hay más de un archivo.
FromLine	Obtiene o establece la dirección de correo electrónico del remitente.
MessageSource	Obtiene o establece el cuerpo del mensaje o el nombre del origen que contiene el cuerpo del mensaje.
MessageSourceType	Obtiene o establece un valor que contiene el tipo de origen del cuerpo del mensaje.
Priority	Obtiene o establece la prioridad del mensaje.
SmtpConnection	Obtiene o establece el nombre o la dirección IP del servidor de protocolo simple de transferencia de correo (SMTP).
Subject	Obtiene o establece el asunto del mensaje de correo electrónico.
SuspendRequired	Obtiene o establece un valor booleano que indica si las tareas deben suspenderse cuando encuentran un punto de interrupción. El motor en tiempo de ejecución establece este valor para tareas y contenedores cuando se encuentra un punto de interrupción.
TargetServerVersion	Envía un mensaje de correo electrónico. Esta clase no puede heredarse. (Heredado de Task)
ToLine	Obtiene o establece las direcciones de correo electrónico de los destinatarios, delimitadas por punto y coma si hay más de un destinatario.
Version	* Miembro desusado; ver Comentarios. * Devuelve la versión de la tarea. Esta propiedad es de solo lectura. (Heredado de Task)

Métodos

AcceptBreakpointManager(BreakpointManager)	Pasa BreakpointManager a la tarea Enviar correo. El motor en tiempo de ejecución llama a este método, que no se usa en el código.
CanUpdate(String)	*** Miembro desusado; ver Comentarios. Valor booleano que indica si el nuevo xml del paquete puede actualizar el XML del paquete anterior. (Heredado de Task)
Equals(Object)	Determina si dos instancias de objeto son iguales. (Heredado de DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)	Ejecuta la tarea Enviar correo.
GetConnectionID(Connections, String)	Obtiene una cadena que contiene el identificador de la conexión. (Heredado de Task)
GetConnectionName(Connections, String)	Obtiene una cadena que contiene el nombre de la conexión. (Heredado de Task)
GetHashCode()	Devuelve el código hash de esta instancia. (Heredado de DtsObject)
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)	Inicializa las propiedades asociadas a la tarea. El motor en tiempo de ejecución llama a este método, que no se usa en el código.
LoadFromXML(XmlElement, IDTSInfoEvents)	No se pueden realizar llamadas a este método desde el código de la aplicación. Para cargar un paquete guardado como .xml, utilice el método LoadPackage(String, IDTSEvents).
ResumeExecution()	Reanuda la ejecución de la tarea después de una pausa. El motor de ejecución se encarga de reanudar la tarea o el contenedor.
SaveToXML(XmlDocument, IDTSInfoEvents)	No se pueden realizar llamadas a este método desde el código de la aplicación. Para guardar un paquete como .xml, utilice el método SaveToXml(String, Package, IDTSEvents).
SuspendExecution()	Indica que el ejecutable se debe suspender. El motor de ejecución llama a este método.
Update(String)	*** Miembro desusado; ver Comentarios. Este método actualiza el XML del paquete antiguo con el nuevo XML de paquete si CanUpdate(String) se establece en true. (Heredado de Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)	Comprueba si la tarea está correctamente configurada.

Se aplica a