MapiRecipient

Inheritance: java.lang.Object, com.aspose.email.MapiPropertyContainer

public class MapiRecipient extends MapiPropertyContainer

Represents the recipient information in the Microsoft Outlook Message.

Methods

Method Description
createMapiNode(String key) Creates the mapi node.
equals(Object arg0)
getAddressType() Gets the type of the address of the message recipient or sender.
getClass()
getCodePage() Gets the code page.
getContent() Gets the content.
getDisplayName() Gets or sets the display name of the message recipient or sender.
getEmailAddress() Gets or sets the email address of the message recipient or sender.
getNamedProperties() Gets the named properties of message.
getOrganizationEmailAddress() Gets the organization email address.
getProperties() Gets the collection of properties.
getProperty(PropertyDescriptor pd) Gets MAPI property by property descriptor.
getPropertyBoolean(long tag) Gets the value of the property specified by tag as Boolean type.
getPropertyBytes(long tag) Gets the string value of the property specified by tag.
getPropertyDateTime(long key) Gets the value of the property specified by tag as DateTime type.
getPropertyInt32(long tag) Gets the int32 value of the property specified by tag.
getPropertyLong(long tag) Gets the value of the property specified by tag as Long (int64) type.
getPropertyShort(long tag) Gets the value of the property specified by tag as Short type.
getPropertyStream() Gets the property stream.
getPropertyString(long tag) Gets the string value of the property specified by tag.
getPropertyString(long tag, int codepage) Gets the string value of the property specified by tag.
getRecipientClass() Gets the type of recipent.
getRecipientTrackStatus() Status of recipient\u2019s response to a meeting request.
getRecipientType() Gets the type of the recipient or sender.
getSubStorages() Gets the sub storages.
hashCode()
isStoreUnicodeOk() Determines if string properties are Unicode encoded or not.
notify()
notifyAll()
setDisplayName(String value) Gets or sets the display name of the message recipient or sender.
setEmailAddress(String value) Gets or sets the email address of the message recipient or sender.
setProperty(MapiProperty value) Sets the property.
setProperty(PropertyDescriptor pd, Object value) Sets MAPI property.
setRecipientTrackStatus(int value) Status of recipient\u2019s response to a meeting request.
toString()
tryGetPropertyData(long tag) Try to get the property data with specified tag key.
tryGetPropertyDateTime(long tag, Date[] value) Gets the value of the specified property as DateTime type.
tryGetPropertyInt32(long tag, int[] value) Gets the value of the specified property as Int32 type.
tryGetPropertyLong(long tag, long[] value) Gets the value of the specified property as Long type.
tryGetPropertyString(long tag) Try to get a property data as string with specified tag.
tryGetPropertyString(long tag, int codepage) Try to get a property data as string with specified tag and code page.
tryGetPropertyString(long tag, String[] value) Gets the value of the specified property as String type.
tryGetPropertyString(long tag, String[] value, int codepage) Gets the value of the specified property as String type.
wait()
wait(long arg0)
wait(long arg0, int arg1)

createMapiNode(String key)

public IMapiNode createMapiNode(String key)

Creates the mapi node.

Parameters:

Parameter Type Description
key java.lang.String The node key.

Returns: com.aspose.email.IMapiNode - The IMapiNode interface.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter Type Description
arg0 java.lang.Object

Returns: boolean

getAddressType()

public final 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.

Returns: java.lang.String

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getCodePage()

public int getCodePage()

Gets the code page.

Value: The code page.

Returns: int

getContent()

public final Object getContent()

Gets the content.

Value: The content.

Returns: java.lang.Object

getDisplayName()

public final 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.

Returns: java.lang.String

getEmailAddress()

public final String getEmailAddress()

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

Returns: java.lang.String

getNamedProperties()

public final MapiPropertyCollection getNamedProperties()

Gets the named properties of message.

Value: The collection of named properties.

Returns: MapiPropertyCollection

getOrganizationEmailAddress()

public final String getOrganizationEmailAddress()

Gets the organization email address.

Value: The organization email address.

Returns: java.lang.String

getProperties()

public MapiPropertyCollection getProperties()

Gets the collection of properties.

Value: The properties.

Returns: MapiPropertyCollection

getProperty(PropertyDescriptor pd)

public MapiProperty getProperty(PropertyDescriptor pd)

Gets MAPI property by property descriptor.

Parameters:

Parameter Type Description
pd PropertyDescriptor Property descriptor for looked property

Returns: MapiProperty - Mapi property if it is found, otherwise null.

getPropertyBoolean(long tag)

public final Boolean getPropertyBoolean(long tag)

Gets the value of the property specified by tag as Boolean type.

Parameters:

Parameter Type Description
tag long The MAPI property tag.

Returns: java.lang.Boolean - The value of the property. If the property does not exist, returns NULL; otherwise, returns the value.

getPropertyBytes(long tag)

public final byte[] getPropertyBytes(long tag)

Gets the string value of the property specified by tag.

Parameters:

Parameter Type Description
tag long The MAPI property tag.

Returns: byte[] - The value of the property. If the property does not exist, returns NULL; otherwise, returns the value.

getPropertyDateTime(long key)

public final Date getPropertyDateTime(long key)

Gets the value of the property specified by tag as DateTime type.

Parameters:

Parameter Type Description
key long The MAPI property tag.

Returns: java.util.Date - The value of the property. If the property does not exist, returns NULL; otherwise, returns the value.

getPropertyInt32(long tag)

public final Integer getPropertyInt32(long tag)

Gets the int32 value of the property specified by tag.

Parameters:

Parameter Type Description
tag long The MAPI property tag.

Returns: java.lang.Integer - The value of the property. If the property does not exist, returns NULL; otherwise, returns the value.

getPropertyLong(long tag)

public final Long getPropertyLong(long tag)

Gets the value of the property specified by tag as Long (int64) type.

Parameters:

Parameter Type Description
tag long The MAPI property tag.

Returns: java.lang.Long - The value of the property. If the property does not exist, returns NULL; otherwise, returns the value.

getPropertyShort(long tag)

public final Short getPropertyShort(long tag)

Gets the value of the property specified by tag as Short type.

Parameters:

Parameter Type Description
tag long The MAPI property tag.

Returns: java.lang.Short - The value of the property. If the property does not exist, returns NULL; otherwise, returns the value.

getPropertyStream()

public final MapiPropertyStream getPropertyStream()

Gets the property stream.

Value: The property stream.

Returns: MapiPropertyStream

getPropertyString(long tag)

public final String getPropertyString(long tag)

Gets the string value of the property specified by tag.

Parameters:

Parameter Type Description
tag long The MAPI property tag.

Returns: java.lang.String - The value of the property. If the property does not exist, returns NULL; otherwise, returns the value.

getPropertyString(long tag, int codepage)

public final String getPropertyString(long tag, int codepage)

Gets the string value of the property specified by tag.

Parameters:

Parameter Type Description
tag long The MAPI property tag.
codepage int The specified codepage used to get string value.

Returns: java.lang.String - The value of the property. If the property does not exist, returns NULL; otherwise, returns the value.

getRecipientClass()

public final int getRecipientClass()

Gets the type of recipent.

Value: The recipient class.

Returns: int

getRecipientTrackStatus()

public final int getRecipientTrackStatus()

Status of recipient\u2019s response to a meeting request.

Returns: int

getRecipientType()

public final int getRecipientType()

Gets the type of the recipient or sender.

Value: The recipient type.

Returns: int

getSubStorages()

public final MapiPropertyCollection getSubStorages()

Gets the sub storages.

Value: The sub storages.

Returns: MapiPropertyCollection

hashCode()

public native int hashCode()

Returns: int

isStoreUnicodeOk()

public final boolean isStoreUnicodeOk()

Determines if string properties are Unicode encoded or not.

Returns: boolean - True, if string properties are Unicode encoded.

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setDisplayName(String value)

public final void setDisplayName(String value)

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.

Parameters:

Parameter Type Description
value java.lang.String

setEmailAddress(String value)

public final void setEmailAddress(String value)

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

Parameters:

Parameter Type Description
value java.lang.String

setProperty(MapiProperty value)

public void setProperty(MapiProperty value)

Sets the property.

Parameters:

Parameter Type Description
value MapiProperty The property.

setProperty(PropertyDescriptor pd, Object value)

public void setProperty(PropertyDescriptor pd, Object value)

Sets MAPI property.

Parameters:

Parameter Type Description
pd PropertyDescriptor The property descriptor.
value java.lang.Object The property data.

setRecipientTrackStatus(int value)

public final void setRecipientTrackStatus(int value)

Status of recipient\u2019s response to a meeting request.

Parameters:

Parameter Type Description
value int

toString()

public String toString()

Returns: java.lang.String

tryGetPropertyData(long tag)

public final byte[] tryGetPropertyData(long tag)

Try to get the property data with specified tag key.

Parameters:

Parameter Type Description
tag long The tag key.

Returns: byte[] - The property data.

tryGetPropertyDateTime(long tag, Date[] value)

public final boolean tryGetPropertyDateTime(long tag, Date[] value)

Gets the value of the specified property as DateTime type. A return value indicates whether the operation succeeded.

Parameters:

Parameter Type Description
tag long The MAPI property tag.
value java.util.Date[] When this method returns, contains the value of the specified property, if the property exists. This parameter is passed uninitialized.

Returns: boolean - true if s was converted successfully; otherwise, false.

tryGetPropertyInt32(long tag, int[] value)

public final boolean tryGetPropertyInt32(long tag, int[] value)

Gets the value of the specified property as Int32 type. A return value indicates whether the operation succeeded.

Parameters:

Parameter Type Description
tag long The MAPI property tag.
value int[] When this method returns, contains the value of the specified property, if the property exists. This parameter is passed uninitialized.

Returns: boolean - true if s was converted successfully; otherwise, false.

tryGetPropertyLong(long tag, long[] value)

public final boolean tryGetPropertyLong(long tag, long[] value)

Gets the value of the specified property as Long type. A return value indicates whether the operation succeeded.

Parameters:

Parameter Type Description
tag long The MAPI property tag.
value long[] When this method returns, contains the value of the specified property, if the property exists. This parameter is passed uninitialized.

Returns: boolean - true if s was converted successfully; otherwise, false.

tryGetPropertyString(long tag)

public final String tryGetPropertyString(long tag)

Try to get a property data as string with specified tag.

Parameters:

Parameter Type Description
tag long The property tag key.

Returns: java.lang.String - String that contains the contents of property data.

tryGetPropertyString(long tag, int codepage)

public final String tryGetPropertyString(long tag, int codepage)

Try to get a property data as string with specified tag and code page.

Parameters:

Parameter Type Description
tag long The property tag key.
codepage int The code page.

Returns: java.lang.String - String that contains the contents of property data.

tryGetPropertyString(long tag, String[] value)

public final boolean tryGetPropertyString(long tag, String[] value)

Gets the value of the specified property as String type. A return value indicates whether the operation succeeded.

Parameters:

Parameter Type Description
tag long The MAPI property tag.
value java.lang.String[] When this method returns, contains the value of the specified property, if the property exists. This parameter is passed uninitialized.

Returns: boolean - true if s was converted successfully; otherwise, false.

tryGetPropertyString(long tag, String[] value, int codepage)

public final boolean tryGetPropertyString(long tag, String[] value, int codepage)

Gets the value of the specified property as String type. A return value indicates whether the operation succeeded.

Parameters:

Parameter Type Description
tag long The MAPI property tag.
value java.lang.String[] When this method returns, contains the value of the specified property, if the property exists. This parameter is passed uninitialized.
codepage int The specified codepage used to get string value.

Returns: boolean - true if s was converted successfully; otherwise, false.

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter Type Description
arg0 long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter Type Description
arg0 long
arg1 int