Classe SendMailTask

Hiérarchie d'héritage

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

Syntaxe

'Déclaration
Public NotInheritable Class SendMailTask _
    Inherits Task _
    Implements IDTSComponentPersist, IDTSSendMailTask, IDTSBreakpointSite, IDTSSuspend
'Utilisation
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

Constructeurs

	Nom	Description
	SendMailTask	Initializes a new instance of the SendMailTask class.

Haut de la page

Propriétés

	Nom	Description
	BCCLine	Gets or sets the e-mail addresses of the blind carbon copy recipients, delimited by semicolons when there is more than one.
	CCLine	Gets or sets the e-mail addresses of the carbon copy recipients, delimited by semicolons when there is more than one.
	DebugMode	Gets or sets a Boolean indicating whether the object is in debug mode, and whether it should raise the OnBreakpointHit event while running.
	ExecutionValue	Returns a user-defined object. This field is read-only. (hérité de Task.)
	FileAttachments	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.
	FromLine	Gets or sets the e-mail address of the sender.
	MessageSource	Gets or sets the message body or the name of the source that contains the message body.
	MessageSourceType	Gets or sets a value containing the source type of the message body.
	Priority	Gets or sets the priority of the message.
	SmtpConnection	Gets or sets the name or IP address of the Simple Mail Transfer Protocol (SMTP) server.
	Subject	Gets or sets the subject of the e-mail message.
	SuspendRequired	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.
	ToLine	Gets or sets the e-mail addresses of the recipients, delimited by semicolons if there is more than one recipient.
	Version	*** Member deprecated; see Remarks. ***    Returns the version of the task. This property is read-only. (hérité de Task.)

Haut de la page

Méthodes

	Nom	Description
	AcceptBreakpointManager	Passes a BreakpointManager to the Send Mail task. This method is called by the runtime and is not used in code.
	CanUpdate	*** Member deprecated; see Remarks. ***    A Boolean that indicates whether the new package XML can update the old package XML. (hérité de Task.)
	Equals	Determines whether two object instances are equal. (hérité de DtsObject.)
	Execute	Executes the Send Mail task. (remplace Task. . :: . .Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)
	Finalize	(hérité de Object.)
	GetConnectionID	Gets a String containing the ID of the connection. (hérité de Task.)
	GetConnectionName	Gets a String containing the name of the connection. (hérité de Task.)
	GetHashCode	Returns the hash code for this instance. (hérité de DtsObject.)
	GetType	(hérité de Object.)
	InitializeTask	Initializes the properties associated with the task. This method is called by the runtime and is not used in code. (remplace Task. . :: . .InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker).)
	LoadFromXML	This method is not callable by your application code. To load a package saved as .xml, use the Application..::..LoadPackage method.
	MemberwiseClone	(hérité de Object.)
	ResumeExecution	Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.
	SaveToXML	This method is not callable by your application code. To save a package as .xml, use the Application..::..SaveToXml method.
	SuspendExecution	Indicates that the executable needs to suspend. This method is called by the runtime engine.
	ToString	(hérité de Object.)
	Update	*** Member deprecated; see Remarks. ***    This method updates the old package XML with the new package XML if CanUpdate is set to true. (hérité de Task.)
	Validate	Verifies that the task is properly configured. (remplace Task. . :: . .Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

Haut de la page

Notes

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 Tâche Envoyer un message.

Exemples

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

Sécurité des threads

Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.

Voir aussi

Référence