com.aspose.email

Interfaces

Classes

Enums

Exceptions

com.aspose.email

Class MapiPropertyContainer

    • Method Detail

      • getProperties

        public MapiPropertyCollection getProperties()

        Gets the collection of properties.

        Value: The properties.

      • getProperty

        public MapiProperty getProperty(PropertyDescriptor pd)

        Gets MAPI property by property descriptor.

        Parameters:
        pd - Property descriptor for looked property
        Returns:
        Mapi property if it is found, otherwise null.

      • setProperty

        public void setProperty(PropertyDescriptor pd,
               Object value)

        Sets MAPI property.

        Parameters:
        pd - The property descriptor.
        value - The property data.

      • getCodePage

        public int getCodePage()

        Gets the code page.

        Value: The code page.

      • tryGetPropertyString

        public final 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 final 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 final 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 final 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 final 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 final 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 void setProperty(MapiProperty value)

        Sets the property.

        Parameters:
        value - The property.
        Throws:
        com.aspose.ms.System.ArgumentNullException - If value is null.
        com.aspose.ms.System.ArgumentException - If property data is null.
        com.aspose.ms.System.InvalidOperationException - If data type is not supported.

      • getPropertyInt32

        public final 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 final 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 final 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 final 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 final Date getPropertyDateTime(long key)

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

        Parameters:
        key - The MAPI property tag.
        Returns:
        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:
        True, if string properties are Unicode encoded.

      • tryGetPropertyString

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

      • tryGetPropertyLong

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

      • createMapiNode

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

        Creates the mapi node.

        Parameters:
        key - The node key.
        Returns:
        The IMapiNode interface.