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)

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.Task
      Microsoft.SqlServer.Dts.Tasks.SendMailTask.SendMailTask

public sealed class SendMailTask : Task, IDTSComponentPersist, 
	IDTSSendMailTask, IDTSBreakpointSite, IDTSSuspend

NameDescription
System_CAPS_pubmethodSendMailTask()

Initializes a new instance of the SendMailTask class.

NameDescription
System_CAPS_pubpropertyBCCLine

Gets or sets the e-mail addresses of the blind carbon copy recipients, delimited by semicolons when there is more than one.

System_CAPS_pubpropertyCCLine

Gets or sets the e-mail addresses of the carbon copy recipients, delimited by semicolons when there is more than one.

System_CAPS_pubpropertyDebugMode

Gets or sets a Boolean indicating whether the object is in debug mode, and whether it should raise the OnBreakpointHit event while running.

System_CAPS_pubpropertyExecutionValue

Returns a user-defined object. This field is read-only. (Inherited from Task.)

System_CAPS_pubpropertyFileAttachments

Gets or sets the names of the files attached to the e-mail message, delimited by the pipe character (|) when there is more than one file.

System_CAPS_pubpropertyFromLine

Gets or sets the e-mail address of the sender.

System_CAPS_pubpropertyMessageSource

Gets or sets the message body or the name of the source that contains the message body.

System_CAPS_pubpropertyMessageSourceType

Gets or sets a value containing the source type of the message body.

System_CAPS_pubpropertyPriority

Gets or sets the priority of the message.

System_CAPS_pubpropertySmtpConnection

Gets or sets the name or IP address of the Simple Mail Transfer Protocol (SMTP) server.

System_CAPS_pubpropertySubject

Gets or sets the subject of the e-mail message.

System_CAPS_pubpropertySuspendRequired

Gets or sets a Boolean that indicates if tasks should suspend when they encounter a breakpoint. This value is set by the runtime engine for tasks and containers when a breakpoint is encountered.

System_CAPS_pubpropertyTargetServerVersion

(Inherited from Task.)

System_CAPS_pubpropertyToLine

Gets or sets the e-mail addresses of the recipients, delimited by semicolons if there is more than one recipient.

System_CAPS_pubpropertyVersion

*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only.(Inherited from Task.)

NameDescription
System_CAPS_pubmethodAcceptBreakpointManager(BreakpointManager)

Passes a BreakpointManager to the Send Mail task. This method is called by the runtime and is not used in code.

System_CAPS_pubmethodCanUpdate(String)

*** Member deprecated; see Remarks. ***   A Boolean that indicates whether the new package XML can update the old package XML.(Inherited from Task.)

System_CAPS_pubmethodEquals(Object)

Determines whether two object instances are equal.(Inherited from DtsObject.)

System_CAPS_pubmethodExecute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)
System_CAPS_pubmethodGetConnectionID(Connections, String)

Gets a String containing the ID of the connection.(Inherited from Task.)

System_CAPS_pubmethodGetConnectionName(Connections, String)

Gets a String containing the name of the connection.(Inherited from Task.)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from DtsObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)

Initializes the properties associated with the task. This method is called by the runtime and is not used in code.(Overrides Task.InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker).)

System_CAPS_pubmethodLoadFromXML(XmlElement, IDTSInfoEvents)

This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.

System_CAPS_pubmethodResumeExecution()

Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.

System_CAPS_pubmethodSaveToXML(XmlDocument, IDTSInfoEvents)

This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.

System_CAPS_pubmethodSuspendExecution()

Indicates that the executable needs to suspend. This method is called by the runtime engine.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodUpdate(String)

*** Member deprecated; see Remarks. ***   This method updates the old package XML with the new package XML if CanUpdate is set to true.(Inherited from Task.)

System_CAPS_pubmethodValidate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)

Verifies that the task is properly configured.(Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

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.

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();
    }

  }

}

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: