com.aspose.email

Class MapiContact

java.lang.Object

com.aspose.email.MapiPropertyContainer

com.aspose.email.MapiMessageItemBase

com.aspose.email.MapiContact

All Implemented Interfaces:

IMapiMessageItem, IDisposable, Closeable, AutoCloseable

public final class MapiContact
extends MapiMessageItemBase

Represents a MAPI contact item.

This class serves as a wrapper for MapiMessage to simplify the process of handling contact information from MAPI properties. It provides a more intuitive interface for accessing and manipulating contact data within the MAPI message.

Example:

 // Load the MAPI message from a file
 MapiMessage msg = MapiMessage.load("contact.msg");

 // Check if the loaded message is a supported contact type
 if (msg.getSupportedType() == MapiItemType.Contact) {
     // Convert the MAPI message to a MapiContact object
     MapiContact mapiContact = (MapiContact) msg.toMapiMessageItem();

     // Display some contact info
     System.out.println(mapiContact.getNameInfo().getDisplayName());
     System.out.println(mapiContact.getElectronicAddresses().getEmail1().getEmailAddress());
 }
 
 

Field Summary

Fields inherited from class com.aspose.email.MapiMessageItemBase

attachments, namedPropertyMappingStorage, objectsToDispose, recipients

Constructor Summary

Constructors

Constructor and Description
MapiContact() Initializes a new instance of the MapiContact class
MapiContact(String displayName, String electonicAddress) Initializes a new instance of the MapiContact class.
MapiContact(String displayName, String electonicAddress, String companyName) Initializes a new instance of the MapiContact class.
MapiContact(String displayName, String electonicAddress, String companyName, String primaryTelephoneNumber) Initializes a new instance of the MapiContact class.

Method Summary

Methods

Modifier and Type	Method and Description
static MapiContact	fromVCard(InputStream stream) Reads MapiContact from the specified stream containing vCard.
static MapiContact	fromVCard(InputStream stream, Charset encoding) Reads MapiContact from the specified stream containing vCard.
static MapiContact	fromVCard(String filePath) Reads MapiContact from the specified vCard file The supported vCard versions are 2.1 and 3.0
static MapiContact	fromVCard(String filePath, Charset encoding) Reads MapiContact from the specified vCard file The supported vCard versions are 2.1 and 3.0
MapiContactElectronicAddressPropertySet	getElectronicAddresses() Specify properties for up to three different e-mail addresses and three different fax addresses
MapiContactEventPropertySet	getEvents() Specify events associated with a contact
MapiContactNamePropertySet	getNameInfo() The properties are used to specify the name of the person represented by the contact
MapiContactOtherPropertySet	getOtherFields() Specify other fields of conhtact.
MapiContactPersonalInfoPropertySet	getPersonalInfo() Specify other additional contact information
MapiContactPhoto	getPhoto() Contains contact photoMapiContactPhoto.
MapiContactPhysicalAddressPropertySet	getPhysicalAddresses() Specify three physical addresses: Home Address, Work Address, and Other Address.
MapiContactProfessionalPropertySet	getProfessionalInfo() Properties are used to store professional details for the person represented by the contact
MapiContactTelephonePropertySet	getTelephones() Specify telephone numbers for the contact
MapiMessage	getUnderlyingMessage() Retrieves the underlying MapiMessage object.
void	save(OutputStream stream) Saves this MapiContact into the given stream with vCard format.
void	save(OutputStream stream, ContactSaveOptions saveOptions) Saves this MapiContact to the given stream using specified save options.
void	save(OutputStream stream, int saveFormat) Saves this MapiContact to the given stream with a format using the default options.
void	save(String filePath) Saves this MapiContact to the vCard file with a default options.
void	save(String filePath, ContactSaveOptions saveOptions) Saves this MapiContact into file using specified save options.
void	save(String filePath, int saveFormat) Saves this MapiContact to the specified file with a format using the default options.
void	setBodyContent(String content, int contentType) Sets the content of the body.
void	setElectronicAddresses(MapiContactElectronicAddressPropertySet value) Specify properties for up to three different e-mail addresses and three different fax addresses
void	setEvents(MapiContactEventPropertySet value) Specify events associated with a contact
void	setNameInfo(MapiContactNamePropertySet value) The properties are used to specify the name of the person represented by the contact
void	setOtherFields(MapiContactOtherPropertySet value) Specify other fields of conhtact.
void	setPersonalInfo(MapiContactPersonalInfoPropertySet value) Specify other additional contact information
void	setPhoto(MapiContactPhoto value) Contains contact photoMapiContactPhoto.
void	setPhysicalAddresses(MapiContactPhysicalAddressPropertySet value) Specify three physical addresses: Home Address, Work Address, and Other Address.
void	setProfessionalInfo(MapiContactProfessionalPropertySet value) Properties are used to store professional details for the person represented by the contact
void	setTelephones(MapiContactTelephonePropertySet value) Specify telephone numbers for the contact

Methods inherited from class com.aspose.email.MapiMessageItemBase

checkIsDisposed, close, createNamedProperty, dispose, getAttachments, getBilling, getBody, getBodyHtml, getBodyRtf, getBodyType, getCategories, getCompanies, getItemId, getMessageClass, getMileage, getNamedProperties, getNamedPropertyMapping, getProperty, getPropertyStream, getRecipients, getSensitivity, getSubject, getSubjectPrefix, getSubStorages, getSupportedType, initNamedPropertyMappingStorage, removeProperty, setBilling, setBody, setBodyContent, setBodyRtf, setBodyRtf, setCategories, setCompanies, setMessageClass, setMessageFlags, setMileage, setNamedPropertyMapping, setProperty, setRecipients, setSensitivity, setsIMapiMessageItemMembers, setSubject

Methods inherited from class com.aspose.email.MapiPropertyContainer

createMapiNode, getCodePage, getProperties, getPropertyBoolean, getPropertyBytes, getPropertyDateTime, getPropertyInt32, getPropertyLong, getPropertyShort, getPropertyString, getPropertyString, isStoreUnicodeOk, setProperty, tryGetPropertyData, tryGetPropertyDateTime, tryGetPropertyInt32, tryGetPropertyLong, tryGetPropertyString, tryGetPropertyString, tryGetPropertyString, tryGetPropertyString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MapiContact

public MapiContact()

Initializes a new instance of the MapiContact class

MapiContact

public MapiContact(String displayName,
           String electonicAddress)

Initializes a new instance of the MapiContact class.

Parameters:

displayName - The display name.

electonicAddress - The electonic address.

MapiContact

public MapiContact(String displayName,
           String electonicAddress,
           String companyName)

Initializes a new instance of the MapiContact class.

Parameters:

displayName - The display name.

electonicAddress - The electonic address.

companyName - Name of the company.

MapiContact

public MapiContact(String displayName,
           String electonicAddress,
           String companyName,
           String primaryTelephoneNumber)

Initializes a new instance of the MapiContact class.

Parameters:

displayName - The display name.

electonicAddress - The electonic address.

companyName - Name of the company.

primaryTelephoneNumber - The telephone number.

Method Detail

getNameInfo

public final MapiContactNamePropertySet getNameInfo()

The properties are used to specify the name of the person represented by the contact

setNameInfo

public final void setNameInfo(MapiContactNamePropertySet value)

The properties are used to specify the name of the person represented by the contact

getPersonalInfo

public final MapiContactPersonalInfoPropertySet getPersonalInfo()

Specify other additional contact information

setPersonalInfo

public final void setPersonalInfo(MapiContactPersonalInfoPropertySet value)

Specify other additional contact information

getProfessionalInfo

public final MapiContactProfessionalPropertySet getProfessionalInfo()

Properties are used to store professional details for the person represented by the contact

setProfessionalInfo

public final void setProfessionalInfo(MapiContactProfessionalPropertySet value)

Properties are used to store professional details for the person represented by the contact

getTelephones

public final MapiContactTelephonePropertySet getTelephones()

Specify telephone numbers for the contact

setTelephones

public final void setTelephones(MapiContactTelephonePropertySet value)

Specify telephone numbers for the contact

getElectronicAddresses

public final MapiContactElectronicAddressPropertySet getElectronicAddresses()

Specify properties for up to three different e-mail addresses and three different fax addresses

setElectronicAddresses

public final void setElectronicAddresses(MapiContactElectronicAddressPropertySet value)

Specify properties for up to three different e-mail addresses and three different fax addresses

getPhysicalAddresses

public final MapiContactPhysicalAddressPropertySet getPhysicalAddresses()

Specify three physical addresses: Home Address, Work Address, and Other Address. One of the addresses can be marked as the Mailing Address

setPhysicalAddresses

public final void setPhysicalAddresses(MapiContactPhysicalAddressPropertySet value)

Specify three physical addresses: Home Address, Work Address, and Other Address. One of the addresses can be marked as the Mailing Address

getEvents

public final MapiContactEventPropertySet getEvents()

Specify events associated with a contact

setEvents

public final void setEvents(MapiContactEventPropertySet value)

Specify events associated with a contact

getOtherFields

public final MapiContactOtherPropertySet getOtherFields()

Specify other fields of conhtact.

setOtherFields

public final void setOtherFields(MapiContactOtherPropertySet value)

Specify other fields of conhtact.

getPhoto

public final MapiContactPhoto getPhoto()

Contains contact photoMapiContactPhoto.

setPhoto

public final void setPhoto(MapiContactPhoto value)

Contains contact photoMapiContactPhoto.

fromVCard

public static MapiContact fromVCard(String filePath)

Reads MapiContact from the specified vCard file The supported vCard versions are 2.1 and 3.0

Parameters:

filePath - A file name to read from

Returns:

A read MapiContact

Throws:

ArgumentException - filePath is null or empty

fromVCard

public static MapiContact fromVCard(String filePath,
                    Charset encoding)

Reads MapiContact from the specified vCard file The supported vCard versions are 2.1 and 3.0

Parameters:

filePath - A file name to read from

encoding - File data encoding

Returns:

A read MapiContact

Throws:

ArgumentException - filePath is null or empty

fromVCard

public static MapiContact fromVCard(InputStream stream)

Reads MapiContact from the specified stream containing vCard. The supported vCard versions are 2.1 and 3.0

Parameters:

stream - A stream to read from

Returns:

A read MapiContact

Throws:

ArgumentNullException - stream is null

NotSupportedException - stream does not support reading

fromVCard

public static MapiContact fromVCard(InputStream stream,
                    Charset encoding)

Reads MapiContact from the specified stream containing vCard. The supported vCard versions are 2.1 and 3.0

Parameters:

stream - A stream to read from

encoding - Stream data encoding

Returns:

A read MapiContact

Throws:

ArgumentNullException - stream is null

NotSupportedException - stream does not support reading

getUnderlyingMessage

public final MapiMessage getUnderlyingMessage()

Retrieves the underlying MapiMessage object.

Returns:

The MapiMessage object.

Retrieves the underlying MAPI message from a MapiContact object and prints out its message class.

 // Retrieve the underlying MAPI message from the MapiContact object
 MapiMessage msg = mapiContact.getUnderlyingMessage();

 // Print out the message class of the MAPI message
 // Will output XVHK4D9KDb.get(new byte[] { (byte)0xc6, (byte)0xa8, (byte)0x7f, (byte)0x5c, (byte)0xfd, (byte)0xfb, (byte)0xcd, (byte)0xa8, (byte)0xb2, (byte)0xec, (byte)0xa0 })
 System.out.println(msg.getMessageClass());
 
 

save

public final void save(String filePath)

Saves this MapiContact to the vCard file with a default options. The supported vCard version is 2.1

Parameters:

filePath - A vCard file name

Throws:

ArgumentException - filePath is null or empty

save

public final void save(String filePath,
        int saveFormat)

Saves this MapiContact to the specified file with a format using the default options. The supported save format is vCard.

Parameters:

filePath - A vCard file name

saveFormat - A save format

Throws:

ArgumentException - filePath is null or empty

NotSupportedException - the specified format is not supported

save

public final void save(String filePath,
        ContactSaveOptions saveOptions)

Saves this MapiContact into file using specified save options. The supported save options is VCardSaveOptions

Parameters:

filePath - A vCard file name

saveOptions - A save options

Throws:

ArgumentException - filePath is null or empty

ArgumentNullException - saveOptions is null

NotSupportedException - some save option is not supported

save

public final void save(OutputStream stream)

Saves this MapiContact into the given stream with vCard format. The supported vCard version is 2.1

Parameters:

stream - A stream to save to

Throws:

ArgumentNullException - stream is null

NotSupportedException - stream does not support writing

save

public final void save(OutputStream stream,
        int saveFormat)

Saves this MapiContact to the given stream with a format using the default options. The supported save format is vCard

Parameters:

stream - A stream to save to

saveFormat - A save format

Throws:

ArgumentNullException - stream is null

NotSupportedException - stream does not support writing

NotSupportedException - The specified format is not supported

save

public final void save(OutputStream stream,
        ContactSaveOptions saveOptions)

Saves this MapiContact to the given stream using specified save options. The supported save options is VCardSaveOptions

Parameters:

stream - A stream to save to

saveOptions - A save options

Throws:

ArgumentNullException - stream or saveOptions is null

NotSupportedException - stream does not support writing

ArgumentException - incorrect saveOptions

NotSupportedException - some save option is not supported

setBodyContent

public void setBodyContent(String content,
                  int contentType)

Sets the content of the body.

Overrides:

setBodyContent in class MapiMessageItemBase

Parameters:

content - The content.

contentType - Type of the content.

It is provided for setting of the content of the body message in RTF, HTML or Plain Text formats. When setting a value, the values of PR_RTF_COMPRESSED, PR_RTF_DECOMPRESSES, PR_BODY properties are updated as well. Note, after the value in HTML format is set, BodyRtf property returns the value which is encoded within RTF.

Throws:

ArgumentNullException - throws if the specified content string is null or empty.