SendMailTask Class
Sends an e-mail message. This class cannot be inherited.
Assembly: Microsoft.SqlServer.SendMailTask (in Microsoft.SqlServer.SendMailTask.dll)
Microsoft.SqlServer.Dts.Runtime::DtsObject
Microsoft.SqlServer.Dts.Runtime::Task
Microsoft.SqlServer.Dts.Tasks.SendMailTask::SendMailTask
| Name | Description | |
|---|---|---|
![]() | SendMailTask() | Initializes a new instance of the SendMailTask class. |
| Name | 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. (Inherited from 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. |
![]() | TargetServerVersion | (Inherited from Task.) |
![]() | 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.(Inherited from Task.) |
| Name | Description | |
|---|---|---|
![]() | AcceptBreakpointManager(BreakpointManager^) | Passes a BreakpointManager to the Send Mail task. This method is called by the runtime and is not used in code. |
![]() | CanUpdate(String^) | *** Member deprecated; see Remarks. *** A Boolean that indicates whether the new package XML can update the old package XML.(Inherited from Task.) |
![]() | Equals(Object^) | Determines whether two object instances are equal.(Inherited from DtsObject.) |
![]() | Execute(Connections^, VariableDispenser^, IDTSComponentEvents^, IDTSLogging^, Object^) | Executes the Send Mail task.(Overrides Task::Execute(Connections^, VariableDispenser^, IDTSComponentEvents^, IDTSLogging^, Object^).) |
![]() | GetConnectionID(Connections^, String^) | Gets a String containing the ID of the connection.(Inherited from Task.) |
![]() | GetConnectionName(Connections^, String^) | Gets a String containing the name of the connection.(Inherited from Task.) |
![]() | GetHashCode() | Returns the hash code for this instance.(Inherited from DtsObject.) |
![]() | GetType() | (Inherited from Object.) |
![]() | InitializeTask(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^).) |
![]() | LoadFromXML(XmlElement^, IDTSInfoEvents^) | This method is not callable by your application code. To load a package saved as .xml, use the Application::LoadPackage method. |
![]() | ResumeExecution() | Resumes execution of the task after pausing. The task or container is resumed by the runtime engine. |
![]() | SaveToXML(XmlDocument^, IDTSInfoEvents^) | 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() | (Inherited from Object.) |
![]() | Update(String^%) | |
![]() | Validate(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.
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

