Send Single Mail

Operation Name

Send Single Mail

Function Overview

This operation is to send single email using the SOAP API sendEmail() call.

With regarding to the API specification utilized by this operation, please refer to the version of the API document, selected for the Global Resource, in the below-mentioned link.

"Salesforce Developer Documentation"-(https://developer.salesforce.com/docs)
- SOAP API Developer's Guide

Properties

For information about using variables, refer to "variables".

Basic Settings

Item name	Required/Optional	Use of Variables	Description	Supplement
Name	Required	Not Available	Enter the name that appears on the script canvas.

Required Settings

Item name	Required/Optional	Use of Variables	Description	Supplement
Destination	Required	Not Available	Select Global Resources. [Add...]: Add new global resource. [Edit...]: Global resource settings can be edited by [Edit Resource list].	A global resource on API 14.0 or later versions can be specified.
Sender display name	Optional	Available	Input a sender display name.	Maximum length is 200 characters. If omitted, the Salesforce user name who sent the email is displayed.
Reply mail address	Optional	Available	Input a reply-to email address.	When using a Visualforce template in which "replyTo" is specified, do not set a value.
Destination	Optional	-	Input send-to email addresses. You can manipulate each column by the buttons below. [Add]: Add a column [Move Up]: Move up the order of selected column by one [Move Down]: Move down the order of selected column by one [Remove]: Delete the selected column
Destination/Type	Optional	Not Available	Select the sent-to category. [TO]:(default) [CC]: [BCC]:	The maximum numbers of sending emails for each category are shown below. But could differ by API version. [TO]:100 emails [CC]:25 emails [BCC]:25 emails
Destination/Mail address	Optional	Available	Input send-to email addresses.	At least one of TO, CC, BCC or Send-To ID must be set.

Mail Setting

Item name	Required/Optional	Use of Variables	Description	Supplement
BCC sender	Optional	Not Available	Select whether to include the sender in BCC of sending email. [Checked]: Include the sender in BCC. [Not Checked]:(default) Do not include the sender in BCC.	If BCC is selected in Sent-To Address, BCC does not include the sender.
Save as activity	Optional	Not Available	Select whether to record activity history in Salesforce. [Checked]:(default) Record activity history. [Not Checked]: Do not record activity history.	If sender ID or allocation ID is set, activity history is recorded.
Use signature	Optional	Not Available	Select whether to include the user signature specified in the email setting of Salesforce user. [Checked]:(default) Include the user signature. [Not Checked]: Do not include the user signature.
Email priority	Optional	Not Available	Select the email priority. [Highest]: [High]: [Normal]:(default) [Low]: [Lowest]:
Target object ID	Optional	Available	Set data ID such as Contact or User, as send-to address.	At least one of TO, CC, BCC or Send-To ID must be set.
What ID	Optional	Available	Specify data ID that ties to a placeholder of a template.

Message

Item name	Required/Optional	Use of Variables	Description	Supplement
Use template	Optional	Not Available	Select whether to use a template. [Checked]: Use a template. [Not Checked]:(default) Do not use a template.	When using a template, please specify the send-to address ID.
Template ID	Optional	Available	Input a template ID.	If [Use of Template] is checked, this becomes valid.
Form	Optional	Not Available	Select a format. [Text]:(default) An email is sent in text format. [HTML]: An email is sent in HTML format.	If [Use of Template] is not checked, this becomes valid.
Subject	Optional	Available	Input a subject.	If [Use of Template] is not checked, this becomes valid.
Body	Optional	Available	Input a body.	If [Use of Template] is not checked, this becomes valid.
Charset	Optional	Not Available	Select a character set. [ ]:(default) [Japanese Language(Shift-JIS)]: [Simplified Chinese Language(GB2312)]: [Unicode(UTF-8)]: [Korean Language(ks_c_5601-1987)]: [Japanese Language(EUC)]: [Japanese Language(JIS)]: [Traditional Chinese Language(Big5)]: [Western European Language(ISO-8859-1, ISO-LATIN-1)]:	If [ ] is selected, the character code specified in the "Email Character Code" in Salesforce is used.

File Attachment

Item name	Required/Optional	Use of Variables	Description	Supplement
File Attachment	Optional	-	Input attachment files. You can manipulate each column by the buttons below. [Add]: Add a column [Move Up]: Move up the order of selected column by one [Move Down]: Move down the order of selected column by one [Remove]: Delete the selected column	Up to 10MB of total file size, including [Specified by File Path] and [Specified by Document ID], can be attached.
File Attachment/Type	Optional	Not Available	Select a attachment file category. [File path specification]:(default) [Document ID specification]:
File Attachment/File Attachment	Optional	Available	Input a file path or a document ID.	Up to 10MB of total file size, including [File path specification] and [Document ID specification], can be attached. If specified by file path, please input a file system path specified in [File Path is specified in OS Local File System Path].
Specify file path with the OS local file system path	Optional	Not Available	Select whether to specify a file path of attachment file in OS local file system path. [Checked]: Specify a path on OS local file system. The same behavior as before this item is added will be retained. [Not Checked]:(default) Specify a path on DataSpider File System.	If an icon has been created before this item is added, the default value is [Checked]. If [Not Checked] is selected, please specify an absolute path on DataSpider File System. If [Not Checked] is selected, the prohibited characters on the DataSpider File System except for the path delimiter "/" cannot be used. If [Checked] is selected, please specify an absolute path on the server OS local File System.

Comment

Item name	Required/Optional	Use of Variables	Description	Supplement
Comment	Optional	Not Available	You can write a short description of this adapter. The description will be reflected in the specifications.

Schema

Input Schema

None.

Output Schema

None.

Usage on PSP Script

Cannot be used on PSP Script.

Available Component variables

Component Variable Name	Description	Supplement
is_success	The result of sending email is stored.	The default value is null. "True" is stored if the process was successful, and "false" is stored if it failed.
server_url	The end point URL after Login is stored.	The default value is null.
session_id	The session Id is stored.	The default value is null.
error_message	The error message occured during the email sending process is stored.	The default value is null.
message_category	In the case that an error occurs, the category of the message code corresponding to the error is stored.	The default value is null.
message_code	In the case that an error occurs, the code of the message code corresponding to the error is stored.	The default value is null.
message_level	In the case that an error occurs, the importance of the message code corresponding to the error is stored.	The default value is null.
operation_api_exception_code	The ExceptionCode of the occured error, in a case of API error, is stored.	The default value is null. For any error other than an API Error, the value is not stored. The content to be stored may change according to the version of DataSpider Servista.
operation_error_message	If an error occurs, the error message of the occured error is stored.	The default value is null. The content to be stored may change according to the version of DataSpider Servista.
operation_error_trace	When an error occurs, the trace information of the occured error is stored.	The default value is null. The content to be stored may change according to the version of DataSpider Servista.

Specification Limits

In order to perform data reading and writing with this adapter, API's of Salesforce organization must be published.

All permissions for reading/writing data and other operations, as well as data access control, depend upon the profile, shared rule setting and API specifications in Salesforce.

Main exceptions

Exception Name	Reason	Resolution
ResourceNotFoundException Resource Definition is Not Found. Name:[]	[Destination] is not specified.	Specify [Destination].
ResourceNotFoundException Resource Definition is Not Found. Name:[<Global Resource Name>]	The resource definition selected in [Destination] cannot be found.	Verify the global resource specified in [Destination]
java.net.UnknownHostException	This exception occurs when the PROXY server specified in the global resource cannot be found.	Verify the condition of the PROXY server. Or verify [Proxy host] of the global resource specified in the [Destination].
API 23.0 or earlier org.apache.commons.httpclient.HttpConnection$ConnectionTimeoutException API 26.0 or later java.net.SocketTimeoutException connect timed out	A time-out has occurred while connecting to Salesforce.	Verify the network condition and Salesforce server condition. Or check [Connection timeout(sec)] of the global resource specified in the [Destination].
API 23.0 or earlier org.apache.commons.httpclient.HttpRecoverableException java.net.SocketTimeoutException: Read timed out API 26.0 or later java.net.SocketTimeoutException Read timed out	A time-out has occurred while waiting for a responce from the server after connecting to Salesforce.	Verify the network condition and Salesforce server condition. Or check [Timeout(sec)] of the global resource specified in the [Destination].
jp.co.headsol.salesforce.adapter.exception.SalesforceAdapterIllegalArgumentException	Invalid value is set for the property of Salesforce adapter.	Check the error message, and verify the settings.
com.sforce.soap.partner.fault.LoginFault	Login to Salesforce has failed.	Check the ExceptionCode or error message, and refer to the information about this type of error in Salesforce-related documents etc.
com.sforce.soap.partner.fault.UnexpectedErrorFault	An unexpected error has occured while processing to Salesforce.	Check the ExceptionCode or error message, and refer to the information about this type of error in Salesforce-related documents etc.

Notes

An error may occur if invalid characters are specified in "Reply address","TO address","CC address" or "BCC address".

An error may occur if an ID specified in "Attached Document ID" does not exist or is an invalid value.

In the case of using a Visualforce template in which "replyTo" is specified, an eror may occur if [Reply mail address] is set a value.