Configuring the Receiver Mail
Adapter
Use
You configure the receiver mail adapter to convert XI messages to e-mails.
Integration
You configure the
adapter on the Parameters tab page during the definition of a communication
channel in the
Integration Server
or in the PCK. In addition
to the adapter configuration, you can use the Module tab page in the module processor
to specify generic modules, which give the adapter additional functions.
Prerequisites
1. You have created a new communication channel or have opened an existing one.
2. On the Parameters tab page you have selected the adapter type Mail.
3. You have selected the Receiver radio button to define the adapter as a receiver adapter.
Activities
To configure the adapter, specify the following:
Transport Protocol
● SMTP
You use SMTP (Simple Mail Transfer Protocol) to transfer e-mails to an e-mail server.
● IMAP4
You use IMAP4 (Internet Message Access Protocol) to put e-mails in a folder of an e-mail server.
Message Protocol
● XIALL
In this mode, all information of the XI message is put in the message text of the e-mail. The content of the XI message is the same as the content of the RFC822 mail message.
● XIPAYLOAD
In this mode, the payload of the XI message is used to create the mail message.
If the payload is in mail package format, the header information is also used for the e-mail. If mail package format is not used, the header information is obtained from the adapter configuration described below.
Adapter Engine
Select the Adapter Engine on the Integration Server, or select a non-centrally installed Adapter Engine. This selection is not available in the PCK.
General Tab Page
Connection Parameters for Mail Server
Field |
Entry |
URL |
Enter the address of the e-mail server: ● For SMTP: smtp://mailserver, for example ● For imap: //imapserver/XIOutBox, for example |
Configure User Authentication |
Choose the Authentication Method. ● Plain ● CRAM-MD5 If the server expects a logon, set the indicator. ● Enter the User for logging on to the server. ● Enter the Password and confirm. |
Send Delivery Status Notification |
● If you want to receive a delivery status notification, set the indicator. ● Enter the e-mail address of the receiver of the delivery status notification. |
Mail Attributes for Message Protocol XIPAYLOAD
● If you have selected XIPAYLOAD as the message protocol and have a mail package document as the XI payload, select Use Mail Package.
If the XI payload is not available as a mail package document, make the entries for mail attributes (From, To, Subject).
For the format, see Example below.
● Specifications for mail attributes:
○ Under From, specify the e-mail address from which the message is sent.
○ Under To, specify the e-mail address that is to receive the message. If you enter more than one address, you must separate them with a semicolon.
○ If you have specified an IMAP server under URL, the message is saved in the specified folder but is not sent to the receiver specified under To.
○ Under Cc, specify the other e-mail addresses to which the e-mail is to be sent.
These addresses are visible to the receiver.
○ Under Bcc, specify the other e-mail addresses to which the e-mail is to be sent.
These addresses are not visible to the receiver.
○ Enter the Subject of the e-mail message.
○ Specify whether you want to encode the content of the e-mail message. You have the following options:
■ None
■ Base64 (default value)
○ If you have selected XIPAYLOAD as the message protocol and you want to forward XI attachments in the e-mail attachments, select Keep Attachments.
You use the PayloadSwapBean module to swap the application payload with one of the attachments.
See:
PayloadSwapBean
Security Parameters for Message Protocol XIPAYLOAD
● If you want to encrypt e-mails and give them a digital signature in the corresponding receiver agreement in the Integration Server or in the PCK, select S/MIME.
More information: Security Settings for Receiver Mail Adapter
To do this, you must have set the Keep Attachmentsindicator.
● Specify the Persist Duration. This specification is not currently used, but is to be used in the future for security archiving.
Advanced Tab Page
Adapter-Specific Message Attributes
To process adapter attributes in the message header of the XI message, select Use Adapter-Specific Message Attributes and Variable Transport Binding. The following attributes in the message header are available for processing:
Meaning |
Technical name |
User |
TServerLocation |
Authentication Keys |
TAuthKey |
Mail header 'from' field |
THeaderFROM |
Mail header 'to' field |
THeaderTO |
Mail header 'Cc' field |
THeaderCC |
Mail header 'Bcc' field |
THeaderBCC |
Mail header 'subject' field |
THeaderSUBJECT |
Mail header field for reference to mail which is being replied to |
THeaderIN-REPLY-TO |
Mail header 'reply to' field |
THeaderREPLY-TO |
Mail header field for mail client program |
THeaderX-MAILER |
Mail header field for delivery acknowledgement |
THeaderDISPOSITION-NOTIFICATION-TO |
Mail header field for priority |
THeaderPRIORITY |
Mail header field for message importance |
THeaderIMPORTANCE |
To set fields that are not in the table, select Variable Header. You use these fields to forward additional header information.
The technical names for the fields are XHeaderName1, XHeaderName2, XHeaderName3. The parameters are embedded in the mail header under the names you enter here.
The attribute namespace for the adapter is http://sap.com/xi/XI/System/Mail.
Authentication Keys
If authentication is required for the receiver system, you can enter a password and a confirmation for each key value. This means that you do not need to write passwords in the enhanced message header.
If you want to enter or display the respective authentication key, select View Authorization Keys. You can enter and confirm passwords for each authentication key value (TAuthKey).
Adapter Status
Set the adapter to Active to enable messages to be exchanged.
Advanced Mode
To specify additional parameters for the adapter configuration, select Advanced Mode.
● Specify the additional parameter names and parameter values in the table.
● To prevent the content disposition header being generated automatically, enter the parameter name OMail.AddContentDisposition with value false.
If the content disposition header was generated in a module, for example, this parameter has no effect.
If you do not set the parameter, the header is generated by the adapter.
Example
XI payload with mail package:
<?xml version="1.0" encoding="UTF-8"?>
<ns:Mail xmlns:ns="http://sap.com/xi/XI/Mail/30">
<Subject>Subject</Subject>
<From>namea@company.com</From>
<To>nameb@company.com</To>
<Reply_To />
<Content_Type>text/plain</Content_Type>
<Content>
This is the content.
</Content>
</ns:Mail>