Package com.independentsoft.msg

Class Message

java.lang.Object
com.independentsoft.msg.Message
public class Message extends Object
Represents Outlook message file.

  • Constructor Details

    • Message

      public Message()
      Initializes a new instance of the Message class.

    • Message

      public Message​(String filePath) throws IOException
      Initializes a new instance of the Message class based on the supplied file.
      Parameters:
      filePath - the file path
      Throws:
      IOException - Signals that an I/O exception has occurred.

    • Message

      public Message​(InputStream inputStream) throws IOException
      Initializes a new instance of the Message class based on the supplied stream.
      Parameters:
      inputStream - the input stream
      Throws:
      IOException - Signals that an I/O exception has occurred.

    • Message

      public Message​(Message mimeMessage)
      Initializes a new instance of the Message class from the specified MIME message.
      Parameters:
      mimeMessage - the MIME message

  • Method Details

    • open

      public void open​(String filePath) throws IOException
      Loads message from the specified file.
      Parameters:
      filePath - the file path
      Throws:
      IOException - Signals that an I/O exception has occurred.

    • open

      public void open​(InputStream inputStream) throws IOException
      Loads message from the specified input stream.
      Parameters:
      inputStream - the input stream
      Throws:
      IOException - Signals that an I/O exception has occurred.

    • getInputStream

      public InputStream getInputStream() throws IOException
      Gets stream to read from this message.
      Returns:
      the input stream
      Throws:
      IOException - Signals that an I/O exception has occurred.

    • toByteArray

      public byte[] toByteArray() throws IOException
      Gets bytes to read from this message.
      Returns:
      the byte[]
      Throws:
      IOException - Signals that an I/O exception has occurred.

    • save

      public void save​(String filePath) throws IOException
      Saves this message to the specified file.
      Parameters:
      filePath - the file path
      Throws:
      IOException - Signals that an I/O exception has occurred.

    • save

      public void save​(String filePath, boolean overwrite) throws IOException
      Saves this message to the specified file.
      Parameters:
      filePath - the file path
      overwrite - if true overwrites an existing file with the same path.
      Throws:
      IOException - Signals that an I/O exception has occurred.

    • save

      public void save​(OutputStream outputStream) throws IOException
      Saves this message to the specified stream.
      Parameters:
      outputStream - the output stream
      Throws:
      IOException - Signals that an I/O exception has occurred.

    • convertToMimeMessage

      public Message convertToMimeMessage()
      Converts this message to a MIME message.
      Returns:
      the MIME message

    • getCharset

      public Charset getCharset()
      Gets message charset. Default is UTF8 charset.
      Returns:
      the charset

    • setCharset

      public void setCharset​(Charset charset)
      Sets message charset. Default is UTF8 charset.
      Parameters:
      charset - the new charset

    • getEncoding

      public Encoding getEncoding()
      Gets message encoding. Default is UTF8 encoding.
      Returns:
      the encoding

    • setEncoding

      public void setEncoding​(Encoding encoding)
      Sets message encoding. Default is UTF8 encoding.
      Parameters:
      encoding - the new encoding

    • getMessageClass

      public String getMessageClass()
      Gets a text string that identifies the sender-defined message class, such as IPM.Note.
      Returns:
      the message class

    • setMessageClass

      public void setMessageClass​(String messageClass)
      Sets a text string that identifies the sender-defined message class, such as IPM.Note.
      Parameters:
      messageClass - the new message class

    • getSubject

      public String getSubject()
      Gets the full subject of a message.
      Returns:
      the subject

    • setSubject

      public void setSubject​(String subject)
      Sets the full subject of a message.
      Parameters:
      subject - the new subject

    • getSubjectPrefix

      public String getSubjectPrefix()
      Gets a subject prefix that typically indicates some action on a message, such as "FW: " for forwarding.
      Returns:
      the subject prefix

    • setSubjectPrefix

      public void setSubjectPrefix​(String subjectPrefix)
      Sets a subject prefix that typically indicates some action on a message, such as "FW: " for forwarding.
      Parameters:
      subjectPrefix - the new subject prefix

    • getConversationTopic

      public String getConversationTopic()
      Gets the topic of the first message in a conversation thread. A conversation thread represents a series of messages and replies. These properties are set for the first message in a thread, usually to the getNormalizedSubject() Subsequent messages in the thread should use the same topic without modification.
      Returns:
      the conversation topic

    • setConversationTopic

      public void setConversationTopic​(String conversationTopic)
      Sets the topic of the first message in a conversation thread. A conversation thread represents a series of messages and replies. These properties are set for the first message in a thread, usually to the getNormalizedSubject(). Subsequent messages in the thread should use the same topic without modification.
      Parameters:
      conversationTopic - the new conversation topic

    • getDisplayBcc

      public String getDisplayBcc()
      Gets an ASCII list of the display names of any blind carbon copy (BCC) message recipients, separated by semicolons (;).
      Returns:
      the display bcc

    • setDisplayBcc

      public void setDisplayBcc​(String displayBcc)
      Sets an ASCII list of the display names of any blind carbon copy (BCC) message recipients, separated by semicolons (;).
      Parameters:
      displayBcc - the new display bcc

    • getDisplayCc

      public String getDisplayCc()
      Gets an ASCII list of the display names of any carbon copy (CC) message recipients, separated by semicolons (;).
      Returns:
      the display cc

    • setDisplayCc

      public void setDisplayCc​(String displayCc)
      Sets an ASCII list of the display names of any carbon copy (CC) message recipients, separated by semicolons (;).
      Parameters:
      displayCc - the new display cc

    • getDisplayTo

      public String getDisplayTo()
      Gets a list of the display names of the primary (To) message recipients, separated by semicolons (;).
      Returns:
      the display to

    • setDisplayTo

      public void setDisplayTo​(String displayTo)
      Sets a list of the display names of the primary (To) message recipients, separated by semicolons (;).
      Parameters:
      displayTo - the new display to

    • getOriginalDisplayTo

      public String getOriginalDisplayTo()
      Gets a list of the display names of the primary (To) message recipients, separated by semicolons (;).
      Returns:
      the original display to

    • setOriginalDisplayTo

      public void setOriginalDisplayTo​(String originalDisplayTo)
      Sets a list of the display names of the primary (To) message recipients, separated by semicolons (;).
      Parameters:
      originalDisplayTo - the new original display to

    • getReplyTo

      public String getReplyTo()
      Gets reply to email address.
      Returns:
      the reply to

    • setReplyTo

      public void setReplyTo​(String replyTo)
      Sets reply to email address.
      Parameters:
      replyTo - the new reply to

    • getNormalizedSubject

      public String getNormalizedSubject()
      Gets the message subject with any prefix removed.
      Returns:
      the normalized subject

    • setNormalizedSubject

      public void setNormalizedSubject​(String normalizedSubject)
      Sets the message subject with any prefix removed.
      Parameters:
      normalizedSubject - the new normalized subject

    • getBody

      public String getBody()
      Gets the message text.
      Returns:
      the body

    • setBody

      public void setBody​(String body)
      Sets the message text.
      Parameters:
      body - the new body

    • getBodyRtf

      public byte[] getBodyRtf()
      Gets the Rich Text Format (RTF) version of the message text.
      Returns:
      the body rtf

    • setBodyRtf

      public void setBodyRtf​(byte[] rtf)
      Sets the Rich Text Format (RTF) version of the message text.
      Parameters:
      rtf - the new body rtf

    • getRtfCompressed

      public byte[] getRtfCompressed()
      Gets the Rich Text Format (RTF) version of the message text, usually in compressed form.
      Returns:
      the rtf compressed

    • setRtfCompressed

      public void setRtfCompressed​(byte[] rtfCompressed)
      Sets the Rich Text Format (RTF) version of the message text, usually in compressed form.
      Parameters:
      rtfCompressed - the new rtf compressed

    • getSearchKey

      public byte[] getSearchKey()
      Gets a binary-comparable key that identifies correlated objects for a search.
      Returns:
      the search key

    • setSearchKey

      public void setSearchKey​(byte[] searchKey)
      Sets a binary-comparable key that identifies correlated objects for a search.
      Parameters:
      searchKey - the new search key

    • getChangeKey

      public byte[] getChangeKey()
      Gest a change key of a message.
      Returns:
      the change key

    • setChangeKey

      public void setChangeKey​(byte[] changeKey)
      Sets a change key of a message.
      Parameters:
      changeKey - the new change key

    • getEntryId

      public byte[] getEntryId()
      Gets a MAPI entry identifier used to open and edit properties of a particular MAPI object.
      Returns:
      the entry id

    • setEntryId

      public void setEntryId​(byte[] entryId)
      Sets a MAPI entry identifier used to open and edit properties of a particular MAPI object.
      Parameters:
      entryId - the new entry id

    • getReadReceiptEntryId

      public byte[] getReadReceiptEntryId()
      Gets the read receipt entry id.
      Returns:
      the read receipt entry id

    • setReadReceiptEntryId

      public void setReadReceiptEntryId​(byte[] readReceiptEntryId)
      Sets the read receipt entry id.
      Parameters:
      readReceiptEntryId - the new read receipt entry id

    • getReadReceiptSearchKey

      public byte[] getReadReceiptSearchKey()
      Gets the read receipt search key.
      Returns:
      the read receipt search key

    • setReadReceiptSearchKey

      public void setReadReceiptSearchKey​(byte[] readReceiptSearchKey)
      Sets the read receipt search key.
      Parameters:
      readReceiptSearchKey - the new read receipt search key

    • getCreationTime

      public Date getCreationTime()
      Gets the creation date and time of a message. A message store sets this time for each message that it creates.
      Returns:
      the creation time

    • setCreationTime

      public void setCreationTime​(Date creationTime)
      Sets the creation date and time of a message. A message store sets this time for each message that it creates.
      Parameters:
      creationTime - the new creation time

    • getLastModificationTime

      public Date getLastModificationTime()
      Gets the date and time when the message was last modified. This field is initially set to the same value as the getCreationTime().
      Returns:
      the last modification time

    • setLastModificationTime

      public void setLastModificationTime​(Date lastModificationTime)
      Sets the date and time when the message was last modified. This field is initially set to the same value as the getCreationTime().
      Parameters:
      lastModificationTime - the new last modification time

    • getMessageDeliveryTime

      public Date getMessageDeliveryTime()
      Gets the date and time when a message was delivered. Describes the time the message was stored at the server, rather than the download time when the transport provider copied the message from the server to the local store.
      Returns:
      the message delivery time

    • setMessageDeliveryTime

      public void setMessageDeliveryTime​(Date messageDeliveryTime)
      Sets the date and time when a message was delivered. Describes the time the message was stored at the server, rather than the download time when the transport provider copied the message from the server to the local store.
      Parameters:
      messageDeliveryTime - the new message delivery time

    • getClientSubmitTime

      public Date getClientSubmitTime()
      Gets the date and time the message sender submitted a message.
      Returns:
      the client submit time

    • setClientSubmitTime

      public void setClientSubmitTime​(Date clientSubmitTime)
      Sets the date and time the message sender submitted a message.
      Parameters:
      clientSubmitTime - the new client submit time

    • getProviderSubmitTime

      public Date getProviderSubmitTime()
      Gets the date and time the message provider submitted a message.
      Returns:
      the provider submit time

    • setProviderSubmitTime

      public void setProviderSubmitTime​(Date providerSubmitTime)
      Sets the date and time the message provider submitted a message.
      Parameters:
      providerSubmitTime - the new provider submit time

    • getReportTime

      public Date getReportTime()
      Gets the report date and time.
      Returns:
      the report time

    • setReportTime

      public void setReportTime​(Date reportTime)
      Sets the report date and time.
      Parameters:
      reportTime - the new report time

    • getLastVerbExecutionTime

      public Date getLastVerbExecutionTime()
      Gets the time when the last verb was executed.
      Returns:
      the last verb execution time

    • setLastVerbExecutionTime

      public void setLastVerbExecutionTime​(Date lastVerbExecutionTime)
      Sets the time when the last verb was executed.
      Parameters:
      lastVerbExecutionTime - the new last verb execution time

    • getReportText

      public String getReportText()
      Gets report text.
      Returns:
      the report text

    • setReportText

      public void setReportText​(String reportText)
      Sets report text.
      Parameters:
      reportText - the new report text

    • getCreatorName

      public String getCreatorName()
      Gets name of the person who created message.
      Returns:
      the creator name

    • setCreatorName

      public void setCreatorName​(String creatorName)
      Sets name of the person who created message.
      Parameters:
      creatorName - the new creator name

    • getLastModifierName

      public String getLastModifierName()
      Gest name of the person who modified message.
      Returns:
      the last modifier name

    • setLastModifierName

      public void setLastModifierName​(String lastModifierName)
      Sets name of the person who modified message.
      Parameters:
      lastModifierName - the new last modifier name

    • getInternetMessageId

      public String getInternetMessageId()
      Gets unique ID for the message.
      Returns:
      the internet message id

    • setInternetMessageId

      public void setInternetMessageId​(String internetMessageId)
      Sets unique ID for the message.
      Parameters:
      internetMessageId - the new internet message id

    • getInReplyTo

      public String getInReplyTo()
      Gets identifier of the message to which this message is a reply.
      Returns:
      the in reply to

    • setInReplyTo

      public void setInReplyTo​(String inReplyTo)
      Sets identifier of the message to which this message is a reply.
      Parameters:
      inReplyTo - the new in reply to

    • getInternetReferences

      public String getInternetReferences()
      Gets Internet reference ID for the message..
      Returns:
      the internet references

    • setInternetReferences

      public void setInternetReferences​(String internetReferences)
      Sets Internet reference ID for the message..
      Parameters:
      internetReferences - the new internet references

    • getMessageCodePage

      public long getMessageCodePage()
      Gets the code page that is used for the message.
      Returns:
      the message code page

    • setMessageCodePage

      public void setMessageCodePage​(long messageCodePage)
      Sets the code page that is used for the message.
      Parameters:
      messageCodePage - the new message code page

    • getIconIndex

      public long getIconIndex()
      Gets a number that indicates which icon to use when you display a group of e-mail objects.
      Returns:
      the icon index

    • setIconIndex

      public void setIconIndex​(long iconIndex)
      Sets a number that indicates which icon to use when you display a group of e-mail objects.
      Parameters:
      iconIndex - the new icon index

    • getSize

      public long getSize()
      Gets the size of the body, subject, sender, and attachments.
      Returns:
      the size

    • setSize

      public void setSize​(long messageSize)
      Sets the size of the body, subject, sender, and attachments.
      Parameters:
      messageSize - the new size

    • getInternetCodePage

      public long getInternetCodePage()
      Gets the code page used for the Body or the BodyHtml properties.
      Returns:
      the internet code page

    • setInternetCodePage

      public void setInternetCodePage​(long internetCodePage)
      Sets the code page used for the Body or the BodyHtml properties.
      Parameters:
      internetCodePage - the new internet code page

    • getConversationIndex

      public byte[] getConversationIndex()
      Gets a binary value that indicates the relative position of this message within a conversation thread.
      Returns:
      the conversation index

    • setConversationIndex

      public void setConversationIndex​(byte[] conversationIndex)
      Sets a binary value that indicates the relative position of this message within a conversation thread.
      Parameters:
      conversationIndex - the new conversation index

    • isHidden

      public boolean isHidden()
      Gets true if message is invisible.
      Returns:
      true, if is hidden

    • setHidden

      public void setHidden​(boolean isHidden)
      Sets true if message is invisible.
      Parameters:
      isHidden - the new hidden

    • isReadOnly

      public boolean isReadOnly()
      Gets true if message is read only.
      Returns:
      true, if is read only

    • setReadOnly

      public void setReadOnly​(boolean isReadOnly)
      Sets true if message is read only.
      Parameters:
      isReadOnly - the new read only

    • isSystem

      public boolean isSystem()
      Gets true if message is system message.
      Returns:
      true, if is system

    • setSystem

      public void setSystem​(boolean isSystem)
      Sets true if message is system message.
      Parameters:
      isSystem - the new system

    • getDisableFullFidelity

      public boolean getDisableFullFidelity()
      Gets the disable full fidelity.
      Returns:
      the disable full fidelity

    • setDisableFullFidelity

      public void setDisableFullFidelity​(boolean disableFullFidelity)
      Sets the disable full fidelity.
      Parameters:
      disableFullFidelity - the new disable full fidelity

    • hasAttachment

      public boolean hasAttachment()
      Gets true if a message contains at least one attachment, otherwise false.
      Returns:
      true, if successful

    • setHasAttachment

      public void setHasAttachment​(boolean hasAttachment)
      Sets true if a message contains at least one attachment.
      Parameters:
      hasAttachment - the new checks for attachment

    • getRtfInSync

      public boolean getRtfInSync()
      Gets true if the getRtfCompressed() has the same text content as the getBody() for this message, otherwise false.
      Returns:
      the rtf in sync

    • setRtfInSync

      public void setRtfInSync​(boolean rtfInSync)
      Sets true if the getRtfCompressed() has the same text content as the getBody() for this message, otherwise false.
      Parameters:
      rtfInSync - the new rtf in sync

    • getReadReceiptRequested

      public boolean getReadReceiptRequested()
      Gets the read receipt requested.
      Returns:
      the read receipt requested

    • setReadReceiptRequested

      public void setReadReceiptRequested​(boolean readReceiptRequested)
      Sets the read receipt requested.
      Parameters:
      readReceiptRequested - the new read receipt requested

    • getDeliveryReportRequested

      public boolean getDeliveryReportRequested()
      Gets the delivery report requested.
      Returns:
      the delivery report requested

    • setDeliveryReportRequested

      public void setDeliveryReportRequested​(boolean deliveryReportRequested)
      Sets the delivery report requested.
      Parameters:
      deliveryReportRequested - the new delivery report requested

    • getBodyHtml

      public byte[] getBodyHtml()
      Gets the Hypertext Markup Language (HTML) version of the message text.
      Returns:
      the body html

    • setBodyHtml

      public void setBodyHtml​(byte[] bodyHtml)
      Sets the Hypertext Markup Language (HTML) version of the message text.
      Parameters:
      bodyHtml - the new body html

    • getBodyHtmlText

      public String getBodyHtmlText()
      Gets the Hypertext Markup Language (HTML) version of the message text.
      Returns:
      the body html text

    • setBodyHtmlText

      public void setBodyHtmlText​(String bodyHtmlText)
      Sets the Hypertext Markup Language (HTML) version of the message text.
      Parameters:
      bodyHtmlText - the new body html text

    • getSensitivity

      public Sensitivity getSensitivity()
      Gets a value that indicates the message sender's opinion of the sensitivity of a message.
      Returns:
      the sensitivity

    • setSensitivity

      public void setSensitivity​(Sensitivity sensitivity)
      Sets a value that indicates the message sender's opinion of the sensitivity of a message.
      Parameters:
      sensitivity - the new sensitivity

    • getLastVerbExecuted

      public LastVerbExecuted getLastVerbExecuted()
      Gets the last verb executed.
      Returns:
      the last verb executed

    • setLastVerbExecuted

      public void setLastVerbExecuted​(LastVerbExecuted lastVerbExecuted)
      Sets the last verb executed.
      Parameters:
      lastVerbExecuted - the new last verb executed

    • getImportance

      public Importance getImportance()
      Gets a value that indicates the message sender's opinion of the importance of a message.
      Returns:
      the importance

    • setImportance

      public void setImportance​(Importance importance)
      Sets a value that indicates the message sender's opinion of the importance of a message.
      Parameters:
      importance - the new importance

    • getPriority

      public Priority getPriority()
      Gets the relative priority of a message. Importance indicates a value to users, while priority indicates the order or speed at which the message should be sent by the messaging system software. Higher priority usually indicates a higher cost. Higher importance usually is associated with a different display by the user interface.
      Returns:
      the priority

    • setPriority

      public void setPriority​(Priority priority)
      Sets the relative priority of a message. Importance indicates a value to users, while priority indicates the order or speed at which the message should be sent by the messaging system software. Higher priority usually indicates a higher cost. Higher importance usually is associated with a different display by the user interface.
      Parameters:
      priority - the new priority

    • getFlagIcon

      public FlagIcon getFlagIcon()
      Gets the flag icon of the message object.
      Returns:
      the flag icon

    • setFlagIcon

      public void setFlagIcon​(FlagIcon flagIcon)
      Sets the flag icon of the message object.
      Parameters:
      flagIcon - the new flag icon

    • getFlagStatus

      public FlagStatus getFlagStatus()
      Gets the flag state of the message object.
      Returns:
      the flag status

    • setFlagStatus

      public void setFlagStatus​(FlagStatus flagStatus)
      Sets the flag state of the message object.
      Parameters:
      flagStatus - the new flag status

    • getObjectType

      public ObjectType getObjectType()
      Gets the type of an object.
      Returns:
      the object type

    • setObjectType

      public void setObjectType​(ObjectType objectType)
      Sets the type of an object.
      Parameters:
      objectType - the new object type

    • getReceivedRepresentingAddressType

      public String getReceivedRepresentingAddressType()
      Gets the address type for the messaging user who is represented by the user actually receiving the message.
      Returns:
      the received representing address type

    • setReceivedRepresentingAddressType

      public void setReceivedRepresentingAddressType​(String receivedRepresentingAddressType)
      Sets the address type for the messaging user who is represented by the user actually receiving the message.
      Parameters:
      receivedRepresentingAddressType - the new received representing address type

    • getReceivedRepresentingEmailAddress

      public String getReceivedRepresentingEmailAddress()
      Gets the e-mail address for the messaging user who is represented by the receiving user.
      Returns:
      the received representing email address

    • setReceivedRepresentingEmailAddress

      public void setReceivedRepresentingEmailAddress​(String receivedRepresentingEmailAddress)
      Sets the e-mail address for the messaging user who is represented by the receiving user.
      Parameters:
      receivedRepresentingEmailAddress - the new received representing email address

    • getReceivedRepresentingEntryId

      public byte[] getReceivedRepresentingEntryId()
      Gets the entry identifier for the messaging user who is represented by the receiving user.
      Returns:
      the received representing entry id

    • setReceivedRepresentingEntryId

      public void setReceivedRepresentingEntryId​(byte[] receivedRepresentingEntryId)
      Sets the entry identifier for the messaging user who is represented by the receiving user.
      Parameters:
      receivedRepresentingEntryId - the new received representing entry id

    • getReceivedRepresentingName

      public String getReceivedRepresentingName()
      Gets the display name for the messaging user who is represented by the receiving user.
      Returns:
      the received representing name

    • setReceivedRepresentingName

      public void setReceivedRepresentingName​(String receivedRepresentingName)
      Sets the display name for the messaging user who is represented by the receiving user.
      Parameters:
      receivedRepresentingName - the new received representing name

    • getReceivedRepresentingSearchKey

      public byte[] getReceivedRepresentingSearchKey()
      Gets the search key for the messaging user represented by the receiving user.
      Returns:
      the received representing search key

    • setReceivedRepresentingSearchKey

      public void setReceivedRepresentingSearchKey​(byte[] receivedRepresentingSearchKey)
      Sets the search key for the messaging user represented by the receiving user.
      Parameters:
      receivedRepresentingSearchKey - the new received representing search key

    • getReceivedByAddressType

      public String getReceivedByAddressType()
      Gets the e-mail address type, such as SMTP, for the messaging user who actually receives the message.
      Returns:
      the received by address type

    • setReceivedByAddressType

      public void setReceivedByAddressType​(String receivedByAddressType)
      Sets the e-mail address type, such as SMTP, for the messaging user who actually receives the message.
      Parameters:
      receivedByAddressType - the new received by address type

    • getReceivedByEmailAddress

      public String getReceivedByEmailAddress()
      Gets the e-mail address for the messaging user who receives the message.
      Returns:
      the received by email address

    • setReceivedByEmailAddress

      public void setReceivedByEmailAddress​(String receivedByEmailAddress)
      Sets the e-mail address for the messaging user who receives the message.
      Parameters:
      receivedByEmailAddress - the new received by email address

    • getReceivedByEntryId

      public byte[] getReceivedByEntryId()
      Gets the entry identifier of the messaging user who actually receives the message.
      Returns:
      the received by entry id

    • setReceivedByEntryId

      public void setReceivedByEntryId​(byte[] receivedByEntryId)
      Sets the entry identifier of the messaging user who actually receives the message.
      Parameters:
      receivedByEntryId - the new received by entry id

    • getReceivedByName

      public String getReceivedByName()
      Gets the display name of the messaging user who receives the message.
      Returns:
      the received by name

    • setReceivedByName

      public void setReceivedByName​(String receivedByName)
      Sets the display name of the messaging user who receives the message.
      Parameters:
      receivedByName - the new received by name

    • getReceivedBySearchKey

      public byte[] getReceivedBySearchKey()
      Gets the search key of the messaging user who receives the message.
      Returns:
      the received by search key

    • setReceivedBySearchKey

      public void setReceivedBySearchKey​(byte[] receivedBySearchKey)
      Sets the search key of the messaging user who receives the message.
      Parameters:
      receivedBySearchKey - the new received by search key

    • getSenderAddressType

      public String getSenderAddressType()
      Gets the message sender's e-mail address type.
      Returns:
      the sender address type

    • setSenderAddressType

      public void setSenderAddressType​(String senderAddressType)
      Sets the message sender's e-mail address type.
      Parameters:
      senderAddressType - the new sender address type

    • getSenderEmailAddress

      public String getSenderEmailAddress()
      Gets the message sender's e-mail address.
      Returns:
      the sender email address

    • setSenderEmailAddress

      public void setSenderEmailAddress​(String senderEmailAddress)
      Sets the message sender's e-mail address.
      Parameters:
      senderEmailAddress - the new sender email address

    • getSenderEntryId

      public byte[] getSenderEntryId()
      Gets the message sender's entry identifier.
      Returns:
      the sender entry id

    • setSenderEntryId

      public void setSenderEntryId​(byte[] senderEntryId)
      Sets the message sender's entry identifier.
      Parameters:
      senderEntryId - the new sender entry id

    • getSenderName

      public String getSenderName()
      Gets the message sender's display name.
      Returns:
      the sender name

    • setSenderName

      public void setSenderName​(String senderName)
      Sets the message sender's display name.
      Parameters:
      senderName - the new sender name

    • getSenderSearchKey

      public byte[] getSenderSearchKey()
      Gets the message sender's search key.
      Returns:
      the sender search key

    • setSenderSearchKey

      public void setSenderSearchKey​(byte[] senderSearchKey)
      Sets the message sender's search key.
      Parameters:
      senderSearchKey - the new sender search key

    • getSentRepresentingAddressType

      public String getSentRepresentingAddressType()
      Gets the address type for the messaging user who is represented by the sender.
      Returns:
      the sent representing address type

    • setSentRepresentingAddressType

      public void setSentRepresentingAddressType​(String sentRepresentingAddressType)
      Sets the address type for the messaging user who is represented by the sender.
      Parameters:
      sentRepresentingAddressType - the new sent representing address type

    • getSentRepresentingEmailAddress

      public String getSentRepresentingEmailAddress()
      Gets the e-mail address for the messaging user who is represented by the sender.
      Returns:
      the sent representing email address

    • setSentRepresentingEmailAddress

      public void setSentRepresentingEmailAddress​(String sentRepresentingEmailAddress)
      Sets the e-mail address for the messaging user who is represented by the sender.
      Parameters:
      sentRepresentingEmailAddress - the new sent representing email address

    • getSentRepresentingEntryId

      public byte[] getSentRepresentingEntryId()
      Gets the entry identifier for the messaging user represented by the sender.
      Returns:
      the sent representing entry id

    • setSentRepresentingEntryId

      public void setSentRepresentingEntryId​(byte[] sentRepresentingEntryId)
      Sets the entry identifier for the messaging user represented by the sender.
      Parameters:
      sentRepresentingEntryId - the new sent representing entry id

    • getSentRepresentingName

      public String getSentRepresentingName()
      Gets the display name for the messaging user represented by the sender.
      Returns:
      the sent representing name

    • setSentRepresentingName

      public void setSentRepresentingName​(String sentRepresentingName)
      Sets the display name for the messaging user represented by the sender.
      Parameters:
      sentRepresentingName - the new sent representing name

    • getSentRepresentingSearchKey

      public byte[] getSentRepresentingSearchKey()
      Gets the search key for the messaging user represented by the sender.
      Returns:
      the sent representing search key

    • setSentRepresentingSearchKey

      public void setSentRepresentingSearchKey​(byte[] sentRepresentingSearchKey)
      Sets the search key for the messaging user represented by the sender.
      Parameters:
      sentRepresentingSearchKey - the new sent representing search key

    • getTransportMessageHeaders

      public String getTransportMessageHeaders()
      Gets transport-specific message envelope information.
      Returns:
      the transport message headers

    • setTransportMessageHeaders

      public void setTransportMessageHeaders​(String transportMessageHeaders)
      Sets transport-specific message envelope information.
      Parameters:
      transportMessageHeaders - the new transport message headers

    • getMessageFlags

      public List<MessageFlag> getMessageFlags()
      Gets a bitmask of flags that indicate the origin and current state of a message. This field is a non-transmittable message field exposed at both the sending and receiving ends of a transmission, with different values depending upon the client application or store provider involved. This field is initialized by the client or message store provider when a message is created and saved for the first time and then updated periodically by the message store provider, a transport provider, and the MAPI spooler as the message is processed and its state changes. Exists on a message both before and after submission, and on all copies of the received message. Although it is not a recipient field, it is exposed differently to each recipient according to whether it has been read or modified by that recipient.
      Returns:
      the message flags

    • getStoreSupportMasks

      public List<StoreSupportMask> getStoreSupportMasks()
      Gets values that client applications should query to determine the characteristics of a message store.
      Returns:
      the store support masks

    • getOutlookVersion

      public String getOutlookVersion()
      Gets version number of Microsoft Office Outlook client.
      Returns:
      the outlook version

    • setOutlookVersion

      public void setOutlookVersion​(String outlookVersion)
      Sets version number of Microsoft Office Outlook client.
      Parameters:
      outlookVersion - the new outlook version

    • getOutlookInternalVersion

      public long getOutlookInternalVersion()
      Gets internal version number of Microsoft Office Outlook client.
      Returns:
      the outlook internal version

    • setOutlookInternalVersion

      public void setOutlookInternalVersion​(long outlookInternalVersion)
      Sets internal version number of Microsoft Office Outlook client.
      Parameters:
      outlookInternalVersion - the new outlook internal version

    • getCommonStartTime

      public Date getCommonStartTime()
      Gets the start date and time of a message.
      Returns:
      the common start time

    • setCommonStartTime

      public void setCommonStartTime​(Date commonStartTime)
      Sets the start date and time of a message.
      Parameters:
      commonStartTime - the new common start time

    • getCommonEndTime

      public Date getCommonEndTime()
      Gets the end date and time of a message.
      Returns:
      the common end time

    • setCommonEndTime

      public void setCommonEndTime​(Date commonEndTime)
      Sets the end date and time of a message.
      Parameters:
      commonEndTime - the new common end time

    • getFlagDueBy

      public Date getFlagDueBy()
      Gets the date and time specifying the date by which an e-mail message is due.
      Returns:
      the flag due by

    • setFlagDueBy

      public void setFlagDueBy​(Date flagDueBy)
      Sets the date and time specifying the date by which an e-mail message is due.
      Parameters:
      flagDueBy - the new flag due by

    • getCompanies

      public List<String> getCompanies()
      Gets the names of the companies associated with the contact item.
      Returns:
      the companies

    • getContactNames

      public List<String> getContactNames()
      Gets the names of the contacts associated with the item.
      Returns:
      the contact names

    • getKeywords

      public List<String> getKeywords()
      Gets the categories associated with a message.
      Returns:
      the keywords

    • getCategories

      public List<String> getCategories()
      Gets the categories associated with a message.
      Returns:
      the categories

    • getBillingInformation

      public String getBillingInformation()
      Gets the billing information associated with a message.
      Returns:
      the billing information

    • setBillingInformation

      public void setBillingInformation​(String billingInformation)
      Sets the billing information associated with a message.
      Parameters:
      billingInformation - the new billing information

    • getMileage

      public String getMileage()
      Gets free-form string value and can be used to store mileage information associated with the message.
      Returns:
      the mileage

    • setMileage

      public void setMileage​(String mileage)
      Sets free-form string value and can be used to store mileage information associated with the message.
      Parameters:
      mileage - the new mileage

    • getReminderSoundFile

      public String getReminderSoundFile()
      Gets the path and file name of the sound file to play when the reminder occurs for the appointment, mail message, or task.
      Returns:
      the reminder sound file

    • setReminderSoundFile

      public void setReminderSoundFile​(String reminderSoundFile)
      Sets the path and file name of the sound file to play when the reminder occurs for the appointment, mail message, or task.
      Parameters:
      reminderSoundFile - the new reminder sound file

    • isPrivate

      public boolean isPrivate()
      Gets true if message is marked as private.
      Returns:
      true, if is private

    • setPrivate

      public void setPrivate​(boolean isPrivate)
      Sets true if message is marked as private.
      Parameters:
      isPrivate - the new private

    • getReminderOverrideDefault

      public boolean getReminderOverrideDefault()
      Gets true if the reminder overrides the default reminder behavior for the appointment, mail item, or task.
      Returns:
      the reminder override default

    • setReminderOverrideDefault

      public void setReminderOverrideDefault​(boolean reminderOverrideDefault)
      Sets true if the reminder overrides the default reminder behavior for the appointment, mail item, or task.
      Parameters:
      reminderOverrideDefault - the new reminder override default

    • getReminderPlaySound

      public boolean getReminderPlaySound()
      Gets true if the reminder should play a sound when it occurs for this appointment or task.
      Returns:
      the reminder play sound

    • setReminderPlaySound

      public void setReminderPlaySound​(boolean reminderPlaySound)
      Gets true if the reminder should play a sound when it occurs for this appointment or task.
      Parameters:
      reminderPlaySound - the new reminder play sound

    • getAppointmentStartTime

      public Date getAppointmentStartTime()
      Gets appointment's the start date and time.
      Returns:
      the appointment start time

    • setAppointmentStartTime

      public void setAppointmentStartTime​(Date appointmentStartTime)
      Sets appointment's the start date and time.
      Parameters:
      appointmentStartTime - the new appointment start time

    • getAppointmentEndTime

      public Date getAppointmentEndTime()
      Gets appointment's the end date and time.
      Returns:
      the appointment end time

    • setAppointmentEndTime

      public void setAppointmentEndTime​(Date appointmentEndTime)
      Sets appointment's the end date and time.
      Parameters:
      appointmentEndTime - the new appointment end time

    • getLocation

      public String getLocation()
      Gets appointment's location.
      Returns:
      the location

    • setLocation

      public void setLocation​(String location)
      Sets appointment's location.
      Parameters:
      location - the new location

    • getAppointmentMessageClass

      public String getAppointmentMessageClass()
      Gets appointment's message class.
      Returns:
      the appointment message class

    • setAppointmentMessageClass

      public void setAppointmentMessageClass​(String appointmentMessageClass)
      Sets appointment's message class.
      Parameters:
      appointmentMessageClass - the new appointment message class

    • getTimeZone

      public String getTimeZone()
      Gets appointment's time zone.
      Returns:
      the time zone

    • setTimeZone

      public void setTimeZone​(String timeZone)
      Sets appointment's time zone.
      Parameters:
      timeZone - the new time zone

    • getRecurrencePattern

      public String getRecurrencePattern()
      Gets appointment's recurring pattern.
      Returns:
      the recurrence pattern

    • setRecurrencePattern

      public void setRecurrencePattern​(String recurrencePattern)
      Sets appointment's recurring pattern.
      Parameters:
      recurrencePattern - the new recurrence pattern

    • getGuid

      public byte[] getGuid()
      Gets message's global unique id.
      Returns:
      the guid

    • setGuid

      public void setGuid​(byte[] guid)
      Sets message's global unique id.
      Parameters:
      guid - the new guid

    • getLabel

      public int getLabel()
      Gets appointment's label color.
      Returns:
      the label

    • setLabel

      public void setLabel​(int label)
      Sets appointment's label color.
      Parameters:
      label - the new label

    • getDuration

      public int getDuration()
      Gets appointment's duration in minutes.
      Returns:
      the duration

    • setDuration

      public void setDuration​(int duration)
      Sets appointment's duration in minutes.
      Parameters:
      duration - the new duration

    • getBusyStatus

      public BusyStatus getBusyStatus()
      Gets appointment's busy status.
      Returns:
      the busy status

    • setBusyStatus

      public void setBusyStatus​(BusyStatus busyStatus)
      Sets appointment's busy status.
      Parameters:
      busyStatus - the new busy status

    • getMeetingStatus

      public MeetingStatus getMeetingStatus()
      Gets the status of the meeting.
      Returns:
      the meeting status

    • setMeetingStatus

      public void setMeetingStatus​(MeetingStatus meetingStatus)
      Sets the status of the meeting.
      Parameters:
      meetingStatus - the new meeting status

    • getResponseStatus

      public ResponseStatus getResponseStatus()
      Gets the response to a meeting request.
      Returns:
      the response status

    • setResponseStatus

      public void setResponseStatus​(ResponseStatus responseStatus)
      Sets the response to a meeting request.
      Parameters:
      responseStatus - the new response status

    • getRecurrenceType

      public RecurrenceType getRecurrenceType()
      Gets the recurrence pattern type.
      Returns:
      the recurrence type

    • setRecurrenceType

      public void setRecurrenceType​(RecurrenceType recurrenceType)
      Sets the recurrence pattern type.
      Parameters:
      recurrenceType - the new recurrence type

    • getOwner

      public String getOwner()
      Gets task's owner name.
      Returns:
      the owner

    • setOwner

      public void setOwner​(String owner)
      Sets task's owner name.
      Parameters:
      owner - the new owner

    • getDelegator

      public String getDelegator()
      Gets task's delegator name.
      Returns:
      the delegator

    • setDelegator

      public void setDelegator​(String delegator)
      Sets task's delegator name.
      Parameters:
      delegator - the new delegator

    • getPercentComplete

      public double getPercentComplete()
      Gets the percentage of the task completed at the current date and time.
      Returns:
      the percent complete

    • setPercentComplete

      public void setPercentComplete​(double percentComplete)
      Sets the percentage of the task completed at the current date and time.
      Parameters:
      percentComplete - the new percent complete

    • getActualWork

      public long getActualWork()
      Gets the actual effort (in minutes) spent on the task.\
      Returns:
      the actual work

    • setActualWork

      public void setActualWork​(long actualWork)
      Sets the actual effort (in minutes) spent on the task.
      Parameters:
      actualWork - the new actual work

    • getTotalWork

      public long getTotalWork()
      Gets the total work for the task.
      Returns:
      the total work

    • setTotalWork

      public void setTotalWork​(long totalWork)
      Sets the total work for the task.
      Parameters:
      totalWork - the new total work

    • isTeamTask

      public boolean isTeamTask()
      Gets true if the task is a team task, otherwise false.
      Returns:
      true, if is team task

    • setTeamTask

      public void setTeamTask​(boolean isTeamTask)
      Sets true if the task is a team task.
      Parameters:
      isTeamTask - the new team task

    • isComplete

      public boolean isComplete()
      Gets true if the task is complete, otherwise false.
      Returns:
      true, if is complete

    • setComplete

      public void setComplete​(boolean isComplete)
      Sets true if the task is complete.
      Parameters:
      isComplete - the new complete

    • isRecurring

      public boolean isRecurring()
      Gets true if the task or appointment is recurring, otherwise false.
      Returns:
      true, if is recurring

    • setRecurring

      public void setRecurring​(boolean isRecurring)
      Sets true if the task or appointment is recurring.
      Parameters:
      isRecurring - the new recurring

    • isAllDayEvent

      public boolean isAllDayEvent()
      Gets true if the appointment is all day event, otherwise false.
      Returns:
      true, if is all day event

    • setAllDayEvent

      public void setAllDayEvent​(boolean isAllDayEvent)
      Sets true if the appointment is all day event.
      Parameters:
      isAllDayEvent - the new all day event

    • isReminderSet

      public boolean isReminderSet()
      Gets true if a reminder has been set for this appointment, e-mail item, or task, otherwise false.
      Returns:
      true, if is reminder set

    • setReminderSet

      public void setReminderSet​(boolean isReminderSet)
      Sets true if a reminder has been set for this appointment, e-mail item, or task.
      Parameters:
      isReminderSet - the new reminder set

    • getReminderTime

      public Date getReminderTime()
      Gets the date and time at which the reminder should occur for the specified item.
      Returns:
      the reminder time

    • setReminderTime

      public void setReminderTime​(Date reminderTime)
      Sets the date and time at which the reminder should occur for the specified item.
      Parameters:
      reminderTime - the new reminder time

    • getReminderMinutesBeforeStart

      public long getReminderMinutesBeforeStart()
      Gets the number of minutes the reminder should occur prior to the start of the appointment.
      Returns:
      the reminder minutes before start

    • setReminderMinutesBeforeStart

      public void setReminderMinutesBeforeStart​(long reminderMinutesBeforeStart)
      Sets the number of minutes the reminder should occur prior to the start of the appointment.
      Parameters:
      reminderMinutesBeforeStart - the new reminder minutes before start

    • getTaskStartDate

      public Date getTaskStartDate()
      Gets task's the start date and time.
      Returns:
      the task start date

    • setTaskStartDate

      public void setTaskStartDate​(Date taskStartDate)
      Sets task's the start date and time.
      Parameters:
      taskStartDate - the new task start date

    • getTaskDueDate

      public Date getTaskDueDate()
      Gets task's the due date and time.
      Returns:
      the task due date

    • setTaskDueDate

      public void setTaskDueDate​(Date taskDueDate)
      Sets task's the due date and time.
      Parameters:
      taskDueDate - the new task due date

    • getDateCompleted

      public Date getDateCompleted()
      Gets the completion date of the task.
      Returns:
      the date completed

    • setDateCompleted

      public void setDateCompleted​(Date dateCompleted)
      Sets the completion date of the task.
      Parameters:
      dateCompleted - the new date completed

    • getTaskStatus

      public TaskStatus getTaskStatus()
      Gets the status of the task.
      Returns:
      the task status

    • setTaskStatus

      public void setTaskStatus​(TaskStatus taskStatus)
      Sets the status of the task.
      Parameters:
      taskStatus - the new task status

    • getTaskOwnership

      public TaskOwnership getTaskOwnership()
      Gets the ownership state of the task.
      Returns:
      the task ownership

    • setTaskOwnership

      public void setTaskOwnership​(TaskOwnership taskOwnership)
      Sets the ownership state of the task.
      Parameters:
      taskOwnership - the new task ownership

    • getTaskDelegationState

      public TaskDelegationState getTaskDelegationState()
      Gets the delegation state of a task.
      Returns:
      the task delegation state

    • setTaskDelegationState

      public void setTaskDelegationState​(TaskDelegationState taskDelegationState)
      Sets the delegation state of a task.
      Parameters:
      taskDelegationState - the new task delegation state

    • getNoteHeight

      public long getNoteHeight()
      Gets height of the note item.
      Returns:
      the note height

    • setNoteHeight

      public void setNoteHeight​(long noteHeight)
      Sets height of the note item.
      Parameters:
      noteHeight - the new note height

    • getNoteWidth

      public long getNoteWidth()
      Gets width of the note item.
      Returns:
      the note width

    • setNoteWidth

      public void setNoteWidth​(long noteWidth)
      Sets width of the note item.
      Parameters:
      noteWidth - the new note width

    • getNoteTop

      public long getNoteTop()
      Gets top position of the note item.
      Returns:
      the note top

    • setNoteTop

      public void setNoteTop​(long noteTop)
      Sets top position of the note item.
      Parameters:
      noteTop - the new note top

    • getNoteLeft

      public long getNoteLeft()
      Gets left position of the note item.
      Returns:
      the note left

    • setNoteLeft

      public void setNoteLeft​(long noteLeft)
      Sets left position of the note item.
      Parameters:
      noteLeft - the new note left

    • getNoteColor

      public NoteColor getNoteColor()
      Gets background color of the note item.
      Returns:
      the note color

    • setNoteColor

      public void setNoteColor​(NoteColor noteColor)
      Sets background color of the note item.
      Parameters:
      noteColor - the new note color

    • getJournalStartTime

      public Date getJournalStartTime()
      Gets journal's the start date and time.
      Returns:
      the journal start time

    • setJournalStartTime

      public void setJournalStartTime​(Date journalStartTime)
      Sets journal's the start date and time.
      Parameters:
      journalStartTime - the new journal start time

    • getJournalEndTime

      public Date getJournalEndTime()
      Gets journal's the end date and time.
      Returns:
      the journal end time

    • setJournalEndTime

      public void setJournalEndTime​(Date journalEndTime)
      Sets journal's the end date and time.
      Parameters:
      journalEndTime - the new journal end time

    • getJournalType

      public String getJournalType()
      Gets the type of the journal item.
      Returns:
      the journal type

    • setJournalType

      public void setJournalType​(String journalType)
      Sets the type of the journal item.
      Parameters:
      journalType - the new journal type

    • getJournalTypeDescription

      public String getJournalTypeDescription()
      Gets the type description of the journal item.
      Returns:
      the journal type description

    • setJournalTypeDescription

      public void setJournalTypeDescription​(String journalTypeDescription)
      Sets the type description of the journal item.
      Parameters:
      journalTypeDescription - the new journal type description

    • getJournalDuration

      public long getJournalDuration()
      Gets journal's the duration in minutes.
      Returns:
      the journal duration

    • setJournalDuration

      public void setJournalDuration​(long journalDuration)
      Sets journal's the duration in minutes.
      Parameters:
      journalDuration - the new journal duration

    • getBirthday

      public Date getBirthday()
      Gets the birthday date for the contact.
      Returns:
      the birthday

    • setBirthday

      public void setBirthday​(Date birthday)
      Sets the birthday date for the contact.
      Parameters:
      birthday - the new birthday

    • getChildrenNames

      public List<String> getChildrenNames()
      Gest the names of the children of the contact.
      Returns:
      the children names

    • getAssistentName

      public String getAssistentName()
      Gets the name of assistent of the contact.
      Returns:
      the assistent name

    • setAssistentName

      public void setAssistentName​(String assistentName)
      Sets the name of assistent of the contact.
      Parameters:
      assistentName - the new assistent name

    • getAssistentPhone

      public String getAssistentPhone()
      Gets assistent's phone number of the contact.
      Returns:
      the assistent phone

    • setAssistentPhone

      public void setAssistentPhone​(String assistentPhone)
      Sets assistent's phone number of the contact.
      Parameters:
      assistentPhone - the new assistent phone

    • getBusinessPhone

      public String getBusinessPhone()
      Gets the first business telephone number for the contact.
      Returns:
      the business phone

    • setBusinessPhone

      public void setBusinessPhone​(String businessPhone)
      Sets the first business telephone number for the contact.
      Parameters:
      businessPhone - the new business phone

    • getBusinessFax

      public String getBusinessFax()
      Gets the business fax number for the contact.
      Returns:
      the business fax

    • setBusinessFax

      public void setBusinessFax​(String businessFax)
      Sets the business fax number for the contact.
      Parameters:
      businessFax - the new business fax

    • getBusinessHomePage

      public String getBusinessHomePage()
      Gets the url of the business Web page for the contact.
      Returns:
      the business home page

    • setBusinessHomePage

      public void setBusinessHomePage​(String businessHomePage)
      Sets the url of the business Web page for the contact.
      Parameters:
      businessHomePage - the new business home page

    • getCallbackPhone

      public String getCallbackPhone()
      Gets the callback telephone number for the contact.
      Returns:
      the callback phone

    • setCallbackPhone

      public void setCallbackPhone​(String callbackPhone)
      Sets the callback telephone number for the contact.
      Parameters:
      callbackPhone - the new callback phone

    • getCarPhone

      public String getCarPhone()
      Gets the car telephone number for the contact.
      Returns:
      the car phone

    • setCarPhone

      public void setCarPhone​(String carPhone)
      Sets the car telephone number for the contact.
      Parameters:
      carPhone - the new car phone

    • getCellularPhone

      public String getCellularPhone()
      Gets the mobile telephone number for the contact.
      Returns:
      the cellular phone

    • setCellularPhone

      public void setCellularPhone​(String cellularPhone)
      Sets the mobile telephone number for the contact.
      Parameters:
      cellularPhone - the new cellular phone

    • getCompanyMainPhone

      public String getCompanyMainPhone()
      Gets the company main telephone number for the contact.
      Returns:
      the company main phone

    • setCompanyMainPhone

      public void setCompanyMainPhone​(String companyMainPhone)
      Sets the company main telephone number for the contact.
      Parameters:
      companyMainPhone - the new company main phone

    • getCompanyName

      public String getCompanyName()
      Gets the company name for the contact.
      Returns:
      the company name

    • setCompanyName

      public void setCompanyName​(String companyName)
      Sets the company name for the contact.
      Parameters:
      companyName - the new company name

    • getComputerNetworkName

      public String getComputerNetworkName()
      Gets the name of the computer network for the contact.
      Returns:
      the computer network name

    • setComputerNetworkName

      public void setComputerNetworkName​(String computerNetworkName)
      Sets the name of the computer network for the contact.
      Parameters:
      computerNetworkName - the new computer network name

    • getBusinessAddressCountry

      public String getBusinessAddressCountry()
      Gets the country/region code portion of the business address for the contact.
      Returns:
      the business address country

    • setBusinessAddressCountry

      public void setBusinessAddressCountry​(String businessAddressCountry)
      Sets the country/region code portion of the business address for the contact.
      Parameters:
      businessAddressCountry - the new business address country

    • getCustomerId

      public String getCustomerId()
      Gets the customer ID for the contact.
      Returns:
      the customer id

    • setCustomerId

      public void setCustomerId​(String customerId)
      Sets the customer ID for the contact.
      Parameters:
      customerId - the new customer id

    • getDepartmentName

      public String getDepartmentName()
      Gets the department name for the contact.
      Returns:
      the department name

    • setDepartmentName

      public void setDepartmentName​(String departmentName)
      Sets the department name for the contact.
      Parameters:
      departmentName - the new department name

    • getDisplayName

      public String getDisplayName()
      Gets display name.
      Returns:
      the display name

    • setDisplayName

      public void setDisplayName​(String displayName)
      Sets display name.
      Parameters:
      displayName - the new display name

    • getDisplayNamePrefix

      public String getDisplayNamePrefix()
      Gets display name prefix.
      Returns:
      the display name prefix

    • setDisplayNamePrefix

      public void setDisplayNamePrefix​(String displayNamePrefix)
      Sets display name prefix.
      Parameters:
      displayNamePrefix - the new display name prefix

    • getFtpSite

      public String getFtpSite()
      Gets the FTP site entry for the contact.
      Returns:
      the ftp site

    • setFtpSite

      public void setFtpSite​(String ftpSite)
      Sets the FTP site entry for the contact.
      Parameters:
      ftpSite - the new ftp site

    • getGeneration

      public String getGeneration()
      Gets the generation for the contact.
      Returns:
      the generation

    • setGeneration

      public void setGeneration​(String generation)
      Sets the generation for the contact.
      Parameters:
      generation - the new generation

    • getGivenName

      public String getGivenName()
      Gets the given name for the contact.
      Returns:
      the given name

    • setGivenName

      public void setGivenName​(String givenName)
      Sets the given name for the contact.
      Parameters:
      givenName - the new given name

    • getGovernmentId

      public String getGovernmentId()
      Gets the government ID number for the contact.
      Returns:
      the government id

    • setGovernmentId

      public void setGovernmentId​(String governmentId)
      Sets the government ID number for the contact.
      Parameters:
      governmentId - the new government id

    • getHobbies

      public String getHobbies()
      Gets the hobby names for the contact.
      Returns:
      the hobbies

    • setHobbies

      public void setHobbies​(String hobbies)
      Sets the hobby names for the contact.
      Parameters:
      hobbies - the new hobbies

    • getHomePhone2

      public String getHomePhone2()
      Gets the second home telephone number for the contact.
      Returns:
      the home phone2

    • setHomePhone2

      public void setHomePhone2​(String homePhone2)
      Sets the second home telephone number for the contact.
      Parameters:
      homePhone2 - the new home phone2

    • getHomeAddressCity

      public String getHomeAddressCity()
      Gets the city portion of the home address for the contact.
      Returns:
      the home address city

    • setHomeAddressCity

      public void setHomeAddressCity​(String homeAddressCity)
      Sets the city portion of the home address for the contact.
      Parameters:
      homeAddressCity - the new home address city

    • getHomeAddressCountry

      public String getHomeAddressCountry()
      Gets the country/region portion of the home address for the contact.
      Returns:
      the home address country

    • setHomeAddressCountry

      public void setHomeAddressCountry​(String homeAddressCountry)
      Sets the country/region portion of the home address for the contact.
      Parameters:
      homeAddressCountry - the new home address country

    • getHomeAddressPostalCode

      public String getHomeAddressPostalCode()
      Gets the postal code portion of the home address for the contact.
      Returns:
      the home address postal code

    • setHomeAddressPostalCode

      public void setHomeAddressPostalCode​(String homeAddressPostalCode)
      Sets the postal code portion of the home address for the contact.
      Parameters:
      homeAddressPostalCode - the new home address postal code

    • getHomeAddressPostOfficeBox

      public String getHomeAddressPostOfficeBox()
      Gets the post office box number portion of the home address for the contact.
      Returns:
      the home address post office box

    • setHomeAddressPostOfficeBox

      public void setHomeAddressPostOfficeBox​(String homeAddressPostOfficeBox)
      Sets the post office box number portion of the home address for the contact.
      Parameters:
      homeAddressPostOfficeBox - the new home address post office box

    • getHomeAddressState

      public String getHomeAddressState()
      Sets the state portion of the home address for the contact.
      Returns:
      the home address state

    • setHomeAddressState

      public void setHomeAddressState​(String homeAddressState)
      Gets the state portion of the home address for the contact.
      Parameters:
      homeAddressState - the new home address state

    • getHomeAddressStreet

      public String getHomeAddressStreet()
      Gets the street portion of the home address for the contact.
      Returns:
      the home address street

    • setHomeAddressStreet

      public void setHomeAddressStreet​(String homeAddressStreet)
      Sets the street portion of the home address for the contact.
      Parameters:
      homeAddressStreet - the new home address street

    • getHomeFax

      public String getHomeFax()
      Gets the home fax number for the contact.
      Returns:
      the home fax

    • setHomeFax

      public void setHomeFax​(String homeFax)
      Sets the home fax number for the contact.
      Parameters:
      homeFax - the new home fax

    • getHomePhone

      public String getHomePhone()
      Gets the first home telephone number for the contact.
      Returns:
      the home phone

    • setHomePhone

      public void setHomePhone​(String homePhone)
      Sets the first home telephone number for the contact.
      Parameters:
      homePhone - the new home phone

    • getInitials

      public String getInitials()
      Gets the initials for the contact.
      Returns:
      the initials

    • setInitials

      public void setInitials​(String initials)
      Sets the initials for the contact.
      Parameters:
      initials - the new initials

    • getIsdn

      public String getIsdn()
      Gets the ISDN number for the contact.
      Returns:
      the isdn

    • setIsdn

      public void setIsdn​(String isdn)
      Sets the ISDN number for the contact.
      Parameters:
      isdn - the new isdn

    • getBusinessAddressCity

      public String getBusinessAddressCity()
      Gets the city name portion of the business address for the contact.
      Returns:
      the business address city

    • setBusinessAddressCity

      public void setBusinessAddressCity​(String businessAddressCity)
      Sets the city name portion of the business address for the contact.
      Parameters:
      businessAddressCity - the new business address city

    • getManagerName

      public String getManagerName()
      Gets the manager name for the contact.
      Returns:
      the manager name

    • setManagerName

      public void setManagerName​(String managerName)
      Sets the manager name for the contact.
      Parameters:
      managerName - the new manager name

    • getMiddleName

      public String getMiddleName()
      Gets the middle name for the contact.
      Returns:
      the middle name

    • setMiddleName

      public void setMiddleName​(String middleName)
      Sets the middle name for the contact.
      Parameters:
      middleName - the new middle name

    • getNickname

      public String getNickname()
      Gets the nickname for the contact.
      Returns:
      the nickname

    • setNickname

      public void setNickname​(String nickname)
      Sets the nickname for the contact.
      Parameters:
      nickname - the new nickname

    • getOfficeLocation

      public String getOfficeLocation()
      Gets the specific office location for the contact.
      Returns:
      the office location

    • setOfficeLocation

      public void setOfficeLocation​(String officeLocation)
      Sets the specific office location for the contact.
      Parameters:
      officeLocation - the new office location

    • getBusinessPhone2

      public String getBusinessPhone2()
      Gets the second business telephone number for the contact.
      Returns:
      the business phone2

    • setBusinessPhone2

      public void setBusinessPhone2​(String businessPhone2)
      Sets the second business telephone number for the contact.
      Parameters:
      businessPhone2 - the new business phone2

    • getOtherAddressCity

      public String getOtherAddressCity()
      Gets the city portion of the other address for the contact.
      Returns:
      the other address city

    • setOtherAddressCity

      public void setOtherAddressCity​(String otherAddressCity)
      Sets the city portion of the other address for the contact.
      Parameters:
      otherAddressCity - the new other address city

    • getOtherAddressCountry

      public String getOtherAddressCountry()
      Gets the country/region portion of the other address for the contact.
      Returns:
      the other address country

    • setOtherAddressCountry

      public void setOtherAddressCountry​(String otherAddressCountry)
      Sets the country/region portion of the other address for the contact.
      Parameters:
      otherAddressCountry - the new other address country

    • getOtherAddressPostalCode

      public String getOtherAddressPostalCode()
      Gets the postal code portion of the other address for the contact.
      Returns:
      the other address postal code

    • setOtherAddressPostalCode

      public void setOtherAddressPostalCode​(String otherAddressPostalCode)
      Sets the postal code portion of the other address for the contact.
      Parameters:
      otherAddressPostalCode - the new other address postal code

    • getOtherAddressState

      public String getOtherAddressState()
      Gets the state portion of the other address for the contact.
      Returns:
      the other address state

    • setOtherAddressState

      public void setOtherAddressState​(String otherAddressState)
      Sets the state portion of the other address for the contact.
      Parameters:
      otherAddressState - the new other address state

    • getOtherAddressStreet

      public String getOtherAddressStreet()
      Gets the street portion of the other address for the contact.
      Returns:
      the other address street

    • setOtherAddressStreet

      public void setOtherAddressStreet​(String otherAddressStreet)
      Sets the street portion of the other address for the contact.
      Parameters:
      otherAddressStreet - the new other address street

    • getOtherPhone

      public String getOtherPhone()
      Gets the other telephone number for the contact.
      Returns:
      the other phone

    • setOtherPhone

      public void setOtherPhone​(String otherPhone)
      Sets the other telephone number for the contact.
      Parameters:
      otherPhone - the new other phone

    • getPager

      public String getPager()
      Gets the pager number for the contact.
      Returns:
      the pager

    • setPager

      public void setPager​(String pager)
      Sets the pager number for the contact.
      Parameters:
      pager - the new pager

    • getPersonalHomePage

      public String getPersonalHomePage()
      Gets the url of the personal Web page for the contact.
      Returns:
      the personal home page

    • setPersonalHomePage

      public void setPersonalHomePage​(String personalHomePage)
      Sets the url of the personal Web page for the contact.
      Parameters:
      personalHomePage - the new personal home page

    • getPostalAddress

      public String getPostalAddress()
      Gets the postal address for the contact.
      Returns:
      the postal address

    • setPostalAddress

      public void setPostalAddress​(String postalAddress)
      Sets the postal address for the contact.
      Parameters:
      postalAddress - the new postal address

    • getBusinessAddressPostalCode

      public String getBusinessAddressPostalCode()
      Gets the postal code (zip code) portion of the business address for the contact.
      Returns:
      the business address postal code

    • setBusinessAddressPostalCode

      public void setBusinessAddressPostalCode​(String businessAddressPostalCode)
      Sets the postal code (zip code) portion of the business address for the contact.
      Parameters:
      businessAddressPostalCode - the new business address postal code

    • getBusinessAddressPostOfficeBox

      public String getBusinessAddressPostOfficeBox()
      Gets the post office box number portion of the business address for the contact.
      Returns:
      the business address post office box

    • setBusinessAddressPostOfficeBox

      public void setBusinessAddressPostOfficeBox​(String businessAddressPostOfficeBox)
      Sets the post office box number portion of the business address for the contact.
      Parameters:
      businessAddressPostOfficeBox - the new business address post office box

    • getBusinessAddressState

      public String getBusinessAddressState()
      Gets the state code portion of the business address for the contact.
      Returns:
      the business address state

    • setBusinessAddressState

      public void setBusinessAddressState​(String businessAddressState)
      Sets the state code portion of the business address for the contact.
      Parameters:
      businessAddressState - the new business address state

    • getBusinessAddressStreet

      public String getBusinessAddressStreet()
      Gets the street address portion of the business address for the contact.
      Returns:
      the business address street

    • setBusinessAddressStreet

      public void setBusinessAddressStreet​(String businessAddressStreet)
      Sets the street address portion of the business address for the contact.
      Parameters:
      businessAddressStreet - the new business address street

    • getPrimaryFax

      public String getPrimaryFax()
      Gets the primary fax number for the contact.
      Returns:
      the primary fax

    • setPrimaryFax

      public void setPrimaryFax​(String primaryFax)
      Sets the primary fax number for the contact.
      Parameters:
      primaryFax - the new primary fax

    • getPrimaryPhone

      public String getPrimaryPhone()
      Gets the primary telephone number for the contact.
      Returns:
      the primary phone

    • setPrimaryPhone

      public void setPrimaryPhone​(String primaryPhone)
      Sets the primary telephone number for the contact.
      Parameters:
      primaryPhone - the new primary phone

    • getProfession

      public String getProfession()
      Gets the profession for the contact.
      Returns:
      the profession

    • setProfession

      public void setProfession​(String profession)
      Gets the profession for the contact.
      Parameters:
      profession - the new profession

    • getRadioPhone

      public String getRadioPhone()
      Gets the radio telephone number for the contact.
      Returns:
      the radio phone

    • setRadioPhone

      public void setRadioPhone​(String radioPhone)
      Sets the radio telephone number for the contact.
      Parameters:
      radioPhone - the new radio phone

    • getSpouseName

      public String getSpouseName()
      Gets the spouse name for the contact.
      Returns:
      the spouse name

    • setSpouseName

      public void setSpouseName​(String spouseName)
      Sets the spouse name for the contact.
      Parameters:
      spouseName - the new spouse name

    • getSurname

      public String getSurname()
      Gets the last name for the contact.
      Returns:
      the surname

    • setSurname

      public void setSurname​(String surname)
      Sets the last name for the contact.
      Parameters:
      surname - the new surname

    • getTelex

      public String getTelex()
      Gets the telex number for the contact.
      Returns:
      the telex

    • setTelex

      public void setTelex​(String telex)
      Sets the telex number for the contact.
      Parameters:
      telex - the new telex

    • getTitle

      public String getTitle()
      Gets the title for the contact.
      Returns:
      the title

    • setTitle

      public void setTitle​(String title)
      Sets the title for the contact.
      Parameters:
      title - the new title

    • getTtyTddPhone

      public String getTtyTddPhone()
      Gets the TTY/TDD telephone number for the contact.
      Returns:
      the tty tdd phone

    • setTtyTddPhone

      public void setTtyTddPhone​(String ttyTddPhone)
      Sets the TTY/TDD telephone number for the contact.
      Parameters:
      ttyTddPhone - the new tty tdd phone

    • getWeddingAnniversary

      public Date getWeddingAnniversary()
      Gets the wedding anniversary date for the contact.
      Returns:
      the wedding anniversary

    • setWeddingAnniversary

      public void setWeddingAnniversary​(Date weddingAnniversary)
      Sets the wedding anniversary date for the contact.
      Parameters:
      weddingAnniversary - the new wedding anniversary

    • getSelectedMailingAddress

      public SelectedMailingAddress getSelectedMailingAddress()
      Gets the type of the mailing address for the contact.
      Returns:
      the selected mailing address

    • setSelectedMailingAddress

      public void setSelectedMailingAddress​(SelectedMailingAddress selectedMailingAddress)
      Sets the type of the mailing address for the contact.
      Parameters:
      selectedMailingAddress - the new selected mailing address

    • getContactHasPicture

      public boolean getContactHasPicture()
      Gets true if the contact has picture, otherwise false.
      Returns:
      the contact has picture

    • setContactHasPicture

      public void setContactHasPicture​(boolean contactHasPicture)
      Sets true if the contact has picture.
      Parameters:
      contactHasPicture - the new contact has picture

    • getFileAs

      public String getFileAs()
      Gets the default keyword string assigned to the contact when it is filed.
      Returns:
      the file as

    • setFileAs

      public void setFileAs​(String fileAs)
      Sets the default keyword string assigned to the contact when it is filed.
      Parameters:
      fileAs - the new file as

    • getInstantMessengerAddress

      public String getInstantMessengerAddress()
      Gets the instant messenger address for the contact.
      Returns:
      the instant messenger address

    • setInstantMessengerAddress

      public void setInstantMessengerAddress​(String instantMessengerAddress)
      Sets the instant messenger address for the contact.
      Parameters:
      instantMessengerAddress - the new instant messenger address

    • getInternetFreeBusyAddress

      public String getInternetFreeBusyAddress()
      Gets the url location of the user's free-busy information in vCard Free-Busy standard format.
      Returns:
      the internet free busy address

    • setInternetFreeBusyAddress

      public void setInternetFreeBusyAddress​(String internetFreeBusyAddress)
      Sets the url location of the user's free-busy information in vCard Free-Busy standard format.
      Parameters:
      internetFreeBusyAddress - the new internet free busy address

    • getBusinessAddress

      public String getBusinessAddress()
      Gets the whole, unparsed business address for the contact.
      Returns:
      the business address

    • setBusinessAddress

      public void setBusinessAddress​(String businessAddress)
      Sets the whole, unparsed business address for the contact.
      Parameters:
      businessAddress - the new business address

    • getHomeAddress

      public String getHomeAddress()
      Gets the whole, unparsed home address for the contact.
      Returns:
      the home address

    • setHomeAddress

      public void setHomeAddress​(String homeAddress)
      Sets the whole, unparsed home address for the contact.
      Parameters:
      homeAddress - the new home address

    • getOtherAddress

      public String getOtherAddress()
      Gets the whole, unparsed other address for the contact.
      Returns:
      the other address

    • setOtherAddress

      public void setOtherAddress​(String otherAddress)
      Sets the whole, unparsed other address for the contact.
      Parameters:
      otherAddress - the new other address

    • getEmail1Address

      public String getEmail1Address()
      Gets the e-mail address of the first e-mail entry for the contact.
      Returns:
      the email1 address

    • setEmail1Address

      public void setEmail1Address​(String email1Address)
      Sets the e-mail address of the first e-mail entry for the contact.
      Parameters:
      email1Address - the new email1 address

    • getEmail2Address

      public String getEmail2Address()
      Gets the e-mail address of the second e-mail entry for the contact.
      Returns:
      the email2 address

    • setEmail2Address

      public void setEmail2Address​(String email2Address)
      Sets the e-mail address of the second e-mail entry for the contact.
      Parameters:
      email2Address - the new email2 address

    • getEmail3Address

      public String getEmail3Address()
      Gets the e-mail address of the third e-mail entry for the contact.
      Returns:
      the email3 address

    • setEmail3Address

      public void setEmail3Address​(String email3Address)
      Sets the e-mail address of the third e-mail entry for the contact.
      Parameters:
      email3Address - the new email3 address

    • getEmail1DisplayName

      public String getEmail1DisplayName()
      Gets the display name of the first e-mail address for the contact.
      Returns:
      the email1 display name

    • setEmail1DisplayName

      public void setEmail1DisplayName​(String email1DisplayName)
      Sets the display name of the first e-mail address for the contact.
      Parameters:
      email1DisplayName - the new email1 display name

    • getEmail2DisplayName

      public String getEmail2DisplayName()
      Gets the display name of the second e-mail address for the contact.
      Returns:
      the email2 display name

    • setEmail2DisplayName

      public void setEmail2DisplayName​(String email2DisplayName)
      Sets the display name of the second e-mail address for the contact.
      Parameters:
      email2DisplayName - the new email2 display name

    • getEmail3DisplayName

      public String getEmail3DisplayName()
      Gets the display name of the third e-mail address for the contact.
      Returns:
      the email3 display name

    • setEmail3DisplayName

      public void setEmail3DisplayName​(String email3DisplayName)
      Sets the display name of the third e-mail address for the contact.
      Parameters:
      email3DisplayName - the new email3 display name

    • getEmail1DisplayAs

      public String getEmail1DisplayAs()
      Gets the display as name of the first e-mail address for the contact.
      Returns:
      the email1 display as

    • setEmail1DisplayAs

      public void setEmail1DisplayAs​(String email1DisplayAs)
      Sets the display as name of the first e-mail address for the contact.
      Parameters:
      email1DisplayAs - the new email1 display as

    • getEmail2DisplayAs

      public String getEmail2DisplayAs()
      Gets the display as name of the second e-mail address for the contact.
      Returns:
      the email2 display as

    • setEmail2DisplayAs

      public void setEmail2DisplayAs​(String email2DisplayAs)
      Sets the display as name of the second e-mail address for the contact.
      Parameters:
      email2DisplayAs - the new email2 display as

    • getEmail3DisplayAs

      public String getEmail3DisplayAs()
      Gets the display as name of the third e-mail address for the contact.
      Returns:
      the email3 display as

    • setEmail3DisplayAs

      public void setEmail3DisplayAs​(String email3DisplayAs)
      Sets the display as name of the third e-mail address for the contact.
      Parameters:
      email3DisplayAs - the new email3 display as

    • getEmail1Type

      public String getEmail1Type()
      Gets the type of the first e-mail address for the contact.
      Returns:
      the email1 type

    • setEmail1Type

      public void setEmail1Type​(String email1Type)
      Sets the type of the first e-mail address for the contact.
      Parameters:
      email1Type - the new email1 type

    • getEmail2Type

      public String getEmail2Type()
      Gets the type of the second e-mail address for the contact.
      Returns:
      the email2 type

    • setEmail2Type

      public void setEmail2Type​(String email2Type)
      Sets the type of the second e-mail address for the contact.
      Parameters:
      email2Type - the new email2 type

    • getEmail3Type

      public String getEmail3Type()
      Gets the type of the third e-mail address for the contact.
      Returns:
      the email3 type

    • setEmail3Type

      public void setEmail3Type​(String email3Type)
      Sets the type of the third e-mail address for the contact.
      Parameters:
      email3Type - the new email3 type

    • getEmail1EntryId

      public byte[] getEmail1EntryId()
      Gets the entry ID of the first e-mail address for the contact.
      Returns:
      the email1 entry id

    • setEmail1EntryId

      public void setEmail1EntryId​(byte[] email1EntryId)
      Sets the entry ID of the first e-mail address for the contact.
      Parameters:
      email1EntryId - the new email1 entry id

    • getEmail2EntryId

      public byte[] getEmail2EntryId()
      Gets the entry ID of the second e-mail address for the contact.
      Returns:
      the email2 entry id

    • setEmail2EntryId

      public void setEmail2EntryId​(byte[] email2EntryId)
      Sets the entry ID of the second e-mail address for the contact.
      Parameters:
      email2EntryId - the new email2 entry id

    • getEmail3EntryId

      public byte[] getEmail3EntryId()
      Gets the entry ID of the third e-mail address for the contact.
      Returns:
      the email3 entry id

    • setEmail3EntryId

      public void setEmail3EntryId​(byte[] email3EntryId)
      Sets the entry ID of the third e-mail address for the contact.
      Parameters:
      email3EntryId - the new email3 entry id

    • getRecipients

      public List<Recipient> getRecipients()
      Gets collection of recipients.
      Returns:
      the recipients

    • getAttachments

      public List<Attachment> getAttachments()
      Gets collection of attachments.
      Returns:
      the attachments

    • getExtendedProperties

      public List<ExtendedProperty> getExtendedProperties()
      Gets collection of extended (custom) properties.
      Returns:
      the extended properties

    • isEmbedded

      public boolean isEmbedded()
      Gets true if Message is embedded into another message object, otherwise false.
      Returns:
      true, if is embedded

    • setEmbedded

      public void setEmbedded​(boolean isEmbedded)
      Sets true if Message is embedded into another message object.
      Parameters:
      isEmbedded - the new embedded