Working with Outlook Contacts

Creating, Saving and Reading Contacts

Like MapiMessage, Aspose.Email allows you to create Outlook contacts. The MapiContact class provides all the contact related properties required to create an Outlook contact. This article shows how to create, save and read an Outlook contact using the MapiContact class.

Create and Save Outlook Contact

To create a contact and save it to disc:

  1. Instantiate a new object of the MapiContact class.
  2. Enter contact property information.
  3. Add photo data (if any).
  4. Save the contact as MSG or VCard format.

The following code snippet shows you how to create and save outlook contact.

Save Mapi Distribution List to a Single Multi Contact VCF File

The code sample below demonstrates how to save a distribution list to a multi-contact VCF file:

// convert the `msg` object to a `MapiMessage` object
var dlist = (MapiDistributionList)msg.ToMapiMessageItem();

//save the distribution list
var options = new MapiDistributionListSaveOptions(ContactSaveFormat.VCard);
dlist.Save("distribution_list.vcf", options);

Save Contact in Version 3 VCF Format

To save the contact in version 3 VCF format, use the VCardVersion enumerable to set the VCardSaveOptions.Version property. The following sample code demonstrates the use of VCardVersion enumerable to save the contact VCF version 3 format:

Reading a MapiContact

The MapiContact class can be used to load both Outlook MSG and VCard format contacts. The following code snippet shows you how to load Outlook contacts saved as MSG and VCF into a MapiContact.

Loading a Contact from MSG

The following code snippet shows you how to load contacts from MSG.

Loading a Contact from VCard

The following code snippet shows you how to load contacts from VCard.

Loading a Contact from VCard with Specified Encoding

The following code snippet shows you how to load contacts from VCard with the specified encoding.

Saving VCard Contact Items with Specified Encoding

Customize the saving behavior when working with VCard files using the VCardSaveOptions class. The PreferredTextEncoding property of the class will specify the encoding to be used when saving VCard contact items.

The following code sample shows how to implement this property in your project:

var cont = VCardContact.Load(fileName, Encoding.UTF8);
var opt = new VCardSaveOptions();
opt.PreferredTextEncoding = Encoding.UTF8;
cont.Save("my.vcard", opt);

Saving VCard Files with Extended fields

The UseExtensions property allows you to control whether extended fields can be used when saving vCard files. When set to true (default), extensions are permitted, providing compatibility with custom fields and additional contact information.

Reading Multiple Contacts in VCard format

Our library makes it possible to get the list of all contacts from a VCard. It can be done using the following methods and steps:

// Checks whether VCard source stream contains multiple contacts.
VCardContact.IsMultiContacts(Stream stream)

// Loads list of all contacts from VCard file.
VCardContact.LoadAsMultiple(string filePath, Encoding encoding)

// Loads list of all contacts from VCard stream.
VCardContact.LoadAsMultiple(Stream stream, Encoding encoding)

The following code snippet demonstrates how to handle VCard files that contain multiple contacts:

using (FileStream stream = new FileStream("test.vcf", FileMode.Open, FileAccess.Read))
        List<VCardContact> contacts = VCardContact.LoadAsMultiple(stream, Encoding.UTF8);

Rendering Contact Information to MHTML

Outlook Contact can be converted to MHTML using Aspose.Email API. This example shows how a VCard is loaded into MapiContact and then converted to MHTML with the help of MailMessage API.