The E-mail Client communication point is typically used to populate a database with information received by email. Information contained in the body of an email message or in an attachment can be extracted and processed by the Rhapsody engine.
Alternatively, information can be routed from Rhapsody and placed in either the message body or in an attachment before being emailed to one or more recipients. A typical use of this feature is to alert an administrator when specified events, such as failures, occur in the Rhapsody engine.
In this mode, Rhapsody can also be configured so the email message can contain both an attachment and body text by way of message properties on the route. As this mode uses message properties to populate the email body text, the amount of available text is limited to the property length set in code.
Supported Operational Modes: Input, Output
Input Mode Properties
Property |
Description |
---|---|
Mail Server |
The hostname or IP address of the mail server. If the mail server is behind a firewall, use the IP/DNS name of the firewall. Ensure the firewall is configured to enable NAT (Network Address Translation). |
Store Protocol |
The protocol used to retrieve mail from the mail server:
|
POP3 Port |
The port to connect on when using the POP3 protocol. The default port is |
IMAP Port |
The port to connect on when using the IMAP protocol. The default port is |
Use SSL |
Specifies whether Secure Sockets Layer (SSL) or Transport Layer Security (TLS) should be used to provide secure communications for this connection. Refer to TLS/SSL Support in Rhapsody for details.
It is recommended that SSL be enabled for the E-mail Client communication point whenever it is supported by the remote server. |
SSL Protocol Mode |
Refer to SSL Protocol Versions for details. |
SSL Cipher Suites |
Refer to SSL Cipher Suites for details. |
Trusted Certificates |
Identifies the trusted certificates used by the mail server's SSL connection. If it is not configured with the mail server's certificate, then the SSL connection operates in anonymous server authentication mode. It is highly recommended that the mail server's certificate always be provided here to allow server authentication to be performed. Refer to Server Authentication for details. |
Read Timeout (ms) |
The timeout in milliseconds while waiting for a response from the mail server. The default is |
Connection Timeout (ms) |
The connection timeout in milliseconds while attempting to establish a connection to the mail server. The default is |
User |
The username or ID of the user for authenticating with the mail server. |
Password |
The password of the user for authenticating with the mail server. |
Folder |
The name and path of the mail folder which contains the message (Inbox by default). The POP3 protocol does not support folders. |
Refresh Rate |
Specifies the frequency (in milliseconds) at which the folder is checked for new messages. The default is |
Delete Message |
Determines whether or not messages are to be permanently deleted from the input folder once they have been processed by Rhapsody:
|
Receiving Mode |
Determines how the Rhapsody message is set using the received email. It can either be part of the incoming message (normal mode), the entire email body or the entire email envelope:
|
Message as Attachment |
Determines whether or not the contents of the email attachment should become the Rhapsody message body:
|
Extracted Headers |
Email headers to extract from the incoming message and set as Rhapsody message properties. Options can be set for each property to determine whether it is decoded, and how repeating headers are handled:
|
JavaMail debugging |
Enables JavaMail debugging to standard output:
|
Output Mode Properties
Property |
Description |
---|---|
Mail Server |
The hostname or IP address of the mail server. If the mail server is behind a firewall, use the IP/DNS name of the firewall. Ensure the firewall is configured to enable NAT (Network Address Translation). |
Protocol |
The protocol used to communicate with the mail server. The default is SMTP (Simple Mail Transfer Protocol). |
Port |
The port to use when sending messages. The default is |
Use SSL |
Specifies whether Secure Sockets Layer (SSL) or Transport Layer Security (TLS) should be used to provide secure communications for this connection. Refer to TLS/SSL Support in Rhapsody for details.
It is recommended that SSL be enabled for the E-mail Client communication point whenever it is supported by the remote server. This can be done either by enabling this setting or by selecting SMTPS for the Protocol. |
SSL Protocol Mode |
Refer to SSL Protocol Versions for details. |
SSL Cipher Suites |
Refer to SSL Cipher Suites for details. |
Trusted Certificates |
Specifies the trusted certificates used by the mail server's SSL connection. If it is not configured with the mail server's certificate, then the SSL connection operates in anonymous server authentication mode. It is highly recommended that the mail server's certificate always be provided here to allow server authentication to be performed. Refer to Server Authentication for details. |
Read Timeout (ms) |
The timeout in milliseconds while waiting for a response from the mail server. The default is |
Connection Timeout (ms) |
The connection timeout in milliseconds while attempting to establish a connection to the mail server. The default is |
User |
The username or ID of the user for authenticating with the mail server. |
Password |
The password of the user for authenticating with the mail server. |
Sending Mode |
Determines the Rhapsody message body that is used to build the outgoing email message:
If you manually attempt to build a multi-part MIME message, there is a risk that you may do so incorrectly such that the message is still technically valid. This could result in a valid message being sent, but one that does not contain what you intend to send. For example, if the MIME boundaries are not correctly constructed, any files that should be attached to the message may instead be embedded as base64 blocks inside the message. Therefore, if you intend to use the raw e-mail modes, you must use appropriate tools to generate the e-mail message. These tools may take the form of external e-mail processing tools executed via a command line filter, or a custom filter that uses proper e-mail libraries to generate or process the message (for example, the JavaMail library). You should not use the standard Batch/De-batch filter or JavaScript filter to pack or unpack the MIME body parts, because they may not perform the task correctly. |
From |
The sender of the message. Example: |
Reply To | The recipients of any replies to the message. This can come from a message property. Multiple recipients can be specified as a list of addresses separated by semicolons. |
To |
The recipient of the message. This can come from a message property. Multiple recipients can be specified as a list of addresses separated by semicolons. |
CC |
The 'Carbon Copy' recipients of the message. This can come from a message property. Multiple recipients can be specified as a list of addresses separated by semicolons. |
Subject |
The text that appears as the subject of the message. The default is |
Send Rhapsody Message |
Determines whether the Rhapsody message should be included in the email. The message may not be wanted in the email for security reasons, when only certain information is to be extracted from the Rhapsody message for the email. |
Replacement Body Text |
Specifies what to send in the message body instead of the Rhapsody message. This can be text, or refer to a message property using the |
Send As Attachment |
Determines whether the information to be emailed is sent as an attachment or as the message body:
|
Attachment Name |
Specifies the name of the attachment containing the message information. The default value is Only available if Send as Attachment is enabled. |
Body Text |
The text entered here appears in the email message body and typically identifies the content of the attachment. Only available if Send as Attachment is enabled. |
MIME content type |
The MIME (Multi-purpose Internet Mail Extensions) content type of the content being sent. By default, this is set to The MIME content type does not dictate the MIME type of the entire email. The email may be composed of multiple MIME parts. For example, if |
S/MIME |
Determines whether the email is to be sent using the S/MIME (Secure Multipurpose Internet Mail Extensions) protocol.
|
S/MIME Option |
Sets the level of security for the message. The security levels are:
Only available if S/MIME is enabled. |
S/MIME Signing Option |
Specifies how the message is signed. There are two ways of encoding signed messages:
MAPI/Internet mail gateways are a good example of situations that require opaque signed messages. As MAPI handles messages and attachments in a proprietary (that is, non-MIME) format, the actual MIME headers are generated at the SMTP gateway, not in the secure mail client. Therefore, a clear signed message signature cannot account for the MIME header's content, which automatically invalidates the digital signature as the message passes through the SMTP gateway. Only available if S/MIME is enabled. If S/MIME Option is set to |
Private Key |
Specifies the sender's private key used to sign the message. This private key must be obtained from a recognized Certificating Authority and imported into the Rhapsody private key store using the Certificate Manager. Only available if the message is signed. |
Digest Algorithm |
The name of the message digest algorithm to use to sign the content of the message. Available algorithms are: MD5 and SHA1. Only available if the message is signed. |
Recipient Certificates |
Identifies the recipients' certificates that the sender uses to encrypt messages intended for those recipients. These certificates must be obtained from the recipients and imported into the Rhapsody certificate store using the Certificate Manager. Only available if the message is encrypted. |
Encryption Algorithm |
The name of the symmetric cipher and the block mode to use to encrypt the content of the message. Available algorithms are: DES-EDE3-CBC and RC2-CBC. Only available if the message is encrypted. |
Message Priority |
The priority assigned to the email:
|
E-mail Headers |
Additional email headers to set on the outgoing email using Rhapsody message properties. This email headers configuration property is optional and if missing or present and empty then we simply do not set any additional email headers.
|
JavaMail debugging |
Enables JavaMail debugging to standard output.
|