SAP AG. Fax via SMTP Partner Requirements

Transcription

1 SAP AG 14 December 2011

2 Table of contents: 1 Introduction Formats SMTP Mail Header MIME Content Outbound Fax - Sending from SAP to SF gateway Inbound Fax - Sending from FS gateway to SAP Addressing Delivery Status Notification Delivery confirmation Delivery failure Processing failure Other failures Detailed Status information Missing NOTIFY command Logging Samples Sending a Fax Receiving a fax References SAP AG Page 2

3 1 Introduction As of SAP NetWeaver 2004 SAP fully supports sending fax messages via SMTP. This new interface has been developed in parallel with the previous RFC based SAPconnect interface BC-CON. SAP recommends to use SMTP as a strategic method. Company Site (Originator) SAP System 1 SMTP Module SAP System 2 SMTP Module SMTP on TCP/IP FAX on Phone Line Mail Server SMTP-aware Fax Server FAX Service Provider Fax Machine This document lists the requirements on SMTP-to-FAX / FAX-to-SMTP gateways (SF/FS gateways), so that they can be used with SAP NetWeaver SAP AG Page 3

4 2 Formats 2.1 SMTP SF/FS gateways must be compliant with RFC Mail Header SF/FS gateways must be compliant with RFC 5322, which defines the format of mail headers. 2.3 MIME Content The document content of outbound as well as inbound Fax messages is a MIME compliant (RFC 2045/2046/2047), singlepart or multipart document Outbound Fax - Sending from SAP to SF gateway SAP applications generate text/plain, text/html, and application/pdf, as well as multipart/alternative, multipart/mixed or multipart/related documents. In addition SAP users may upload and attach files of any type. The SF gateway must at least support text/plain and application/pdf documents. Furthermore it must support multipart/alternative documents that contain a text/html and an alternative text/plain part. It must also support multipart/mixed documents that contain any number of text/plain, application/pdf or multipart/alternative documents. It may support additional common types like graphics and MS Office formats, and may reject any other type. Text/plain and text/html body parts may be sent in any character set. The SF gateway must at least support UTF-8, iso (Latin 1) and US-ASCII. However, it should be able to handle other character sets as well. To allow SAP customers to find a gateway that fits best in their IT infrastructure, gateway providers should document the codepages they support for textual body parts. The content generated by the SAP system is complete in most cases. Therefore it must be possible to configure the SF Gateway in a way that no additional coversheet will be added Inbound Fax - Sending from FS gateway to SAP The FS gateway should send received fax documents to the SAP system as singlepart multi-page graphic of type image/tiff SAP AG Page 4

5 2.4 Addressing Fax numbers will be put into RFC 5322 compliant internet mail addresses according to RFC 3191/3192. In outbound direction both originator address and the recipient address(es) will be RFC 3191/3192 fax numbers. The originator address contains the default domain set in SAPconnect administration and the recipient address(es) contain the SF gateway's domain. In inbound direction the originator address should be an RFC 3191/3192 fax number with the fax server s or service provider s domain, the recipient address should be an RFC 3191/3192 fax number with the SAP system s domain (which has to be customized at the FS gateway). 2.5 Delivery Status Notification For outbound documents the SAP system will request DSNs by using the SMTP service extension Delivery Status Notification (RFC 3461). For inbound documents the FS gateway should request DSNs also in the same way. All DSNs must be compliant to the following RFCs: RFC 3461 Delivery Status Notification RFC 3462 RFC 3463 RFC 3464 The Multipart/Report Content Type for the Reporting of Mail System Administrative Messages Enhanced Mail System Status Codes An Extensible Message Format for Delivery Status Notifications Delivery confirmation If a fax message was successfully processed by the SF gateway and delivered to the fax device and a success-dsn was requested, the SF gateway must send back a delivery confirmation DSN with action "delivered" and status code Delivery failure If a fax message was successfully processed by the SF gateway, but could not be delivered to a fax device, e.g. because of an invalid fax number, and a failure-dsn was requested, the SF gateway must send back a delivery failure DSN with action "failed" and an appropriate status code, e.g (Bad destination mailbox address) or (No answer from host) Processing failure If the SF gateway receives an unknown content-type from SAP and can t process the message content, it must reject the entire fax message. If a failure-dsn was requested it 2011 SAP AG Page 5

6 must send back a delivery failure DSN with action "failed" and status code (Media not supported). If the SF gateway receives a known content-type from SAP and can t process the message content (e.g. an empty or corrupt PDF document), it must reject the entire fax message. If a failure-dsn was requested it must send back a delivery failure DSN with action "failed" and status code (Conversion failed). Under certain circumstances (e.g. if the SF gateway resides in the same local environment as the SAP system) the SF gateway may report a processing failure by an SMTP reply code after the DATA command instead of sending a DSN. In this case the SMTP reply code should be 554 (Transaction Failed) and the text should contain the description of the according DSN code, i.e. "Media not supported" or "Conversion failed" respectively Other failures There might be failure situations which do not fit into the categories mentioned above. The SF/FS-Gateway should set appropriate DSN status codes as described in RFC 3463 or SMTP reply codes as defined in RFC 5321 respectively. In case of a DSN, the diagnosticcode field should be filled accordingly (see also next section) Detailed Status information If any textual information about the processing or delivery status is available, and the SF gateway generates a DSN, then the SF gateway should provide this information in the Diagnostic-Code field as described in RFC 3464, section This information is displayed in the SAPconnect status monitor and should help the sender or administrator to determine the cause of a failure. The diagnostic-type part of this field may contain any value - it must not be empty however. Furthermore, the human readable part of the DSN should contain useful status information if available. This information might be routed back to the sender in the SAP System or to the sender's mailbox depending on the settings in the sending SAP application program Missing NOTIFY command The absence of a NOTIFY parameter in a RCPT command should be interpreted as NOTIFY=SUCCESS. 2.6 Logging The SF/FS gateway should provide a mechanism to obtain an error log for failed transmissions. These logs should at least contain a time stamp, the message id from the internet message headers and detailed error information SAP AG Page 6

7 3 Samples 3.1 Sending a Fax An outbound fax sent from an SAP system to a SF gateway may look like this: Date: Thu, 29 Nov :02: (CET) From: John Doe <FAX= @mydomain.com> Subject: Product Specification Item To: DE <FAX= @fax-provider.com> Message-ID: <ADR @mydomain.com> Importance: Normal X-Priority: 3 (Normal) X-Mailer: SAP Web Application Server 7.10 Content-Type: application/pdf; name="product Specification Item pdf" Content-Transfer-Encoding: base64 Content-Description: Product Specification Item JVBERi0xLjMNCiXi48/TDQoyIDAgb2JqDQo8PA0KL0ZpbHRlciAzIDAgUg0KL0xlbmd0aCA0IDAg Ug0KPj4NCnN0cmVhbQ0KeJwdkE1oE0EYhgcRWS8lSITFH3SUWlYpulalEQVbFbwpCiI5iCKoB0Wk 1CiL/3uIstoKC1ZYaWuSQwsRI24VdaUirFJxrU3ZSK2jDUmHGMscUvkoW/jcdHjnYeadZ+YwDWvO RzZeWE4vL9ukyc0JWdUaN1+UFV2OJaiq0VgHjWnK9oQS02i7prSHTpIqOlVDIaRBY7qihjFpzKDt SSXc7k42HnjYGE+tPZptOvm0pe1ay767ew4ZN9pOM6lhMhplslxY2aTGM2o8p57KqGdysRODsbi9 83TuyJl0ZWlDpWEVk2lVlrlMGZWLdBVT6dRKZWbFut/r1er65orSUtqxtdS6d/pwnNw3iGlKuhEx... The DSN sent back from the FS gateway to the SAP system may look like this: Date: Thu, 29 Nov :07: (MET) From: Fax Provider Gateway <fax-gateway@fax-provider.com> Subject: Delivery Status for <Product Specification Item > To: John Doe <FAX= @mydomain.com> Message-ID: <OF5C8BA19D.B6C1EF24-ONC1256B BD80@fax-provider.com> Content-Type: multipart/report; report-type=delivery-status; boundary="0 =C1256B170037BD808f9e8a93df cC1256B170037BD80" --0 =C1256B170037BD808f9e8a93df cC1256B170037BD80 Your message <Product Specification Item > was delivered to the following addresses: FAX= @fax-provider.com --0 =C1256B170037BD808f9e8a93df cC1256B170037BD80 Content-Type: message/delivery-status Original-Envelope-Id: ADR Reporting-MTA: dns; gateway4.fax.fax-provider.com Original-Recipient: rfc822;fax= @fax-provider.com Final-Recipient: rfc822;fax= @fax-provider.com Action: delivered Status: Diagnostic-Code: x-fax; successfully delivered 2011 SAP AG Page 7

8 --0 =C1256B170037BD808f9e8a93df cC1256B170037BD80 Content-Type: text/rfc822-headers Date: Thu, 29 Nov :02: (CET) From: John Doe Subject: Product Specification Item To: DE Message-ID: Importance: Normal X-Priority: 3 (Normal) X-Mailer: SAP Web Application Server 7.10 Content-Type: application/pdf; name="product Specification Item pdf" Content-Transfer-Encoding: base64 Content-Description: Product Specification Item =C1256B170037BD808f9e8a93df cC1256B170037BD Receiving a fax An inbound fax sent from a FS gateway to an SAP system may look like this: Date: Thu, 29 Nov :02: (CET) From: Fax <FAX= @fax-provider.com> To: FAX= @mydomain.com Subject: Fax from Message-ID: <P Z-97@fax-provider.com> Return-Receipt-To: FAX= @fax-provider.com Content-Type: image/tiff; name="fax tif" Content-Disposition: inline; filename="fax tif" Content-Transfer-Encoding: base64 NUY1RjVGNUY1RjVGNUY1RjVGNUY1RjVGNUY1RjVGNUY1RjVGNUY1RjVGNUY1RjVGNUY1RjVGNUY1 RjVGNUY1RjVGNUY1RjVGNUY1RjVGNUY1RjVGNUY1RjVGNUY1RjVGPlRqIEVUIDAgZyBCVCAzODgu... The DSN sent back from the SAP system to the SF gateway may look like this: Date: Thu, 29 Nov :02: (CET) From: Mail Delivery Subsystem <mailer-deamon@mydomain.com> Subject: Delivery Status for <Fax from > To: FAX= @fax-provider.com Message-ID: < 00306EC3B18C1DECA7D29055A463C7F1@mydomain.com> X-Mailer: SAP Web Application Server 7.10 Content-Type: multipart/report; report-type="delivery-status"; boundary="=_ d9a33448cd548da603ff728" --=_ D9A33448CD548DA603FF728 Content-Type: text/plain; charset="us-ascii"; name="fax from txt" Content-Transfer-Encoding: quoted-printable Content-Description: Fax from SAP AG Page 8

9 Your message with the title <Fax from > was received by server PWDF The message was delivered successfully to the following addresses---- FAX=3D=2B =40mydomain.com --=_ D9A33448CD548DA603FF728 Content-Type: message/delivery-status Reporting-MTA: dns;pwdf0000 Original-Recipient: Final-Recipient: Action: delivered Status: =_ D9A33448CD548DA603FF728 Content-Type: message/rfc822 Content-Transfer-Encoding: 7bit Date: Thu, 29 Nov :02: (CET) From: "Fax " To: Subject: Fax from Message-ID: Return-Receipt-To: Content-Type: image/tiff; name="fax tif" Content-Disposition: inline; filename="fax tif" Content-Transfer-Encoding: base64 NUY1RjVGNUY1RjVGNUY1RjVGNUY1RjVGNUY1RjVGNUY1RjVGNUY1RjVGNUY1RjVGNUY1RjVGNUY1 RjVGNUY1RjVGNUY1RjVGNUY1RjVGNUY1RjVGNUY1RjVGNUY1RjVGPlRqIEVUIDAgZyBCVCAzODgu... --=_ D9A33448CD548DA603FF SAP AG Page 9

10 4 References RFC 5321: Klensin, J., "Simple Mail Transfer Protocol", October RFC 5322: Resnick, P., "Internet Message Format", October RFC 2045: Freed, N. and N. Borenstein, "Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies", November RFC 2046: Freed, N. and N. Borenstein, "Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types", November RFC 2047: Moore, K., "Multipurpose Internet Mail Extensions (MIME) Part Three: Message Header Extensions for Non-ASCII Text", November RFC 3191: Allocchio, C., Minimal GSTN address format in Internet Mail, October RFC 3192: Allocchio, C., Minimal FAX address format in Internet Mail, October RFC 3461: Moore, K. "Simple Mail Transfer Protocol (SMTP) Service Extension for Delivery Status Notifications (DSNs)", January RFC 3462: Vaudreuil, G., "The Multipart/Report Content Type for the Reporting of Mail System Administrative Messages ", January RFC 3463: Vaudreuil, G., "Enhanced Mail System Status Codes", January RFC 3464: Moore, K. and G. Vaudreuil, "An Extensible Message Format for Delivery Status Notifications", January SAP AG Page 10

11 Copyright Copyright 2011 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors. Microsoft, Windows, Excel, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. IBM, DB2, DB2 Universal Database, System i, System i5, System p, System p5, System x, System z, System z10, System z9, z10, z9, iseries, pseries, xseries, zseries, eserver, z/vm, z/os, i5/os, S/390, OS/390, OS/400, AS/400, S/390 Parallel Enterprise Server, PowerVM, Power Architecture, POWER6+, POWER6, POWER5+, POWER5, POWER, OpenPower, PowerPC, BatchPipes, BladeCenter, System Storage, GPFS, HACMP, RETAIN, DB2 Connect, RACF, Redbooks, OS/2, Parallel Sysplex, MVS/ESA, AIX, Intelligent Miner, WebSphere, Netfinity, Tivoli and Informix are trademarks or registered trademarks of IBM Corporation. Linux is the registered trademark of Linus Torvalds in the U.S. and other countries. Adobe, the Adobe logo, Acrobat, PostScript, and Reader are either trademarks or registered trademarks of Adobe Systems Incorporated in the United States and/or other countries. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Oracle Corporation. JavaScript is a registered trademark of Oracle Corporation, used under license for technology invented and implemented by Netscape. SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP Business ByDesign, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and other countries. Business Objects and the Business Objects logo, BusinessObjects, Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, and other Business Objects products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Business Objects S.A. in the United States and in other countries. Business Objects is an SAP company. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty. SAP COMMUNITY NETWORK 2011 SAP AG SDN - sdn.sap.com BPX - bpx.sap.com BOC - boc.sap.com UAC - uac.sap.com