com.aspose.email

Interfaces

Classes

Enums

Exceptions

com.aspose.email

Class MapiRecipient



  • public class MapiRecipient
    extends MapiPropertyContainer

    Represents the recipient information in the Microsoft Outlook Message.

    • 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)

        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.

      • 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.ms.System.ArgumentNullException - throws if recipient address is null or empty.
        com.aspose.ms.System.ArgumentException - 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)

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

        Throws:
        com.aspose.ms.System.ArgumentNullException - throws if recipient address is null or empty.
        com.aspose.ms.System.ArgumentException - 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.

      • 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.
      • getRecipientTrackStatus

        public int getRecipientTrackStatus()

        Status of recipient’s response to a meeting request.

      • setRecipientTrackStatus

        public void setRecipientTrackStatus(int value)

        Status of recipient’s response to a meeting request.

      • setProperty

        public void setProperty(MapiProperty property)

        Sets the property.

        Specified by:
        setProperty in class MapiPropertyContainer
        Parameters:
        property - The property.
        Throws:
        com.aspose.ms.System.ArgumentNullException - If property is null.
        com.aspose.ms.System.ArgumentException - If property data is null.
        com.aspose.ms.System.InvalidOperationException - 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.
      • 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.
      • getNamedProperties

        public MapiPropertyCollection getNamedProperties()

        Gets the named properties of message.

        Value: The collection of named properties.