| Name | Type | Optional | ByRef | Description |
|---|---|---|---|---|
| recipientsTo | String | A comma or semi-colon separated list of Email recipients. | ||
| subject | String | The Email Subject. | ||
| body | String | The Email Body, either plain text or HTML. | ||
| html | Boolean | Indicates whether the body is HTML. | ||
| errorCode | String | Optional | ByRef | <para> An Error Code that is set to a different value depending on the reason that this method failed. </para> <para> <list> <item><code>Recipients.NotSpecified</code><description>No recipients specified.</description></item> <item><code>Subject.NotSpecified</code><description>No subject specified.</description></item> <item><code>Body.NotSpecified</code><description>No body specified.</description></item> <item><code>SendEmail.Failed</code><description>The actual process of sending the Email via SMTP failed.</description></item> <item><code>CostCentre.NotSpecified</code><description>No Cost Centre specified in Web Configuration.</description></item> <item><code>CostCentre.Invalid</code><description>Invalid Cost Centre specified in Web Configuration.</description></item> <item><code>CostCentre.Inactive</code><description>Inactive Cost Centre specified in Web Configuration.</description></item> <item><code>Service.NotSpecified</code><description>No Service specified in Web Configuration.</description></item> <item><code>Service.NotConfigured</code><description>No email service details configured in Cost Centre specified in Web Configuration.</description></item> <item><code>Service.NotEnabled</code><description>Email service not enabled in Cost Centre specified in Web Configuration.</description></item> <item><code>Service.NotEnabledEmail</code><description>Email on service not enabled in Cost Centre specified in Web Configuration..</description></item> <item><code>Service.Invalid</code><description>Invalid Service specified in Web Configuration.</description></item> <item><code>CostCentre.InvalidForBranch</code><description>Cost Centre specified in Web Configuration is not valid for any active Branch.</description></item> <item><code>WebConfig.NotEnabled</code><description>WebConfig not enabled.</description></item> </list> </para> |
| recipientsCc | String | Optional | A comma or semi-colon separated list of Email recipients to CC. | |
| recipientsBcc | String | Optional | A comma or semi-colon separated list of Email recipients to BCC. | |
| senderEmailAddress | String | Optional | The Email Address of the Sender or blank to use the details specified under User Preferences. | |
| senderDisplayName | String | Optional | The Display Name of the Sender or blank to use the details specified under User Preferences. | |
| appendSignature | Boolean | Optional | Indicates whether to Append the Signature defined under Global Settings and User Preferences to the end of the Email Body. If omitted, a value of False is assumed. | |
| entityPk | Integer | Optional | If omitted, a value of 0 is assumed. |
A Boolean value indicating success.