SendMailTask Classe
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Envia uma mensagem de email. Essa classe não pode ser herdada.
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
- Herança
- Atributos
- Implementações
Exemplos
O exemplo de código a seguir cria, configura e executa um novo 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
Comentários
Usando a tarefa Enviar email, um pacote pode enviar mensagens de notificação quando as tarefas no fluxo de trabalho do pacote têm êxito ou falham. Para obter mais informações, consulte Enviar email tarefa.
Construtores
SendMailTask() |
Inicializa uma nova instância da classe SendMailTask. |
Propriedades
BCCLine |
Obtém ou define os endereços de email dos destinatários com cópia oculta, delimitados por ponto-e-vírgulas quando há mais de um. |
CCLine |
Obtém ou define os endereços de email dos destinatários com cópia carbono, delimitados por ponto-e-vírgulas quando há mais de um. |
DebugMode |
Obtém ou define um valor booleano que indica se o objeto está no modo de depuração e se ele deve gerar o OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) evento durante a execução. |
ExecutionValue |
Retorna um objeto definido pelo usuário. Este campo é somente leitura. (Herdado de Task) |
FileAttachments |
Obtém ou define os nomes dos arquivos anexados à mensagem de email, delimitados pelo caractere de pipe (|) quando há mais de um arquivo. |
FromLine |
Obtém ou define o endereço de email do remetente. |
MessageSource |
Obtém ou define o corpo da mensagem ou o nome da fonte que contém o corpo da mensagem. |
MessageSourceType |
Obtém ou define um valor que contém o tipo de fonte do corpo da mensagem. |
Priority |
Obtém ou define a prioridade da mensagem. |
SmtpConnection |
Obtém ou define o nome ou endereço IP do servidor SMTP. |
Subject |
Obtém ou define o assunto da mensagem de email. |
SuspendRequired |
Obtém ou define um booliano que indica se as tarefas devem ser suspensas quando encontram um ponto de interrupção. Esse valor é definido pelo mecanismo de runtime para tarefas e contêineres quando um ponto de interrupção é encontrado. |
TargetServerVersion | (Herdado de Task) |
ToLine |
Obtém ou define os endereços de email dos destinatários, delimitados por ponto-e-vírgula quando há mais de um destinatário. |
Version |
*** Membro preterido; consulte comentários. ** _ Retorna a versão da tarefa. Esta propriedade é somente para leitura. (Herdado de Task) |
Métodos
AcceptBreakpointManager(BreakpointManager) |
Passa um BreakpointManager para a tarefa Envia Email. Esse método é chamado pelo runtime e não é usado em código. |
CanUpdate(String) |
*** Membro preterido; consulte comentários. ** _ Um booliano que indica se o novo XML do pacote pode atualizar o XML do pacote antigo. (Herdado de Task) |
Equals(Object) |
Determina se duas instâncias de objeto são iguais. (Herdado de DtsObject) |
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object) |
Executa a tarefa Enviar Email. |
GetConnectionID(Connections, String) |
Obtém uma cadeia de caracteres que contém a ID da conexão. (Herdado de Task) |
GetConnectionName(Connections, String) |
Obtém uma cadeia de caracteres que contém o nome da conexão. (Herdado de Task) |
GetHashCode() |
Retorna o código hash para a instância. (Herdado de DtsObject) |
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker) |
Inicializa as propriedades associadas à tarefa. Esse método é chamado pelo runtime e não é usado em código. |
LoadFromXML(XmlElement, IDTSInfoEvents) |
Esse método não pode ser chamado por seu código de aplicativo. Para carregar um pacote salvo como .xml, use o método LoadPackage(String, IDTSEvents). |
ResumeExecution() |
Retoma a execução da tarefa depois de pausar. A tarefa ou o contêiner é retomado pelo mecanismo de runtime. |
SaveToXML(XmlDocument, IDTSInfoEvents) |
Esse método não pode ser chamado por seu código de aplicativo. Para salvar um pacote como .xml, use o método SaveToXml(String, Package, IDTSEvents). |
SuspendExecution() |
Indica se o executável precisa ser suspenso. Esse método é chamado pelo mecanismo de runtime. |
Update(String) |
*** Membro preterido; consulte comentários. ** _ Esse método atualizará o XML do pacote antigo com o novo XML do pacote se CanUpdate(String) for definido como true. (Herdado de Task) |
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging) |
Verifica se a tarefa está configurada corretamente. |