Package org.apache.poi.hmef
Class HMEFMessage
- java.lang.Object
-
- org.apache.poi.hmef.HMEFMessage
-
public final class HMEFMessage extends Object
HMEF - Implementation of the Microsoft TNEF message encoding format (aka winmail.dat) See: http://support.microsoft.com/kb/241538 http://en.wikipedia.org/wiki/Transport_Neutral_Encapsulation_Format http://search.cpan.org/dist/Convert-TNEF/
-
-
Field Summary
Fields Modifier and Type Field Description static int
HEADER_SIGNATURE
-
Constructor Summary
Constructors Constructor Description HMEFMessage(InputStream inp)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<Attachment>
getAttachments()
Returns all the Attachments of the message.String
getBody()
Returns the Message Body, as RTF, or null if the mapi property for this isn't setTNEFAttribute
getMessageAttribute(TNEFProperty id)
Return the message attribute with the given ID, or null if there isn't one.List<TNEFAttribute>
getMessageAttributes()
Returns all HMEF/TNEF attributes of the message.MAPIAttribute
getMessageMAPIAttribute(MAPIProperty id)
Return the message MAPI Attribute with the given ID, or null if there isn't one.List<MAPIAttribute>
getMessageMAPIAttributes()
Returns all MAPI attributes of the message.String
getSubject()
Returns the Message Subject, or null if the mapi property for this isn't set
-
-
-
Field Detail
-
HEADER_SIGNATURE
public static final int HEADER_SIGNATURE
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
HMEFMessage
public HMEFMessage(InputStream inp) throws IOException
- Throws:
IOException
-
-
Method Detail
-
getMessageAttributes
public List<TNEFAttribute> getMessageAttributes()
Returns all HMEF/TNEF attributes of the message. Note - In a typical message, most of the interesting properties are stored asMAPIAttribute
s - seegetMessageMAPIAttributes()
-
getMessageMAPIAttributes
public List<MAPIAttribute> getMessageMAPIAttributes()
Returns all MAPI attributes of the message. Note - A small number of HMEF/TNEF specific attributes normally apply to most messages, seegetMessageAttributes()
-
getAttachments
public List<Attachment> getAttachments()
Returns all the Attachments of the message.
-
getMessageAttribute
public TNEFAttribute getMessageAttribute(TNEFProperty id)
Return the message attribute with the given ID, or null if there isn't one.
-
getMessageMAPIAttribute
public MAPIAttribute getMessageMAPIAttribute(MAPIProperty id)
Return the message MAPI Attribute with the given ID, or null if there isn't one.
-
getSubject
public String getSubject()
Returns the Message Subject, or null if the mapi property for this isn't set
-
getBody
public String getBody()
Returns the Message Body, as RTF, or null if the mapi property for this isn't set
-
-