com.aspose.email
Class MapiPropertyContainer

java.lang.Object
  com.aspose.email.MapiPropertyContainer

Direct Known Subclasses:

MapiAttachment, MapiMessage, MapiNamedPropertyMappingStorage, MapiPropertyStream, MapiRecipient

public abstract class MapiPropertyContainer
extends Object

Represents the base class for MapiAttachment, MapiRecipient, MapiMessage.

Method Summary

com.aspose.email.IMapiNode	createMapiNode(String key) Creates the mapi node.
int	getCodePage() Gets the code page.
MapiPropertyCollection	getMyProperties() Gets my properties.
MapiPropertyCollection	getProperties() Gets the collection of properties.
Boolean	getPropertyBoolean(long tag) Gets the value of the property specified by tag as Boolean type.
byte[]	getPropertyBytes(long tag) Gets the string value of the property specified by tag.
Date	getPropertyDateTime(long key)
Integer	getPropertyInt32(long tag) Gets the int32 value of the property specified by tag.
Long	getPropertyLong(long tag) Gets the value of the property specified by tag as Long (int64) type.
Short	getPropertyShort(long tag) Gets the value of the property specified by tag as Short type.
String	getPropertyString(long tag) Gets the string value of the property specified by tag.
String	getPropertyString(long tag, int codepage) Gets the string value of the property specified by tag.
void	setNamedPropertyMapping(MapiNamedPropertyMappingStorage value) Sets the named property mapping.
void	setProperty(long value, long signed, long tag) Sets the property.
void	setProperty(MapiAttachment value, long signed, long tag) Sets the property.
abstract 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 tag) Sets the property.
void	setProperty(MapiRecipient value, long signed, long tag) Sets the property.
void	setPropertySet(MapiProperty value, long signed, long tag) Sets the property set.
byte[]	tryGetPropertyData(long tag) Try to get the property data with specified tag key.
boolean	tryGetPropertyDateTime(long tag, Date[] value)
boolean	tryGetPropertyInt32(long tag, int[] value) Gets the value of the specified property as Int32 type.
boolean	tryGetPropertyLong(long tag, long[] value) Gets the value of the specified property as Long type.
String	tryGetPropertyString(long tag) Try to get a property data as string with specified tag.
String	tryGetPropertyString(long tag, int codepage) Try to get a property data as string with specified tag and code page.
boolean	tryGetPropertyString(long tag, String[] value) Gets the value of the specified property as String type.
boolean	tryGetPropertyString(long tag, String[] value, int codepage) Gets the value of the specified property as String type.

Methods inherited from class java.lang.Object

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

Method Detail

getProperties

public MapiPropertyCollection getProperties()

Gets the collection of properties.

Value: The properties.

getCodePage

public int getCodePage()

Gets the code page.

Value: The code page.

getMyProperties

public MapiPropertyCollection getMyProperties()

Gets my properties.

Value: My properties.

tryGetPropertyString

public String tryGetPropertyString(long tag,
                                   int codepage)

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

Parameters:

tag - The property tag key.

codepage - The code page.

Returns:

String that contains the contents of property data.

tryGetPropertyData

public byte[] tryGetPropertyData(long tag)

Try to get the property data with specified tag key.

Parameters:

tag - The tag key.

Returns:

The property data.

tryGetPropertyString

public String tryGetPropertyString(long tag)

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

Parameters:

tag - The property tag key.

Returns:

String that contains the contents of property data.

getPropertyString

public String getPropertyString(long tag,
                                int codepage)

Gets the string value of the property specified by tag.

Parameters:

tag - The MAPI property tag.

codepage - The specified codepage used to get string value.

Returns:

The value of the property. If the property does not exist, returns NULL; otherwise, returns the value.

getPropertyString

public String getPropertyString(long tag)

Gets the string value of the property specified by tag.

Parameters:

tag - The MAPI property tag.

Returns:

The value of the property. If the property does not exist, returns NULL; otherwise, returns the value.

getPropertyBytes

public byte[] getPropertyBytes(long tag)

Gets the string value of the property specified by tag.

Parameters:

tag - The MAPI property tag.

Returns:

The value of the property. If the property does not exist, returns NULL; otherwise, returns the value.

setProperty

public abstract void setProperty(MapiProperty property)

Sets the property.

Parameters:

property - The property.

Throws:

NotImplementedException

getPropertyInt32

public Integer getPropertyInt32(long tag)

Gets the int32 value of the property specified by tag.

Parameters:

tag - The MAPI property tag.

Returns:

The value of the property. If the property does not exist, returns NULL; otherwise, returns the value.

getPropertyLong

public Long getPropertyLong(long tag)

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

Parameters:

tag - The MAPI property tag.

Returns:

The value of the property. If the property does not exist, returns NULL; otherwise, returns the value.

getPropertyShort

public Short getPropertyShort(long tag)

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

Parameters:

tag - The MAPI property tag.

Returns:

The value of the property. If the property does not exist, returns NULL; otherwise, returns the value.

getPropertyBoolean

public Boolean getPropertyBoolean(long tag)

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

Parameters:

tag - The MAPI property tag.

Returns:

The value of the property. If the property does not exist, returns NULL; otherwise, returns the value.

getPropertyDateTime

public Date getPropertyDateTime(long key)

tryGetPropertyString

public 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:

tag - The MAPI property tag.

value - When this method returns, contains the value of the specified property, if the property exists. This parameter is passed uninitialized.

codepage - The specified codepage used to get string value.

Returns:

true if s was converted successfully; otherwise, false.

tryGetPropertyString

public 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:

tag - The MAPI property tag.

value - When this method returns, contains the value of the specified property, if the property exists. This parameter is passed uninitialized.

Returns:

true if s was converted successfully; otherwise, false.

tryGetPropertyDateTime

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

tryGetPropertyLong

public 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:

tag - The MAPI property tag.

value - When this method returns, contains the value of the specified property, if the property exists. This parameter is passed uninitialized.

Returns:

true if s was converted successfully; otherwise, false.

tryGetPropertyInt32

public 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:

tag - The MAPI property tag.

value - When this method returns, contains the value of the specified property, if the property exists. This parameter is passed uninitialized.

Returns:

true if s was converted successfully; otherwise, false.

setProperty

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

Sets the property.

Parameters:

value - The property value.

signed - The signed.

tag - The property tag.

setProperty

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

Sets the property.

Parameters:

value - The property value.

signed - The signed.

tag - The property tag.

setProperty

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

Sets the property.

Parameters:

value - The property value.

signed - The signed.

tag - The property tag.

setProperty

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

Sets the property.

Parameters:

value - The property value.

signed - The signed.

tag - The property tag.

setProperty

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

Sets the property.

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.

Parameters:

value - The proeprty value.

signed - The signed.

tag - The property tag.

setNamedPropertyMapping

public void setNamedPropertyMapping(MapiNamedPropertyMappingStorage value)

Sets the named property mapping.

Parameters:

value - The value.

createMapiNode

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

Creates the mapi node.

Parameters:

key - The node key.

Returns:

The IMapiNode interface.