Description
This operation component uses an SMTP server to send emails to the specified email address.
Options
Basic Options
Host name or IP address of the outgoing mail (SMTP) server.
An argument error occurs if the host name or IP address is omitted.
The maximum length of the host name or IP address is 1,024 characters. An argument error occurs if this is exceeded.
Address of the email sender.
An argument error occurs if the sender's address is omitted.
The maximum length of the sender's address is 1,024 characters. An argument error occurs if this is exceeded.
Destination address of the email.
Delimit with ";" to specify multiple destination addresses.
An argument error occurs if the destination address is omitted.
The maximum length of the destination address is 1,024 characters. An argument error occurs if this is exceeded.
Title of the email.
The maximum length of the title of the email is 1,024 characters. An argument error occurs if this is exceeded.
Body of the email.
The maximum length of the body of the email is 2,048 characters. An argument error occurs if this is exceeded.
Advanced Options
CCs for email.
Delimit with ";" to specify multiple CC.
The email is sent only to the destination address if the CC is omitted.
The maximum length of the CC is 1,024 characters. An argument error occurs if this is exceeded.
Name of the file attached to the email.
Specify a full path including the directory for the file name.
Delimit with ";" to specify multiple file names.
Binary files (such as image files and compressed files) and text files can be specified.
If a text file has been specified, the file is attached to the email without character code conversion.
The maximum length of the file name is 1,024 characters. An argument error occurs if this is exceeded.
Name of the user that is to perform SMTP authentication on the host of the outgoing mail (SMTP) server.
If the user name is omitted, then emails will be sent without SMTP authentication.
The maximum length of the user name is 1,024 bytes. An argument error occurs if this is exceeded.
Password of the user that is to perform SMTP authentication on the host of the outgoing mail (SMTP) server.
If the password is omitted, then emails will be sent without SMTP authentication.
The maximum length of the password required for authentication is 1,024 characters. An argument error occurs if this is exceeded.
The port number for connecting to the outgoing mail (SMTP) server.
Specify the port number using an integer between 0 and 65535. Specify the TCP port number
When no port number is specified, 25 is used.
This is the completion timeout (seconds) for the execution of operation components.
Values between 300 and 86400 (1 day) can be specified.
For example: When timeout is to occur every 10 minutes: 600
When the execution of the operation components is not completed even if the specified time passes, the processing of the operation components is interrupted in return value 201.
This is the retry count for the execution of operation components.
When the operation components end in return value 161, the retry count is specified. Values between 0 and 5 can be specified.
As a result of retrying, if the operation components ended by the return values other than 161, the execution of the operation components ends even if it does not reach the specified retry count. The return values of the operation components become the value executed at the end.
For example: When retries are to be performed twice: 2
This is the retry interval (seconds) for operation components.
When the operation components end in return value 161, the retry interval is specified. Values between 1 and 14400 can be specified.
For example: When retrying in 300 seconds: 300
If the specification of the timeout, retry and retry_interval is omitted, and a value beyond the limits of the above-mentioned is input, the value specified with the operation components definition file becomes effective. Refer to "2.5 Definition File for Operation Components" for details.
Return Values
Icon | Name | Return value | Description |
|---|---|---|---|
| Success | 0 | Email send terminated normally. |
| Failure | 161 | Failed to send email. Retried if a retry count has been specified. |
188 | Connection failed during execution. | ||
189 | An attempt to connect to the server has failed. | ||
197 | There is an error in the option content. | ||
- | - | 201 | Execution of operation component timed out. |
202 | The operation component was not executed. There is a problem in the setting to execute operation components. | ||
203 | Failed to execute the operation component. There is a problem in the Operation Automation Server environment. | ||
205 | The operation component was not executed. There is a problem with the input information specification of the operation component. | ||
206 | The operation component was not executed normally. There is a problem with the output information specification of the operation component. | ||
207 | The operation components were not executed. There is a possibility that the operation components are not registered in the Management Server. | ||
208 | The Automated Operation Process has been canceled because the Automated Operation Process was recovered while the operation component was executing. |
Output information
Variable | Description |
|---|---|
message | This variable will be set to the following message if email has been sent successfully. The operation component was successful. If email transmission fails, the content of the error will be output as a string. |
returnCode | This variable is set to the return value. |
Notes
This operation component uses SMTP communication to perform its operations. Ensure the SMTP server is installed and configured before you use this operation component. Also, encryption of SMTP communication by SSL or TLS is not supported. Communication with an SMTP server that requires either SSL or TLS encryption will result in an error with the return value of 189 or 197.
When using operation components, the communication port which requires communication permission on the Business Server is the number specified in the port option. If no port is specified, it is TCP port 25.
Characters in 'subject' may be garbled if more than 60 characters are used.
If model-dependent characters are specified in the "subject", "text", or "filename" options, these characters may not display correctly depending on which mail server is used.
The file size attached to an email depends on the mail server being used. Check the file size attached to an email with the SMTP server administrator.
The name of the file to be attached may contain alphanumeric, white space and full width characters, and the symbols below.
Symbols that can be used: "!", "~", "_", "-", ".".
Confirm the return values with the Web console. Refer to "Confirming the Operation Component Execution Status/Execution Results" in the Systemwalker Runbook Automation Operation Guide for details.
When the return value of 201-208 is output, the Automated Operation Process enters an abort or error state, and the error message is output to the following places.
Event log of Management Server (when the Management Server is Windows(R))
System log of Management Server (when the Management Server is Linux)
Custom message of BPMN
Confirm the message in either of the above-mentioned place, and take an appropriate action. Refer to the Systemwalker Runbook Automation Message Guide for details.
