MapiPropertyContainer

Inheritance: java.lang.Object

public class MapiPropertyContainer

Represents the base class for MapiAttachment, MapiRecipient, MapiMessage.

Methods

Method Description
getProperties() Gets the collection of properties.
getProperty(PropertyDescriptor pd) Gets MAPI property by property descriptor.
setProperty(PropertyDescriptor pd, Object value) Sets MAPI property.
getCodePage() Gets the code page.
tryGetPropertyString(long tag, int codepage) Try to get a property data as string with specified tag and code page.
tryGetPropertyData(long tag) Try to get the property data with specified tag key.
tryGetPropertyString(long tag) Try to get a property data as string with specified tag.
getPropertyString(long tag, int codepage) Gets the string value of the property specified by tag.
getPropertyString(long tag) Gets the string value of the property specified by tag.
getPropertyBytes(long tag) Gets the string value of the property specified by tag.
setProperty(MapiProperty value) Sets the property.
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.
getPropertyBoolean(long tag) Gets the value of the property specified by tag as Boolean type.
getPropertyDateTime(long key) Gets the value of the property specified by tag as DateTime type.
isStoreUnicodeOk() Determines if string properties are Unicode encoded or not.
tryGetPropertyString(long tag, String[] value, int codepage) Gets the value of the specified property as String type.
tryGetPropertyString(long tag, String[] value) Gets the value of the specified property as String type.
tryGetPropertyDateTime(long tag, Date[] value) Gets the value of the specified property as DateTime type.
tryGetPropertyLong(long tag, long[] value) Gets the value of the specified property as Long type.
tryGetPropertyInt32(long tag, int[] value) Gets the value of the specified property as Int32 type.
createMapiNode(String key) Creates the mapi node.

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.

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.

getCodePage()

public int getCodePage()

Gets the code page.

Value: The code page.

Returns: int

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.

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.

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.

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.

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.

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.

setProperty(MapiProperty value)

public void setProperty(MapiProperty value)

Sets the property.

Parameters:

Parameter Type Description
value MapiProperty The property.

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.

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.

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.

isStoreUnicodeOk()

public final boolean isStoreUnicodeOk()

Determines if string properties are Unicode encoded or not.

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

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.

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.

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.

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.

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.

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.