SendMailTask Class
Sends an e-mail message. This class cannot be inherited.
Namespace: Microsoft.SqlServer.Dts.Tasks.SendMailTask
Assembly: Microsoft.SqlServer.SendMailTask (in Microsoft.SqlServer.SendMailTask.dll)
Syntax
'Declaration
Public NotInheritable Class SendMailTask _
Inherits Task _
Implements IDTSComponentPersist, IDTSSendMailTask, IDTSBreakpointSite, IDTSSuspend
'Usage
Dim instance As SendMailTask
public sealed class SendMailTask : Task,
IDTSComponentPersist, IDTSSendMailTask, IDTSBreakpointSite, IDTSSuspend
public ref class SendMailTask sealed : public Task,
IDTSComponentPersist, IDTSSendMailTask, IDTSBreakpointSite, IDTSSuspend
[<SealedAttribute>]
type SendMailTask =
class
inherit Task
interface IDTSComponentPersist
interface IDTSSendMailTask
interface IDTSBreakpointSite
interface IDTSSuspend
end
public final class SendMailTask extends Task implements IDTSComponentPersist, IDTSSendMailTask, IDTSBreakpointSite, IDTSSuspend
Remarks
By using the Send Mail task, a package can send notification messages when tasks in the package work flow succeed or fail. For more information, see Send Mail Task.
Examples
The following code sample creates, configures, and executes a new 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
Inheritance Hierarchy
System.Object
Microsoft.SqlServer.Dts.Runtime.DtsObject
Microsoft.SqlServer.Dts.Runtime.Task
Microsoft.SqlServer.Dts.Tasks.SendMailTask.SendMailTask
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.