Configuring the Sender Mail
Adapter
Use
You configure the sender mail adapter to convert e-mails to XI messages.
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 to specify generic modules in the module
processor, 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 Sender radio button to define the adapter as a sender adapter.
Activities
To configure the adapter, specify the following:
Transport Protocol
● You use IMAP4 (Internet Message Access Protocol) to retrieve e-mails from a folder of an e-mail server.
● You use POP3 (Post Office Protocol Version 3) to retrieve e-mails from an e-mail server.
Message Protocol
● XIALL
In this mode,
the content of the RF C822 e-mail matches the content of the XI message. The
XI message is a multipart MIME message with a SOAP envelope as its first part.
See also:
Messages, under
XI Message
Protocol.
● XIPAYLOAD
In this mode, the content of the e-mail is put in the payload of the XI message. If you do not set the Use Mail Package indicator, the information about the sender (From), receiver (To), and subject of the e-mail is lost.
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 mail server, for example imap://imapserver/XIInBox. |
Configure User Authentication |
If user authentication is required, set the indicator and specify the following: ● Simple ● CRAM-MD5 Make the following entries: ● Specify the user for accessing the server. ● Enter the Password and a confirmation. |
Poll Interval (min.) |
Time interval after which e-mails are called on the server. |
Delete Messages Once Read |
If you have selected IMAP4 as the transport protocol, you can specify here whether the messages are to be deleted on the e-mail server after reading. You can then specify a Folder for Deleted Messages on the server. |
Generate Fetch Report |
If you want to generate a report for every adapter poll procedure, set the indicator. An XI message with the following information is generated: ● Interface namespace: http://sap.com/xi/XI/Mail/30 ● Interface Name: FetchReport |
Mail Attributes for Message Protocol XIPAYLOAD
If you have selected XIPAYLOAD as the message protocol, you must make the following additional specifications under Mail Attributes:
● If you want to put the entire e-mail message including the header information (From, To, Subject) in the payload, set the Use Mail Package indicator. See the example below. The header information is included in an XML mail package format.
● Specify whether you want to encode the content of the e-mail. You have the following options to do this:
○ None
○ base64
● If you want to forward e-mail attachments in XI attachments, set the Keep Attachments indicator.
You use the
PayloadSwapBean
module to replace the application payload with one of the
attachments.
Security Parameters for Message Protocol XIPAYLOAD
● If you want to decrypt and validate encrypted and digitally signed e-mails in the corresponding sender agreement in the Integration Server or in the PCK, set the S/MIME indicator. See also: Security Settings for the Sender Mail Adapter
To do this, you must have set the Keep Attachmentsindicator.
In addition, enter the following parameters and values in the table in Advanced Mode:
XI.ReceiverParty
XI.ReceiverService
The values you enter here must match the values for Receiver Party and Receiver Service in the corresponding sender agreement.
● Specify the Persist Duration. This specification is not currently used, but will be used in the future for security archiving.
Further Parameters for Message Protocol XIPAYLOAD
● XI Parameters
Specify the Interface Namespace and the Interface Name.
● Processing Parameters
Select the quality of service.
For Exactly Once In Order, enter the Queue Name.
See:
Quality of
Service
Advanced Tab Page
Adapter-Specific Message Attributes
To store adapter attributes in the message header of the XI message, set the Set Adapter-Specific Message Attributes indicator.
The following attributes are added to the XI message header if the sender makes them available, and if the Variable Transport Binding indicator is set.
Description |
Technical Name |
User of mail account |
SUser |
Mail header 'From' field |
SHeaderFROM |
Mail header 'To' field |
SHeaderTO |
Mail header 'Subject' field |
SHeaderSUBJECT |
Mail header 'Cc' field |
SHeaderCC |
Mail header field for reference to mail to which this message replies |
SHeaderIN-REPLY-TO |
Mail header field |
SHeader-REPLY-TO |
Mail header field for mail client program |
SHeaderX-MAILER |
Mail header field for delivery acknowledgement |
SHeaderDISPOSITION-NOTIFICATION-TO |
Mail header field for priority |
SHeaderPRIORITY |
Mail header field for message importance |
SHeaderIMPORTANCE |
To use further header fields, set the relevant indicator. You can then store the following attributes and their values in the XI message header:
Description |
Technical Name |
Variable Header |
XHeaderName1 |
Variable Header |
XHeaderName2 |
Variable Header |
XHeaderName3 |
The attribute namespace for the adapter is http://sap.com/xi/XI/System/Mail.
Adapter Status
Set the adapter to Active to enable messages to be exchanged.
Advanced Mode
To specify additional parameters in the adapter configuration, set the Advanced Mode indicator.
Specify the additional parameter names and parameter values in the table:
● For the security settings, enter values for the receiver party and receiver service here.
● In the table, set the parameter IMail.AssumeXMLContent = true. The text of the message is then interpreted as XML and is copied unchanged to the mail package. If this parameter is not set, the information is copied from the content type of the MIME header. If the type specified there is application/xml or text/xml, the text of the message is copied as XML; otherwise it is copied as text.
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>