16
Tue, Apr
6 New Articles

Get Wired with MAPI

APIs
Typography
  • Smaller Small Medium Big Bigger
  • Default Helvetica Segoe Georgia Times

In case you haven't noticed, the computing world is getting wired. You can connect computers to each other in ways never before thought possible. Electronic messaging is creating an explosion of information that even computers have trouble sorting through. This presents a problem for developers. There are as many different ways to program and access electronic messaging systems as there are electronic messaging systems. What's a developer to do? Enter messaging application program interface (MAPI).

MAPI is a messaging middleware standard developed by Microsoft with the help of other software vendors, consultants, and users. Like Open Database Connectivity (ODBC), MAPI is a set of application program interfaces (APIs) that sits between client software and server software. Designed to make life easier for developers and users, MAPI provides a way to utilize disparate messaging systems without having to learn each individual system, and it supports independent front- and back-end systems. With MAPI, developers can write a single application that works simultaneously with multiple messaging systems such as IBM OfficeVision, Microsoft Mail, and Novell MHS.

MAPI and E-mail

Using MAPI, you can do some interesting things with E-mail. For example, you can create a program to filter out unwanted messages from your in-box or an electronic form on which users report program problems. You can tie a MAPI program to the AS/400 to send E-mail to the appropriate person when system problems occur. Using the new V3R1 features of DB2/400, you can add a trigger to your inventory file to send E-mail to the purchasing department or even the vendor when stock levels reach a certain point. The world of electronic messaging brings out many exciting possibilities.

Most E-mail systems have four primary components: client software, message store, transport provider, and directory services. The mail client software provides the user interface for the E-mail system. The message store is where the mail is gathered for delivery to the recipient, even if the recipient is offline when the message is sent. The transport provider ships the messages, and directory services determine where and to whom a message is to be delivered. MAPI provides a common interface between these components, even if they are from different vendors.

MAPI supplies the functionality and, optionally, the user interface for mail-enabled and mail-reliant programs. Mail-enabled programs will use an E-mail system if one is available, but their primary functionality does not require a messaging system. A word processor with a "send mail" menu item is an example of a mail-enabled program. Mail-reliant applications require electronic messaging to communicate with the outside world. An example of this type of program is a groupware scheduler. Developers can also use MAPI for program-to-program communications.

1 shows the architecture of a MAPI system. MAPI is really two sets of APIs. One set provides an interface between the mail client software and the front-end to the messaging system. Lotus cc:Mail and Microsoft Exchange have mail clients. These client programs don't actually deliver the mail, but serve as an interface to the mail back-ends. The other API set provides the interface to the back-end mailing system. It simplifies life for back-end mail system developers because they can write to a single API set that provides functionality for many client front-ends. (The back-end APIs are what allow IBM to provide MAPI support in Client Access for Windows.) It simplifies life for front-end developers because they can employ a single API set to interface to many back-end systems.

Figure 1 shows the architecture of a MAPI system. MAPI is really two sets of APIs. One set provides an interface between the mail client software and the front-end to the messaging system. Lotus cc:Mail and Microsoft Exchange have mail clients. These client programs don't actually deliver the mail, but serve as an interface to the mail back-ends. The other API set provides the interface to the back-end mailing system. It simplifies life for back-end mail system developers because they can write to a single API set that provides functionality for many client front-ends. (The back-end APIs are what allow IBM to provide MAPI support in Client Access for Windows.) It simplifies life for front-end developers because they can employ a single API set to interface to many back-end systems.

Choose Your MAPI

MAPI comes in a few different flavors that address the varying needs of developers. The most common in the Windows environment is Simple MAPI. It consists of a few high-level APIs for creating, addressing, and receiving mail. These APIs are listed in 2. Simple MAPI provides optional common dialogs that can be used to present a consistent, familiar interface to the user. It also provides support for file attachments and name resolution. File attachments allow one or more files to be attached to a message, providing a convenient means of exchanging information. Name resolution is useful when users don't know the exact spelling of an addressee's name; it displays a dialog box that allows the user to search based on partial names.

MAPI comes in a few different flavors that address the varying needs of developers. The most common in the Windows environment is Simple MAPI. It consists of a few high-level APIs for creating, addressing, and receiving mail. These APIs are listed in Figure 2. Simple MAPI provides optional common dialogs that can be used to present a consistent, familiar interface to the user. It also provides support for file attachments and name resolution. File attachments allow one or more files to be attached to a message, providing a convenient means of exchanging information. Name resolution is useful when users don't know the exact spelling of an addressee's name; it displays a dialog box that allows the user to search based on partial names.

Another popular mail exchange standard supported by MAPI is the Common Messaging Call (CMC) format. The CMC format is useful for cross-platform mail development, as it is supported by many vendors on OS/2, DOS, Windows, UNIX, and Macintosh platforms. The 10 APIs of the CMC API set map easily to the Simple MAPI APIs, so it shouldn't be too much work to switch between the two.

Extended MAPI is a superset of Simple MAPI that provides hooks for advanced addressing, high-volume messaging, and electronic forms. Electronic forms replace the standard mail interface with a specific form designed for a specific type of message. Using Extended MAPI, you could develop an electronic phone message form that looks like the paper phone message forms you are using but delivers messages to your electronic in-box. It also provides support for routed forms. You could create a purchase order form using Extended MAPI and route it to the appropriate people for denial (or perhaps approval). Extended MAPI's support for address books allows you to group potential addressees in an organized manner.

While not all mail systems speak MAPI, more and more are adopting it as an interface option. For those systems that have it, MAPI presents a welcome change for the developer who used to have to address each E-mail system separately. By providing a single interface for development, MAPI enhances the communication capabilities of many applications. In a future article, we will explain, step by step, how to create a MAPI program. In the meantime, you can find out more about MAPI from Microsoft's MAPI SDK or from numerous third-party books.

Brian Singleton is an associate technical editor for Midrange Computing.

Get Wired with MAPI

Figure 1: MAPI System Architecture



Get Wired with MAPI

Figure 2: Simple MAPI APIs

 Function Description MAPIAddress Addresses a mail message. MAPIDeleteMail Deletes a mail message. MAPIDetails Displays a recipient details dialog box. MAPIFindNext Returns the ID of the next (or first) mail message of a specified type. MAPILogoff Ends a session with the messaging system. MAPILogon Begins a session with the messaging system. MAPIReadMail Reads a mail message. MAPIResolveName Displays a dialog box to resolve an ambiguous recipient name. MAPISaveMail Saves a mail message. MAPISendDocuments Sends a standard mail message using a dialog box. MAPISendMail Sends a mail message, allowing greater flexibility in message generation than MAPISendDocuments. 
Brian Singleton
Brian Singleton is former editor of Midrange Computing. He has worked in the IBM midrange arena for many years, performing every job from backup operator to programmer to systems analyst to technology analyst for major corporations and IBM Business Partners. He also has an extensive background in the PC world. Brian also developed a line of bestselling Midrange Computing training videos, authored the bestselling i5/OS and Microsoft Office Integration Handbook, and has spoken at many popular seminars and conferences.

MC Press books written by Brian Singleton available now on the MC Press Bookstore.

i5/OS and Microsoft Office Integration Handbook i5/OS and Microsoft Office Integration Handbook
Harness the power of Microsoft Office while exploiting the iSeries database.
List Price $79.95

Now On Sale

BLOG COMMENTS POWERED BY DISQUS

LATEST COMMENTS

Support MC Press Online

$0.00 Raised:
$

Book Reviews

Resource Center

  • SB Profound WC 5536 Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application. You can find Part 1 here. In Part 2 of our free Node.js Webinar Series, Brian May teaches you the different tooling options available for writing code, debugging, and using Git for version control. Brian will briefly discuss the different tools available, and demonstrate his preferred setup for Node development on IBM i or any platform. Attend this webinar to learn:

  • SB Profound WP 5539More than ever, there is a demand for IT to deliver innovation. Your IBM i has been an essential part of your business operations for years. However, your organization may struggle to maintain the current system and implement new projects. The thousands of customers we've worked with and surveyed state that expectations regarding the digital footprint and vision of the company are not aligned with the current IT environment.

  • SB HelpSystems ROBOT Generic IBM announced the E1080 servers using the latest Power10 processor in September 2021. The most powerful processor from IBM to date, Power10 is designed to handle the demands of doing business in today’s high-tech atmosphere, including running cloud applications, supporting big data, and managing AI workloads. But what does Power10 mean for your data center? In this recorded webinar, IBMers Dan Sundt and Dylan Boday join IBM Power Champion Tom Huntington for a discussion on why Power10 technology is the right strategic investment if you run IBM i, AIX, or Linux. In this action-packed hour, Tom will share trends from the IBM i and AIX user communities while Dan and Dylan dive into the tech specs for key hardware, including:

  • Magic MarkTRY the one package that solves all your document design and printing challenges on all your platforms. Produce bar code labels, electronic forms, ad hoc reports, and RFID tags – without programming! MarkMagic is the only document design and print solution that combines report writing, WYSIWYG label and forms design, and conditional printing in one integrated product. Make sure your data survives when catastrophe hits. Request your trial now!  Request Now.

  • SB HelpSystems ROBOT GenericForms of ransomware has been around for over 30 years, and with more and more organizations suffering attacks each year, it continues to endure. What has made ransomware such a durable threat and what is the best way to combat it? In order to prevent ransomware, organizations must first understand how it works.

  • SB HelpSystems ROBOT GenericIT security is a top priority for businesses around the world, but most IBM i pros don’t know where to begin—and most cybersecurity experts don’t know IBM i. In this session, Robin Tatam explores the business impact of lax IBM i security, the top vulnerabilities putting IBM i at risk, and the steps you can take to protect your organization. If you’re looking to avoid unexpected downtime or corrupted data, you don’t want to miss this session.

  • SB HelpSystems ROBOT GenericCan you trust all of your users all of the time? A typical end user receives 16 malicious emails each month, but only 17 percent of these phishing campaigns are reported to IT. Once an attack is underway, most organizations won’t discover the breach until six months later. A staggering amount of damage can occur in that time. Despite these risks, 93 percent of organizations are leaving their IBM i systems vulnerable to cybercrime. In this on-demand webinar, IBM i security experts Robin Tatam and Sandi Moore will reveal:

  • FORTRA Disaster protection is vital to every business. Yet, it often consists of patched together procedures that are prone to error. From automatic backups to data encryption to media management, Robot automates the routine (yet often complex) tasks of iSeries backup and recovery, saving you time and money and making the process safer and more reliable. Automate your backups with the Robot Backup and Recovery Solution. Key features include:

  • FORTRAManaging messages on your IBM i can be more than a full-time job if you have to do it manually. Messages need a response and resources must be monitored—often over multiple systems and across platforms. How can you be sure you won’t miss important system events? Automate your message center with the Robot Message Management Solution. Key features include:

  • FORTRAThe thought of printing, distributing, and storing iSeries reports manually may reduce you to tears. Paper and labor costs associated with report generation can spiral out of control. Mountains of paper threaten to swamp your files. Robot automates report bursting, distribution, bundling, and archiving, and offers secure, selective online report viewing. Manage your reports with the Robot Report Management Solution. Key features include:

  • FORTRAFor over 30 years, Robot has been a leader in systems management for IBM i. With batch job creation and scheduling at its core, the Robot Job Scheduling Solution reduces the opportunity for human error and helps you maintain service levels, automating even the biggest, most complex runbooks. Manage your job schedule with the Robot Job Scheduling Solution. Key features include:

  • LANSA Business users want new applications now. Market and regulatory pressures require faster application updates and delivery into production. Your IBM i developers may be approaching retirement, and you see no sure way to fill their positions with experienced developers. In addition, you may be caught between maintaining your existing applications and the uncertainty of moving to something new.

  • LANSAWhen it comes to creating your business applications, there are hundreds of coding platforms and programming languages to choose from. These options range from very complex traditional programming languages to Low-Code platforms where sometimes no traditional coding experience is needed. Download our whitepaper, The Power of Writing Code in a Low-Code Solution, and:

  • LANSASupply Chain is becoming increasingly complex and unpredictable. From raw materials for manufacturing to food supply chains, the journey from source to production to delivery to consumers is marred with inefficiencies, manual processes, shortages, recalls, counterfeits, and scandals. In this webinar, we discuss how:

  • The MC Resource Centers bring you the widest selection of white papers, trial software, and on-demand webcasts for you to choose from. >> Review the list of White Papers, Trial Software or On-Demand Webcast at the MC Press Resource Center. >> Add the items to yru Cart and complet he checkout process and submit

  • Profound Logic Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application.

  • SB Profound WC 5536Join us for this hour-long webcast that will explore:

  • Fortra IT managers hoping to find new IBM i talent are discovering that the pool of experienced RPG programmers and operators or administrators with intimate knowledge of the operating system and the applications that run on it is small. This begs the question: How will you manage the platform that supports such a big part of your business? This guide offers strategies and software suggestions to help you plan IT staffing and resources and smooth the transition after your AS/400 talent retires. Read on to learn: