com.aspose.email
Class MapiRecipient

java.lang.Object
  extended by com.aspose.email.MapiPropertyContainer
      extended by com.aspose.email.MapiRecipient

public class MapiRecipient
extends MapiPropertyContainer

Represents the recipient information in the Microsoft Outlook Message.


Method Summary
 com.aspose.email.IMapiNode createMapiNode(String key)
           Creates the mapi node.
 String getAddressType()
           Gets the type of the address of the message recipient or sender.
 Object getContent()
           Gets the content.
 String getDisplayName()
           Gets or sets the display name of the message recipient or sender.
 String getEmailAddress()
           Gets or sets the email address of the message recipient or sender.
 String getOrganizationEmailAddress()
           Gets the organization email address.
 MapiPropertyStream getPropertyStream()
           Gets the property stream.
 int getRecipientClass()
           Gets the type of recipent.
 int getRecipientType()
           Gets the type of the recipient or sender.
 MapiPropertyCollection getSubStorages()
           Gets the sub storages.
 void setDisplayName(String value)
           
 void setEmailAddress(String value)
           
 void setProperty(MapiAttachment value, long signed, long key)
           Sets the property.
 void setProperty(MapiProperty property)
           Sets the property.
 void setProperty(MapiProperty value, long signed, long tag)
           Sets the property.
 void setProperty(MapiPropertyStream value, long signed, long key)
           Sets the property.
 void setProperty(MapiRecipient value, long signed, long key)
           Sets the property.
 void setPropertySet(MapiProperty value, long signed, long tag)
           Sets the property set.
 
Methods inherited from class com.aspose.email.MapiPropertyContainer
getCodePage, getMyProperties, getProperties, getPropertyBoolean, getPropertyBytes, getPropertyDateTime, getPropertyInt32, getPropertyLong, getPropertyShort, getPropertyString, getPropertyString, setNamedPropertyMapping, setProperty, tryGetPropertyData, tryGetPropertyDateTime, tryGetPropertyInt32, tryGetPropertyLong, tryGetPropertyString, tryGetPropertyString, tryGetPropertyString, tryGetPropertyString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getDisplayName

public String getDisplayName()

Gets or sets the display name of the message recipient or sender.

Value: The display name.


When setting a value, the values of either MapiMessage.DisplayTo or MapiMessage.DisplayBcc or MapiMessage.DisplayCC are also updated depending on the type of recepient.


setDisplayName

public void setDisplayName(String value)

getAddressType

public String getAddressType()

Gets the type of the address of the message recipient or sender.

Value: The address type.


This property indicates the type for PR_EMAIL_ADDRESS mapi property.


getEmailAddress

public String getEmailAddress()

Gets or sets the email address of the message recipient or sender.

Throws:
com.aspose.email.ms.System.IllegalArgumentException - throws if recipient address is null or empty.
com.aspose.email.ms.System.IllegalArgumentException - throws if recipient address is not in a recognized format. Value: The email address.


Note, this property displays an address in SMTP format. It means that if MapiRecipient.AddressType == "EX" and MapiPropertyTag.PR_EMAIL_ADDRESS contain an address in Exchange-style, the value for mapiRecipient.EmailAddress property filling is picked from PR_SMTP_ADDRESS. When setting a value, the values of PR_SEARCH_KEY and PR_ENTRYID properties are updated as well.


setEmailAddress

public void setEmailAddress(String value)

getOrganizationEmailAddress

public String getOrganizationEmailAddress()

Gets the organization email address.

Value: The organization email address.


getRecipientType

public int getRecipientType()

Gets the type of the recipient or sender.

Value: The recipient type.


getRecipientClass

public int getRecipientClass()

Gets the type of recipent.

Value: The recipient class.


getPropertyStream

public MapiPropertyStream getPropertyStream()

Gets the property stream.

Value: The property stream.


getSubStorages

public MapiPropertyCollection getSubStorages()

Gets the sub storages.

Value: The sub storages.


getContent

public Object getContent()

Gets the content.

Value: The content.


setProperty

public void setProperty(MapiProperty property)

Sets the property.

Specified by:
setProperty in class MapiPropertyContainer
Parameters:
property - The property.
Throws:
com.aspose.email.ms.System.IllegalArgumentException - If property is null.
com.aspose.email.ms.System.IllegalArgumentException - If property data is null.
IllegalStateException - If data type is not supported.

setProperty

public void setProperty(MapiAttachment value,
                        long signed,
                        long key)

Sets the property.

Overrides:
setProperty in class MapiPropertyContainer
Parameters:
value - The property value.
signed - The signed.
key - The property tag.

setProperty

public void setProperty(MapiRecipient value,
                        long signed,
                        long key)

Sets the property.

Overrides:
setProperty in class MapiPropertyContainer
Parameters:
value - The property value.
signed - The signed.
key - The property tag.

setProperty

public void setProperty(MapiProperty value,
                        long signed,
                        long tag)

Sets the property.

Overrides:
setProperty in class MapiPropertyContainer
Parameters:
value - The property value.
signed - The signed.
tag - The property tag.

setPropertySet

public void setPropertySet(MapiProperty value,
                           long signed,
                           long tag)

Sets the property set.

Overrides:
setPropertySet in class MapiPropertyContainer
Parameters:
value - The proeprty value.
signed - The signed.
tag - The property tag.

setProperty

public void setProperty(MapiPropertyStream value,
                        long signed,
                        long key)

Sets the property.

Overrides:
setProperty in class MapiPropertyContainer
Parameters:
value - The property value.
signed - The signed.
key - The property tag.

createMapiNode

public com.aspose.email.IMapiNode createMapiNode(String key)

Creates the mapi node.

Overrides:
createMapiNode in class MapiPropertyContainer
Parameters:
key - The node key.
Returns:
The IMapiNode interface.


Copyright (c) 2002-2012 Aspose Pty Ltd. All Rights Reserved.