Copyright © Cloud Software Group, Inc. All Rights Reserved

Send Mail

Activity

The Send Mail activity sends an email by way of a SMTP server.

Configuration

The Configuration tab has the following fields.

Field	Global Var?	Description
Name	No	The name to appear as the label for the activity in the process definition.
Description	No	Short description of the activity.
Host	Yes	Host name for the SMTP server. The default port (25) is used to connect to the SMTP server. If your server is configured to use a different port, you can specify it in this field using the syntax:   <hostName>:<portNumber> For example, myMailServer.myCo.com:37
SSL	No	The Use SSL check box specifies that Secure Sockets Layer (SSL) should be used to specify a client SSL configuration. When this field is checked, the Configure SSL button is enabled.
Authenticate	No	Specifies whether you want to authenticate to the mail server. When selected, the Authentication Type field appears. Note: The mail server must be configured to require authentication for sending mail. If the mail server is not configured to require authentication, the Authentication Type field is ignored.
Authentication Type	No	Two types of authentication are supported: OAuth 2.0 and Basic Authentication. If you select Basic Authentication, then the User Name and Password fields appear. If you select OAuth 2.0, then the User Name and Access Token Value fields appear. Note: You can obtain the field information for Access Token Value, User Name, and Password from a Service Provider.
User Name	Yes	User name to use when authenticating to the mail server.
Password	Yes	Password to use when authenticating to the mail server. Passwords entered in this field will be encrypted when stored in the project.
Access Token Value	Yes	The value authorized by the authorization server’s token endpoint.
Upgrade Configuration	No	This field only appears in Mail palette resources placed into process definitions prior to release 5.2.0. In previous releases, attachments were lists in the input of the activity. In release 5.2.0 or later, a new schema is used to handle MIME attachments. If you have a Mail palette resource created prior to release 5.2.0, this field should be unchecked to maintain backward compatibility. This field does not appear for new resources created in release 5.2.0 or later. Unchecking this field disables the Input Headers tab and changes the input schema.

Configure SSL Button

The Configure SSL button allows you to configure the SSL parameters when the transport supports SSL. Check SSL to display Configre SSl dialog. Provide values in the following fields to configure SSL.

Field	Global Var?	Description
Trusted Certificates Folder	No	Folder in the project containing one or more certificates from trusted certificate authorities. This folder is checked when an invocation is made to the partner service to ensure that the server is trusted. This prevents connections to rogue servers.
Identity	No	This is an identity resource that contains the client's digital certificate and private key. See TIBCO Designer Palette Reference for more information.
Verify Host Name	No	Specifies whether to verify that the host you are connecting to is the expected host. The host name in the host's digital certificate is compared against the value you specify in the Expected Host Name field. If the host name does not match the expected host name, the connection is refused.
Strong Cipher Suites Only	No	Specifies that only cipher suites with strong encryption should be used, if they are available on the host you are connecting to.

Support for STARTTLS

Some Mail servers (such as Microsoft Exchange 2010 ) support SMTP over SSL using the STARTTLS feature. TIBCO ActiveMatrix BusinessWorks supports this using the property, "bw.plugin.mail.enableStartTLS," which is set to default as "false". Select the 'Use SSL' check box when using such servers and provide the Trusted Certificates folder.

When not using such servers, provide this engine property for SMTP with value as "false".

Advanced

The Advanced tab has the following fields.

Field	Global Var?	Description
Allow Non-Standard Email IDs	No	By default, email IDs specified in the to, from, cc, bcc, or replyTo input elements must conform to the RFC 822 standard for email addresses. Checking this box allows you to specify email IDs that do not conform to the RFC 822 standard. This is useful if you want to send mail to a server that has extensions for sending email to devices such as a fax machine. For more information about email address syntax, see http://www.faqs.org/rfcs/rfc822.html. Note: When this field is unchecked, not all of the RFC 822 syntax rules are enforced. For example, addresses composed of simple names (with no "@domain" part) are allowed. For more information on enforcing RFC 822, see the description of the strict flag of the parse method of javax.mail.internet.InternetAddress at http://java.sun.com/products/javamail/javadocs/javax/mail/internet/InternetAddress.html.

Input Headers

You may want to add custom headers to outgoing mail messages. The Input Headers tab allows you to define a custom schema for the headers of the outgoing mail message. You can specify any standard header supported by the javax.mail package. For example, X-Mailer or X-Priority.

See Appendix A, Specifying Data Schema for a complete description of using the Input Headers tab.

Input

See TIBCO ActiveMatrix BusinessWorks Process Design for more information about mapping and transforming input data.

The input for the activity is the following.

Input Item	Datatype	Description
username	string	Username to use when authenticating to the mail server. Note: The mail server must be configured to require authentication for sending mail. If the mail server is not configured to require authentication, the username and password elements are ignored.
password	string	Password to use when authenticating to the mail server.
from	string	The email address of the sender.
to	string	The recipient list for the email. This is a repeatable element, so that you can send mail to more than one recipient. You can also supply a list of recipients in a single string by using either a comma or a semicolon (but not both in the same string) to separate the recipients.
cc	string	The cc (carbon copy) list for the email. This is a repeatable element, so that you can place more than one recipient on the CC list. You can also supply a list of CC recipients in a single string by using either a comma or a semicolon (but not both in the same string) to separate the CC recipients.
bcc	string	The bcc (blind carbon copy) list for the email. This is a repeatable element, so that you can place more than one recipient on the BCC list. You can also supply a list of BCC recipients in a single string by using either a comma or a semicolon (but not both in the same string) to separate the BCC recipients.
replyTo	string	The reply to list for the email. This is a repeatable element, so that you can place more than one recipient on the reply to list. You can also supply a reply to list in a single string by using either a comma or a semicolon (but not both in the same string) to separate the addresses in the list.
subject	string	The subject of the email.
sentdate	string	The date stamp for the email. Note: The email server supplies the actual date stamp for the email, so this input item is ignored. This item is deprecated and may be removed in a future release. Do not attempt to place a value in this input item.
Fields available when the Upgrade Configuration field is checked
bodyElement	complex	This element contains a choice element. You can either supply the bodyText element or the fileName element. The bodyText element is a string containing the body of the message. The fileName element is the path and name of a file containing the body of the message.
Headers	complex	This element contains the schema you defined on the Input Headers tab. You can specify custom headers for outgoing mail messages. You can specify any standard header supported by the javax.mail package. For example, X-Mailer or X-Priority. If you want to use attachments, make sure the Content-Type header is specified as multipart/* (where * is a valid subtype of multipart).
mimeEnvelope Element	complex	This element contains the message attachments. This element contains a repeating element named mimePart that contains each mime attachment.
mimeHeaders	complex	This element contains the mime header for each mimePart. Mime headers can contain the following information: • content-disposition — To suggest a filename for an attachment, use "*;filename=<filename>" in this element. Note: E-mail servers may alter or choose to ignore the suggested name. • content-type • content-transfer-encoding • content-id • other mime header information See http://www.faqs.org/rfcs/rfc2045.html for more information about MIME headers and their syntax. Note: When the content type is specified as "text/*" (for example, "text/xml"), the attachment content is expected to be in either the textContent input element or the file name storing the attachment is expected to be in the fileName input element. When the content type is anything other than "text/*", the attachment content is expected to be in either the binaryContent input element or the file name storing the attachment is expected to be in the fileName input element.
binaryContent | textContent | fileName	choice	This element contains the mime attachment. The element can be one of the following: • binaryContent — content of the attachment when the attachment is binary data. • textConetnt — content of the attachment when the attachment is text data. • fileName — the file name of the attachment written to the disk.
Fields available when the Upgrade Configuration field is unchecked
bodyText	string	The text of the email message.
attachmentNames	string	A list of names for each attachment to the message. These names are typically the file names of the attachments. Note: The attachmentNames and attachmentData elements are corresponding lists. That is, for each item in the attachmentName element, there must be a corresponding item in the same position in the attachementData list. For example, if there are three attachments, both elements must contain three items and item in the attachmentNames element corresponds to the element in the same position in the attachmentData list.
attachmentData	binary	A list of attachments to the message.
contentType	string	The MIME content type for the message. You can specify a character encoding in this element for the encoding of the body of the message.

 

Output

This activity produces no output.

Error Output

The Error Output tab lists the possible exceptions that can be thrown by this activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information about error codes and corrective action to take.

Exception	Thrown When...
InvalidInputException	Input is not valid.
UnknownHostException	Mail server host name could not be resolved. The exception contains the mail server host name.
SendFailedException	The send operation failed for any reason.

Copyright © Cloud Software Group, Inc. All Rights Reserved