Click here to Skip to main content
15,112,869 members
Articles / Mobile Apps
Article
Posted 3 Jul 2005

Stats

3.7M views
17.9K downloads
228 bookmarked

MAPIEx: Extended MAPI Wrapper

Rate me:
Please Sign up or sign in to vote.
4.93/5 (137 votes)
5 Dec 2009CDDL7 min read
A (hopefully) complete extended MAPI wrapper for WinXP, WinCE, and .NET

Introduction

I've been using simple MAPI for years, and recently, I had to send some mail programmatically and was reminded of the dreaded Outlook security warnings. So, I decided to look into the extended MAPI. What I found was a huge collection of samples that did one thing or another, but nothing that really did everything related to messages that I needed. This class, hopefully, covers everything an average user would need to do, including sending and receiving mail including attachments, multiple recipients, CC, BCC, etc. I did not put any code to manipulate information stores or services. See the example CMapiAdmin on CodeProject for this functionality. I've also tested this class using Unicode as well as ANSI strings.

Using CMapiEx

I've included the sample TestMAPI (link above) to show two cases. The project has been updated to Visual Studio 8 (2005), but I believe could be adapted to nearly every version of Visual Studio and Embedded Visual Studio. It's been tested in WinXP using Office 2003, and on Windows Mobile 2003. With a small amount of work removing the MFC code from the class (basically just CString), the class will work on Windows SmartPhone as well. Some of the newer code, including Outlook Forms support and AddressBook support is not supported in Windows Mobile.

To use the class, simply do the following:

  • Call CMAPIEx::Init() and Login() to initialize and login to MAPI.
  • Use OpenMessageStore() to open the desired store, i.e., "SMS"; (NULL for the default store).
  • To receive, call OpenInbox() and GetContents() followed by a looping GetNextMessage() call for each message (optionally reading in only the unread messages).
  • Use HasAttachment and SaveAttachments() to access the message's attachments.
C#
void ReceiveTest(CMAPIEx& mapi)
{
    if(mapi.OpenInbox() && mapi.GetContents()) {
        CMAPIMessage message;
        while(mapi.GetNextMessage(message,TRUE)) {
            printf("Message from '%s' subject '%s'\n", 
              message.GetSenderName(),message.GetSubject());
            if(message.HasAttachments()) {
                printf("saving attachments...");
                message.SaveAttachments(MSG_ATTACHMENT_FOLDER);
                printf("done\n");
            }
        }
    }
}

To send, call OpenOutbox() and CMapiMessage::Create(). Then, set the message properties, and then call CMapiMessage::Send():

C#
void SendTest(CMAPIEx& mapi)
{
    if(mapi.OpenOutbox()) {
        CMAPIMessage message;
        if(message.Create(&mapi,IMPORTANCE_LOW)) {
            message.SetSenderName(FROM_NAME);
            message.SetSenderEmail(FROM_EMAIL);
            message.SetSubject(_T("Subject"));
            message.SetBody(_T("Body"));

            message.AddRecipient(TO_EMAIL);
            message.AddRecipient(TO_EMAIL2);
            message.AddAttachment(MSG_ATTACHMENT);

            if(message.Send()) printf("Sent Successfully");
        }
    }
}

Use Logout() and CMAPIEx::Term() to exit MAPI. Obviously, if you want to try CMAPIEx in a Unicode project, you'll have to use wprintf instead.

RTF/HTML Support

A lot of people requested support for HTML messages. After doing a bunch of research and testing, I found that HTML is actually usually stored in the PR_RTF_COMPRESSED property, and that it can be decoded into HTML if it contains the text \\fromhtml. Thanks to Lucian Wischik for his example, the decoding code in MAPIEx is basically lifted right from his example (see the source for the address). I took it a step further by allowing you to set the RTF property with HTML in order to send an HTML email. Take a look at the SetRTF example in the sample TestMAPI project above, for more details.

.NET Wrapper for CMAPIEx

I originally wrote the NetMAPI wrapper as a proof of concept; it has little functionality beyond the basics. However over the last few months, I received so many questions and requests for enhancements for .NET that I have completely rewritten NetMAPI to be a thin layer above the Win32 DLL, CMAPIEx. NetMAPI offers support for nearly every feature provided in the C++ interface. The included sample above contains a .NET console project, TestNetMAPI, illustrating its usage.

To use the wrapper, first make sure your program has a reference to NetMAPI, and that the compiled MAPIEx.dll is in your output folder or in your path. Then, use NetMAPI.Init() and Login functions to access it:

C#
if(NetMAPI.Init()) {
    NetMAPI mapi=new NetMAPI();
    if(mapi.Login()) {
        // Do some MAPI stuff here...
        mapi.Logout();
    }
    NetMAPI.Term();
}

To receive in .NET (assumes you've logged in successfully):

  • Open the message store you want to access
  • Then open the inbox and get the contents table
  • Iterate through the message using GetNextMessage
  • Don't forget to Dispose of the message when you're finished with it!
C#
public static void ReceiveTest(NetMAPI mapi)
{
    if(mapi.OpenInbox() && mapi.GetContents()) {
        mapi.SortContents(false);

        MAPIMessage message;
        StringBuilder s=new StringBuilder(NetMAPI.DefaultBufferSize);
        while(mapi.GetNextMessage(out message,true)) {
            Console.Write("Message from '");
            message.GetSenderName(s);
            Console.Write(s.ToString()+"' (");
            message.GetSenderEmail(s);
            Console.Write(s.ToString()+"), subject '");
            message.GetSubject(s);
            Console.Write(s.ToString()+"', received: ");
            message.GetReceivedTime(s,"%m/%d/%Y %I:%M %p");
            Console.Write(s.ToString()+"\n");
            // use message.GetBody() to get the ANSI text body
            // use message.GetRTF() to get the RTF or decoded HTML email
            message.Dispose();
        }
    }
}

To send a message (assumes you've logged in successfully):

  • Open the message store you want to access
  • Open the outbox
  • Create a new message, set its priority if you like
  • Set its properties, recipients and attachments
  • Call Send
C#
public static void SendTest(NetMAPI mapi)
{
    if(mapi.OpenOutbox()) {
        MAPIMessage message=new MAPIMessage();
        if(message.Create(mapi,MAPIMessage.Priority.IMPORTANCE_LOW)) {
            message.SetSenderName("Noel");
            message.SetSenderEmail("noel@nospam.com");
            message.SetSubject("Subject");

            // user SetBody for ANSI text, SetRTF for HTML and Rich Text
            message.SetBody("Body");
            
            message.AddRecipient("noel@nospam.com");
            message.AddRecipient("noel@nospam2.com");

            if(message.Send()) Console.WriteLine("Sent Successfully");
        }
    }
}

See the ContactsTest and FoldersTest functions in TestNetMAPI for more examples.

Use the Logout and NetMAPI.Term() call to close the wrapper. To use Unicode, compile CMAPIEx with Unicode set, and change the DefaultCharSet variable in NetMAPI to CharSet.Unicode.

Future Improvements

I'd like to add more support for Calendar and Task items. Outlook 2010 support is another thing coming down the pipeline, currently no tests have been done.

I couldn't figure out how to create a One-Off EntryID in Windows Mobile, as the IAddressBook interface is not implemented. This has the annoying effect of not sending the outgoing emails on these devices until you manually open the message in your Outbox and hit Send. If anyone knows how this is done, please let me know, and I will update it.

This code is free to use as long as the copyright notice remains at the top of the file and any enhancements or bug fixes are posted here for the community. I hope it helps someone skip the pain I went through!

History

  • 07/01/2005 - Initial release
  • 07/13/2005 - Small bug fixes and additions, see below for details
  • 08/25/2005 - Small modifications and a .NET wrapper (see below)
  • 01/27/2006 - Added a bunch of new commands for handling folders and messages (see below)
  • 05/16/2006 - Added RTF and HTML support
  • 06/02/2006 - Added external folder support, and fixed a couple of small bugs (thanks to all who reported the issues)
  • 08/21/2006 - Reorganized files, added support for reading contacts, notifications, and fixed some minor bugs
  • 10/02/2006 - Complete rewrite of the .NET wrapper, with full MAPIEx access from .NET
  • 11/01/2006 - Added support for many new fields, added IMessage Form support and writeable contacts
  • 12/04/2009 - Enhanced performance, completed contacts and added rudimentary Calendar support

Detailed History

  • Fixed a bug with attachments (thanks alan, see forum below for details).
  • While in the attachment code, I modified PR_ATTACH_FILENAME to be the filename of the attachment instead of the full path.
  • Added support for Outlook 2000. To use this class with Outlook 2000, you must call CMAPIEx::Init with a value of zero instead of the default MAPI_UNICODE. Also, building the project for Unicode doesn't work with Office 2000 as far as I can tell (it responds with ANSI strings).
  • Fixed the "mail stays in Outbox after it's sent" problem. See the posting below for more info.
  • Added a priority field to CMAPIMessage::Create, you can now optionally set IMPORTANCE_LOW or IMPORTANCE_HIGH.
  • You can now call AddRecipient repeatedly to send to more than one user.
  • Updated project to Visual Studio 2008.
  • Added a post build step to copy MAPIEx.dll to the test projects' output folders.
  • Added subfolder support to the DLL, you can now iterate through and directly open subfolders.
  • Modified the Login command to take a profile name (thanks Chris, see forum for details).
  • Added the GetProfileName command to find out what the current profile's name is (thanks Jason, author of CMAPIAdmin).
  • Added the ReceivedTime property and the GetReceivedTime function to the message class (thanks again Chris, see forum).
  • Added a CopyMessage function to copy a message between folders as well as the DeleteMessage and MoveMessage functions.
  • Added the CreateSubFolder, DeleteSubFolder functions.
  • Added a OpenSentItems function.
  • Added a new RTF property, this allows us to set RTF text and even HTML (see TestMAPI, for an example).
  • Changed GetBody and GetRTF to be filled on demand rather than when opening the message.
  • MAPIEx can now extract SMTP email addresses from Exchange (EX) native addresses (see FillSenderEmail, for details).
  • MAPIEx can now receive notifications from MAPI (i.e., for new mail arrivals, message deletion etc., see NotificationTest for an example.
  • Added read only support for contacts, see ContactsTest for a sample).
  • Fixed a bug with bad strings from MAPI properties (see GetValidString for more info).
  • Added support for the MAPI_NO_CACHE flag (for Outlook 2003).
  • Added the OpenContacts and OpenDrafts functions.
  • Added a GetRowCount for providing progress feedback for long folder operations.
  • Added support for the AddressList form to get a list of recipients via the common UI. (C++ only, C# if people request it.)
  • Added support for custom Named Properties in Contacts and Messages.
  • Added IMessageForm support to show the default form for editing messages.
  • Added Save, SubmitTime, Sensitivity, MessageFlags, and DeliveryReceipt properties to messages.
  • Added support for enumerating recipients of a message.
  • MAPIContact now supports the three email fields.
  • Added many new fields to contacts such as Company, HomePage, DisplayAs, etc.
  • Added support for creating contacts.
  • Added rudimentary Calendar support (no create appointment functionality yet).
  • Added extensive folder support, see FolderTest for an example.
  • Added CreateProfile and DeleteProfile because of multiple requests.
  • Extended RTF and HTML support, added GetMessageEditorFormat to detect formats.
  • Many small improvements and additions requested by the userbase (too many to list, see forum below for details).

License

This article, along with any associated source code and files, is licensed under The Common Development and Distribution License (CDDL)

Share

About the Author

Noel Dillabough
Software Developer (Senior)
Canada Canada
No Biography provided

Comments and Discussions

 
QuestionPorting WinMobile 6 Std Pin
Duratore1-Oct-07 5:57
MemberDuratore1-Oct-07 5:57 
AnswerRe: Porting WinMobile 6 Std Pin
Noel Dillabough1-Oct-07 6:08
MemberNoel Dillabough1-Oct-07 6:08 
QuestionHow to handle Outlook mail drag and drop ? Pin
Miroslav Rajcic27-Sep-07 22:06
MemberMiroslav Rajcic27-Sep-07 22:06 
QuestionMy NetMAPI.Init() fails Pin
mickni3325-Sep-07 3:54
Membermickni3325-Sep-07 3:54 
AnswerRe: My NetMAPI.Init() fails Pin
Noel Dillabough25-Sep-07 4:30
MemberNoel Dillabough25-Sep-07 4:30 
GeneralRe: My NetMAPI.Init() fails Pin
mickni3326-Sep-07 21:47
Membermickni3326-Sep-07 21:47 
GeneralRe: My NetMAPI.Init() fails Pin
Noel Dillabough27-Sep-07 5:14
MemberNoel Dillabough27-Sep-07 5:14 
GeneralThe addressee receives an email empty with attached a file named WinMail.dat Pin
riccardo6819-Sep-07 3:31
Memberriccardo6819-Sep-07 3:31 
There is an issue on sending email to an addressee that does not have Outlook.

The issue happens when the Outlook client bypass Exchange server and connect directly to another server.
A client that reproduce the issue is FoxMail.

I supposed that MapiEx formats the message with some header/tags proprietary and Exchange Server clear them before forward to other site

There is some property to set to avoid that ?

I wish I send emails without Exchange Server as requirement

Thanks in advance
Riccardo Raccuglia
Cry | :((
GeneralRe: The addressee receives an email empty with attached a file named WinMail.dat Pin
Noel Dillabough19-Sep-07 7:58
MemberNoel Dillabough19-Sep-07 7:58 
GeneralRe: The addressee receives an email empty with attached a file named WinMail.dat Pin
pscholl5-Dec-07 23:40
Memberpscholl5-Dec-07 23:40 
GeneralRe: The addressee receives an email empty with attached a file named WinMail.dat Pin
pscholl7-Dec-07 3:07
Memberpscholl7-Dec-07 3:07 
GeneralRe: The addressee receives an email empty with attached a file named WinMail.dat Pin
Noel Dillabough1-Dec-08 6:20
MemberNoel Dillabough1-Dec-08 6:20 
QuestionAttachement DisplayName Pin
Reader Man San3-Sep-07 3:56
professionalReader Man San3-Sep-07 3:56 
AnswerRe: Attachement DisplayName Pin
Noel Dillabough3-Sep-07 6:43
MemberNoel Dillabough3-Sep-07 6:43 
GeneralRe: Attachement DisplayName Pin
Reader Man San3-Sep-07 20:31
professionalReader Man San3-Sep-07 20:31 
GeneralRe: Attachement DisplayName Pin
Noel Dillabough4-Sep-07 5:26
MemberNoel Dillabough4-Sep-07 5:26 
GeneralRe: Attachement DisplayName Pin
Reader Man San4-Sep-07 20:39
professionalReader Man San4-Sep-07 20:39 
GeneralRe: Attachement DisplayName Pin
Noel Dillabough5-Sep-07 5:48
MemberNoel Dillabough5-Sep-07 5:48 
GeneralRe: Attachement DisplayName Pin
Reader Man San8-Sep-07 3:04
professionalReader Man San8-Sep-07 3:04 
Generalcurly braces lost when sending RTF formatted HTML text Pin
baudewijn.vermeire2-Sep-07 22:20
Memberbaudewijn.vermeire2-Sep-07 22:20 
GeneralRe: curly braces lost when sending RTF formatted HTML text Pin
Noel Dillabough3-Sep-07 6:51
MemberNoel Dillabough3-Sep-07 6:51 
GeneralRe: curly braces lost when sending RTF formatted HTML text Pin
rob.net19-Jun-08 4:31
Memberrob.net19-Jun-08 4:31 
GeneralRe: curly braces lost when sending RTF formatted HTML text Pin
Noel Dillabough19-Jun-08 9:13
MemberNoel Dillabough19-Jun-08 9:13 
GeneralRe: curly braces lost when sending RTF formatted HTML text Pin
Noel Dillabough29-Jul-08 12:37
MemberNoel Dillabough29-Jul-08 12:37 
QuestionSave to File, Pin
craigrmain15-Aug-07 3:06
Membercraigrmain15-Aug-07 3:06 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.