Send Mail Task Element
X-Ref:
- Ast Send Mail Task Node
- Ast Task Base Node
- Ast Task Node
- Ast Scope Boundary Node
Attributes
| Attribute | API Type | Default | Description |
|---|---|---|---|
| Name | String | Specifies the name of the object. This name can be used to reference this object from anywhere else in the program. This is a required property | |
| ConnectionName | AstSmtpConnectionNode | This value specifies the Simple Mail Transfer Protocol (SMTP) connection to use to send the message. This is a required reference to an existing definiton. | |
| ToLine | String | This value provides the e-mail addresses of recipients of e-mail. This is a required property | |
| BCCLine | String | This value provides the e-mail addresses of recipients of blind carbon copies of e-mail. | |
| CCLine | String | This value provides the e-mail addresses of recipients of carbon copies of e-mail. | |
| DelayValidation | Boolean | false | This value specifies whether the validation of the Dataflow task in SSIS should be delayed until the package is executed. DelayValidation is most often used when the ETL process references tables and other server assets that were created in an earlier stage of the data processing run. |
| Disabled | Boolean | false | This value specifies whether the item is disabled. The default value is False. |
| DisableEventHandlers | Boolean | false | This value specifies whether the event handlers for this task, container, or package should be prevented from executing. The default value is False. |
| ExecutionValueVariableName | AstVariableBaseNode | Specifies a variable to hold the execution results of this component. This references an existing definiton. | |
| FailPackageOnFailure | Boolean | false | This value determines whether the container will fail when a container component fails. If this container corresponds to a package, then the only valid value is False. |
| FailParentOnFailure | Boolean | false | This value determines whether the parent container will fail when a child container failes. The default value is False. |
| ForcedExecutionValue | String | "0" | If the ForceExecutionValue property is set to True, then the container will return the value stored in this property as its execution value. Otherwise, this value will be ignored. The default value for ForecedExecutionValue is 0. |
| ForcedExecutionValueDataType | TypeCode | Int32 | This property specifies the data type of the value stored in the ForceExecutionValue property. |
| ForceExecutionResult | ForceExecutionResult | None | This value indicates whether a specified execution result value will result if the container runs. The default value is None, which means that the container does not force a specified outcome. |
| ForceExecutionValue | Boolean | false | Gets or sets a Boolean that indicates whether the execution value of the container should be forced to contain the value specified in the ForcedExecutionValue property. |
| FromLine | String | This value specifies the e-mail address of the sender of the e-mail. | |
| Id | Guid | 00000000-0000-0000-0000-000000000000 | Allows the developer to specify a unique identifier (GUID) for the package. This can be used to retain a consistent ID between builds. |
| IsolationLevel | IsolationLevel | Serializable | Sets the Isolation Level which controls how Transactions behave for this container. |
| Language | Language | Inherited | This specifies the default language to be used by this task and its descendants. |
| LoggingMode | LoggingMode | Inherit | This value specifies whether logging is enabled or disabled by the container or by the parent container. The default value is UseParentSetting. |
| MaxErrorCount | Int32 | 1 | This value specifies the maximum number of errors allowed to occur before a package is forced to stop running. The default value is 1. |
| Priority | SendMailTaskPriority | Normal | This value specifies specifies the priority of the e-mail message. |
| Subject | String | This value specifies the subject for the e-mail message. | |
| TransactionMode | ContainerTransactionMode | Join | This value specifies the transaction context in which this task will execute. |
Singleton Children
| Child | API Type | Description |
|---|---|---|
| <DirectInput /> | AstDirectResourceNode | The AstDirectResourceNode type provides the facility to directly input text data for use in the referencing Biml object. This is a required property |
| <FileInput /> | AstFileResourceNode | AstFileResourceNode is used for creating references to file connections that have been modeled in the Biml project. This is a required property |
| <VariableInput /> | AstVariableResourceNode | AstVariableResourceNode is used for creating references to variables that have been modeled in the Biml project. This is a required property |
| <PersistFileInput /> | AstPersistFileResourceNode | The AstPersistFileResourceNode type provides the facility to directly input text data and then storing that text data in the specified file for use in the referencing Biml object. This is a required property |
| <ExternalFileInput /> | AstExternalFileResourceNode | The AstExternalFileResourceNode type is used for creating references to a file path on the local file system that has not been modeled in the Biml project as a file connection. This is a required property |
| <PrecedenceConstraints /> | AstTaskflowPrecedenceConstraintsNode | The AstTaskflowPrecedenceConstraintsNode type corresponds directly to a precedence constraint in a SQL Server Integration Services task control flow. |
Collection Children
| Child | API Type | Description |
|---|---|---|
| <Annotations> <Annotation /> </Annotations> | AstAnnotationNode | This is a collection of annotation items that can be used to specify documentation, tags, or other information. Annotations are particularly useful for storing information about nodes that can be used by BimlScript code. |
| <Events> <Event /> </Events> | AstTaskEventHandlerNode | This is a collection of event handlers that can respond to SQL Server Integration Services events that are raised on this task. |
| <Expressions> <Expression /> </Expressions> | AstPropertyExpressionNode | This is a collection of SSIS expression definitions for property value overrides that are specific to this task, container, or package. |
| <FileAttachments> Multiple Choices... </FileAttachments> | AstTaskResourceNode | This is a container for files to be attached to e-mail messages. |
| <LogEvents> <LogEvent /> </LogEvents> | AstLogEventNode | This is a container for log event definitions that are specific to this task, container, or package. |
| <LogProviders> Multiple Choices... </LogProviders> | AstLogProviderBaseNode | Defines the log providers to use for the SSIS task or container This is a container for log provider definitions that are specific to this task, container, or package. |
| <Variables> <Variable /> </Variables> | AstVariableNode | This is a container for variable definitions that are specific to this task, container, or package. |