OutlookMessage (Outlook Message Parser 1.9.6 API)

java.lang.Object
- org.simplejavamail.outlookmessageparser.model.OutlookMessage

```
public class OutlookMessage
extends Object
```
Class that represents a .msg file. Some fields from the .msg file are stored in special parameters (e.g., fromEmail). Attachments are stored in the property outlookAttachments). An attachment may be of the type OutlookMsgAttachment which represents another attached (encapsulated) .msg object.

Constructor Summary

Constructors
Constructor and Description

OutlookMessage()

Constructors
Constructor and Description
`OutlookMessage()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAttachment(OutlookAttachment outlookAttachment)`
`void`	`addRecipient(OutlookRecipient recipient)`
`Map<String,OutlookFileAttachment>`	`fetchCIDMap()`
`List<OutlookFileAttachment>`	`fetchTrueAttachments()`
`List<OutlookRecipient>`	`getBccRecipients()` Retrieves a list of `OutlookRecipient` objects that represent the BCC recipients of the message.
`String`	`getBodyHTML()` Bean getter for `bodyHTML`.
`String`	`getBodyRTF()` Bean getter for `bodyRTF`.
`String`	`getBodyText()` Bean getter for `bodyText`.
`List<OutlookRecipient>`	`getCcRecipients()` Retrieves a list of `OutlookRecipient` objects that represent the CC recipients of the message.
`@Nullable Date`	`getClientSubmitTime()`
`String`	`getConvertedBodyHTML()` Bean getter for `convertedBodyHTML`.
`Date`	`getCreationDate()` Bean getter for `creationDate`.
`Date`	`getDate()` Bean getter for `date`.
`String`	`getDisplayBcc()` Bean getter for `displayBcc`.
`String`	`getDisplayCc()` Bean getter for `displayCc`.
`String`	`getDisplayTo()` Bean getter for `displayTo`.
`String`	`getFromEmail()` Bean getter for `fromEmail`.
`String`	`getFromName()` Bean getter for `fromName`.
`String`	`getHeaders()` Bean getter for `headers`.
`Map<String,Collection<String>>`	`getHeadersMap()` Bean getter for `headersMap`.
`Date`	`getLastModificationDate()` Bean getter for `lastModificationDate`.
`String`	`getMessageClass()` Bean getter for `messageClass`.
`String`	`getMessageId()` Bean getter for `messageId`.
`List<OutlookAttachment>`	`getOutlookAttachments()` Bean getter for `outlookAttachments`.
`Set<String>`	`getPropertiesAsHex()` This method provides a convenient way of retrieving property keys for all guys that like to stick to hex values.
`Set<Integer>`	`getPropertyCodes()` This method returns a list of all available properties.
`String`	`getPropertyListing()` Generates a string that can be used to debug the properties of the msg.
`Object`	`getPropertyValue(Integer code)` This method retrieves the value for a specific property.
`List<OutlookRecipient>`	`getRecipients()` Bean getter for `recipients`.
`String`	`getReplyToEmail()` Bean getter for `replyToEmail`.
`String`	`getReplyToName()` Bean getter for `replyToName`.
`OutlookSmime`	`getSmime()` Bean getter for `smime`.
`String`	`getSubject()` Bean getter for `subject`.
`List<OutlookRecipient>`	`getToRecipients()` Retrieves a list of `OutlookRecipient` objects that represent the CC recipients of the message.
`void`	`setProperty(OutlookMessageProperty msgProp, org.bbottema.rtftohtml.RTF2HTMLConverter rtf2HTMLConverter)` Sets the name/value pair in the `properties` map.
`void`	`setReplyToEmail(String replyToEmail)` Bean setter for `replyToEmail`.
`void`	`setReplyToName(String replyToName)` Bean setter for `replyToName`.
`void`	`setSmime(OutlookSmime smime)` Bean setter for `smime`.
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - OutlookMessage
```
public OutlookMessage()
```
- Method Detail
  - addAttachment
```
public void addAttachment(OutlookAttachment outlookAttachment)
```
  - addRecipient
```
public void addRecipient(OutlookRecipient recipient)
```
  - setProperty
```
public void setProperty(OutlookMessageProperty msgProp,
                        org.bbottema.rtftohtml.RTF2HTMLConverter rtf2HTMLConverter)
```
    Sets the name/value pair in the properties map. Some properties are put into special attributes (e.g., setSubject(String) when the property name is '0x37').
  - fetchCIDMap
```
public Map<String,OutlookFileAttachment> fetchCIDMap()
```
    Returns:
    
    Only the attachments that are embedded by cid reference.
  - fetchTrueAttachments
```
public List<OutlookFileAttachment> fetchTrueAttachments()
```
    Returns:
    
    Only the downloadable attachments, *not* embedded attachments (as in embedded with cid:attachment, such as images in an email). This includes downloadable nested outlook messages as file attachments!
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getOutlookAttachments
```
public List<OutlookAttachment> getOutlookAttachments()
```
    Bean getter for outlookAttachments.
  - getRecipients
```
public List<OutlookRecipient> getRecipients()
```
    Bean getter for recipients.
  - getFromEmail
```
public String getFromEmail()
```
    Bean getter for fromEmail.
  - getFromName
```
public String getFromName()
```
    Bean getter for fromName.
  - getDisplayTo
```
public String getDisplayTo()
```
    Bean getter for displayTo.
  - getDisplayCc
```
public String getDisplayCc()
```
    Bean getter for displayCc.
  - getDisplayBcc
```
public String getDisplayBcc()
```
    Bean getter for displayBcc.
  - getMessageClass
```
public String getMessageClass()
```
    Bean getter for messageClass.
  - getMessageId
```
public String getMessageId()
```
    Bean getter for messageId.
  - getSubject
```
public String getSubject()
```
    Bean getter for subject.
  - getToRecipients
```
public List<OutlookRecipient> getToRecipients()
```
    Retrieves a list of OutlookRecipient objects that represent the CC recipients of the message.
    
    Returns:
    
    the TO recipients of the message.
  - getCcRecipients
```
public List<OutlookRecipient> getCcRecipients()
```
    Retrieves a list of OutlookRecipient objects that represent the CC recipients of the message.
    
    Returns:
    
    the CC recipients of the message.
  - getBccRecipients
```
public List<OutlookRecipient> getBccRecipients()
```
    Retrieves a list of OutlookRecipient objects that represent the BCC recipients of the message.
    
    Returns:
    
    the BCC recipients of the message.
  - getBodyText
```
public String getBodyText()
```
    Bean getter for bodyText.
  - getBodyRTF
```
public String getBodyRTF()
```
    Bean getter for bodyRTF.
  - getBodyHTML
```
public String getBodyHTML()
```
    Bean getter for bodyHTML.
  - getConvertedBodyHTML
```
public String getConvertedBodyHTML()
```
    Bean getter for convertedBodyHTML.
  - getHeaders
```
public String getHeaders()
```
    Bean getter for headers.
  - getHeadersMap
```
public Map<String,Collection<String>> getHeadersMap()
```
    Bean getter for headersMap.
  - getDate
```
public Date getDate()
```
    Bean getter for date.
  - getClientSubmitTime
```
@Nullable
public @Nullable Date getClientSubmitTime()
```
    Returns:
    
    clientSubmitTime or null in case this message has not been sent yet.
  - getCreationDate
```
public Date getCreationDate()
```
    Bean getter for creationDate.
  - getLastModificationDate
```
public Date getLastModificationDate()
```
    Bean getter for lastModificationDate.
  - getPropertiesAsHex
```
public Set<String> getPropertiesAsHex()
```
    This method provides a convenient way of retrieving property keys for all guys that like to stick to hex values.
    Note that this method includes parsing of string values to integers which will be less efficient than using getPropertyCodes().
    
    Returns:
    
    All available keys properties have been found for.
  - getPropertyCodes
```
public Set<Integer> getPropertyCodes()
```
    This method returns a list of all available properties.
    
    Returns:
    
    All available keys properties have been found for.
  - getPropertyValue
```
public Object getPropertyValue(Integer code)
```
    This method retrieves the value for a specific property.
    NOTE: You can also use fields defined within MAPIProperty to easily read certain properties.
    
    Parameters:
    
    code - The key for the property to be retrieved.
    
    Returns:
    
    The value of the specified property.
  - getPropertyListing
```
public String getPropertyListing()
```
    Generates a string that can be used to debug the properties of the msg.
    
    Returns:
    
    A property listing holding hexadecimal, decimal and string representations of properties and their values.
  - getReplyToEmail
```
public String getReplyToEmail()
```
    Bean getter for replyToEmail.
  - setReplyToEmail
```
public void setReplyToEmail(String replyToEmail)
```
    Bean setter for replyToEmail.
  - getReplyToName
```
public String getReplyToName()
```
    Bean getter for replyToName.
  - setReplyToName
```
public void setReplyToName(String replyToName)
```
    Bean setter for replyToName.
  - setSmime
```
public void setSmime(OutlookSmime smime)
```
    Bean setter for smime.
  - getSmime
```
public OutlookSmime getSmime()
```
    Bean getter for smime.

Class OutlookMessage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OutlookMessage

Method Detail

addAttachment

addRecipient

setProperty

fetchCIDMap

fetchTrueAttachments

toString

getOutlookAttachments

getRecipients

getFromEmail

getFromName

getDisplayTo

getDisplayCc

getDisplayBcc

getMessageClass

getMessageId

getSubject

getToRecipients

getCcRecipients

getBccRecipients

getBodyText

getBodyRTF

getBodyHTML

getConvertedBodyHTML

getHeaders

getHeadersMap

getDate

getClientSubmitTime

getCreationDate

getLastModificationDate

getPropertiesAsHex

getPropertyCodes

getPropertyValue

getPropertyListing

getReplyToEmail

setReplyToEmail

getReplyToName

setReplyToName

setSmime

getSmime