Messaging Application Programming Interface (MAPI) is an
API
An application programming interface (API) is a way for two or more computer programs to communicate with each other. It is a type of software interface, offering a service to other pieces of software. A document or standard that describes how ...
for
Microsoft Windows which allows programs to become
email
Electronic mail (email or e-mail) is a method of exchanging messages ("mail") between people using electronic devices. Email was thus conceived as the electronic ( digital) version of, or counterpart to, mail, at a time when "mail" mean ...
-aware. While MAPI is designed to be independent of the protocol, it is usually used to communicate with
Microsoft Exchange Server
Microsoft Exchange Server is a mail server and calendaring server developed by Microsoft. It runs exclusively on Windows Server operating systems.
The first version was called Exchange Server 4.0, to position it as the successor to the related ...
.
Details
MAPI uses functions loosely based on the
X.400 XAPIA standard. It includes facilities to access
message transports, message stores, and
directories
Directory may refer to:
* Directory (computing), or folder, a file system structure in which to store computer files
* Directory (OpenVMS command)
* Directory service, a software application for organizing information about a computer network's ...
.
While ''Simple MAPI'' (SMAPI) is a subset of 12 functions which enable developers to add basic messaging functionality, ''Extended MAPI'' (EMAPI) allows complete control over the messaging system on the client computer. This includes creation and management of messages, plus management of the client mailbox, and service providers.
Simple MAPI is included with
Microsoft Windows as part of
Outlook Express
Outlook Express, formerly known as Microsoft Internet Mail and News, is a discontinued email and news client included with Internet Explorer versions 3.0 through to 6.0. As such, it was bundled with several versions of Microsoft Windows, from ...
/
Windows Mail
Mail (formerly Windows Mail) is an email client developed by Microsoft and included in Windows Vista and later versions of Windows. The main function of Mail is sending and receiving email. It is available as the successor to Outlook Express, wh ...
while the full Extended MAPI is included with
Microsoft Outlook and
Exchange
Exchange may refer to:
Physics
*Gas exchange is the movement of oxygen and carbon dioxide molecules from a region of higher concentration to a region of lower concentration. Places United States
* Exchange, Indiana, an unincorporated community
* ...
.
In addition to the Extended MAPI client interface, programming calls can be made indirectly through the Simple MAPI API client interface, through the ''Common Messaging Calls'' (CMC) API client interface, or by the object-based ''
CDO Library'' interface. These three methods are easier to use and designed for less complex messaging-enabled and -aware applications. (Simple MAPI and CMC were removed from Exchange 2003.)
MAPI was originally designed by
Microsoft
Microsoft Corporation is an American multinational technology corporation producing computer software, consumer electronics, personal computers, and related services headquartered at the Microsoft Redmond campus located in Redmond, Washin ...
. The company founded its MS Mail team in 1987, but it was not until it acquired
Consumers Software in 1991 to obtain ''Network Courier'' that it had a messaging product. Reworked, it was sold as MS PC Mail (or
Microsoft Mail
Microsoft Mail (or MSMail/MSM) was the name given to several early Microsoft e-mail products for local area networks, primarily two architectures: one for Macintosh networks, and one for PC architecture-based LANs. All were eventually replaced ...
for PC Networking). The basic API to MS PC Mail was later known as MAPI version 0 (or ''MAPI0''), to differentiate it from "true" MAPI.
Service provider interface
The full Extended MAPI interface is required for interfacing messaging-based services to client applications such as Outlook. For example, several non-Microsoft e-mail server product vendors created "MAPI service providers" to allow their products to be accessed via Outlook. Notable examples include
Axigen Mail Server,
Kerio Connect
Kerio Technologies, Inc. is a former technology company specializing in collaboration software and unified threat management for small and medium organizations. Founded in 2001, Kerio is headquartered in San Jose, California. In January 2017, GFI ...
,
Scalix
Scalix is an e-mail and groupware server that runs on Linux, licensed under the Scalix Public License (SPL).
The software provides e-mail, group calendaring and other collaborative software, which are standard in groupware. It can be also be ac ...
,
Zimbra
Zimbra Collaboration, formerly known as the Zimbra Collaboration Suite (ZCS) before 2019, is a collaborative software suite that includes an email server and a web client.
Zimbra was initially developed by LiquidSys, which changed their name ...
,
HP OpenMail HP OpenMail, also known simply as OpenMail, was an enterprise email messaging and collaboration product from Hewlett-Packard.
It was known for its ability to interconnect several other APIs and protocols, including MAPI, cc:Mail, SMTP and MIME, a ...
,
IBM Lotus Notes
HCL Notes (formerly IBM Notes and Lotus Notes; see Branding below) and HCL Domino (formerly IBM Domino and Lotus Domino) are the client and server, respectively, of a collaborative client-server software platform formerly sold by IBM, now by HC ...
,
Zarafa/
Kopano, and
Bynari
Bynari is a defunct company based in Dallas, developing server and email software, mainly known for its Insight Family, similar to Microsoft Exchange Server with Outlook.
Development of the products is a joint effort with various OEM partners.
I ...
.
MAPI also had a service provider interface of sorts. Microsoft used this to interface MS Mail to an email system based on
Xenix
Xenix is a discontinued version of the Unix operating system for various microcomputer platforms, licensed by Microsoft from AT&T Corporation in the late 1970s. The Santa Cruz Operation (SCO) later acquired exclusive rights to the software, and ...
, for internal use.
Extended MAPI is the main e-mail data access method used by Outlook, to interface to Microsoft Exchange, via MAPI service providers shipped with Outlook.
MAPI/RPC protocol details
Microsoft has released full details of the MAPI/RPC protocol since August 2007.
"MAPI protocol" is a colloquial name for the MAPI/RPC. At times, Microsoft has also called it "Exchange RPC" and "Outlook-Exchange Transport Protocol".
Microsoft provides a sample MAPI/RPC-based application called MFCMAPI to assist developers. It is also widely used as a diagnostics tool by both developers and Microsoft Exchange administrators.
MAPI over HTTP
The original implementation was designed for use on a local network, or
LAN.
With Exchange 2003 Microsoft introduced RPC over HTTP (later renamed Outlook Anywhere) as a way to Exchange over the internet.
In 2014 with Exchange 2013 SP1 replaced this with a more 'normal' HTTP-based stack known as "MAPI over HTTP".
Reimplementations
Several
open-source software projects have started working on implementing MAPI libraries, including:
* The OpenMapi project (now demised) had a C# implementation.
*
Kopano (software)
Kopano is an open-source groupware application suite originally based on Zarafa. The initial version of Kopano Core (KC) was forked from the then-current release of (the open-source parts of) Zarafa Collaboration Platform, and superseded ZCP ...
Groupware Core has a C++2011 implementation called "mapi4linux" (continuation of the same from
Zarafa), which offers an API that is source-backwards-compatible with the Messaging API (code written for M4L also build with the Windows SDK). Kopano GWC comes with a connector for the Zarafa/Kopano-based SOAP/HTTP transport.
*
OpenChange has a "libmapi" component written in C that only partially resembles MAPI. (Lacks interfaces like IMsgStore, the OpenEntry function.)
* The OpenChange subproject
Evolution-MAPI is a connector for Exchange implementing the MAPI/RPC transport.
* The Gnome
Evolution project develops ''evolution-ews'', which has implemented much of MAPI.
References
External links
Messaging API at MSDN LibraryOpenChange project - details of MAPI protocol and tools for exploring MAPI protocolOpenMapi project - Open Source, multi-language MAPI implementation which can connect to other groupware sources, with API documentationMessaging API Archived User ForumEnabling Outlook Connector logging for support
{{Microsoft APIs
Internet mail protocols
Microsoft application programming interfaces