Package org.apache.poi.hsmf.datatypes
Class RecipientChunks
- java.lang.Object
-
- org.apache.poi.hsmf.datatypes.RecipientChunks
-
- All Implemented Interfaces:
ChunkGroup,ChunkGroupWithProperties
public final class RecipientChunks extends java.lang.Object implements ChunkGroupWithProperties
Collection of convenience chunks for the Recip(ient) part of an outlook file. If a message has multiple recipients, there will be several of these.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classRecipientChunks.RecipientChunksSorterOrders by the recipient number.
-
Field Summary
Fields Modifier and Type Field Description static MAPIPropertyDELIVERY_TYPEstatic java.lang.StringPREFIXstatic MAPIPropertyRECIPIENT_DISPLAY_NAMEstatic MAPIPropertyRECIPIENT_EMAIL_ADDRESSstatic MAPIPropertyRECIPIENT_NAMEstatic MAPIPropertyRECIPIENT_SEARCHstatic MAPIPropertyRECIPIENT_SMTP_ADDRESS
-
Constructor Summary
Constructors Constructor Description RecipientChunks(java.lang.String name)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidchunksComplete()Called by the parser when all chunks have been found.Chunk[]getAll()Chunk[]getChunks()Returns the chunks that make up the group.StringChunkgetDeliveryTypeChunk()java.util.Map<MAPIProperty,java.util.List<PropertyValue>>getProperties()Returns all the Properties contained in the Chunk, along with their Values.StringChunkgetRecipientDisplayNameChunk()java.lang.StringgetRecipientEmailAddress()Tries to find their email address, in whichever chunk holds it given the delivery type.StringChunkgetRecipientEmailChunk()java.lang.StringgetRecipientName()Tries to find their name, in whichever chunk holds it.StringChunkgetRecipientNameChunk()intgetRecipientNumber()ByteChunkgetRecipientSearchChunk()StringChunkgetRecipientSMTPChunk()voidrecord(Chunk chunk)Called by the parser whenever a chunk is found.
-
-
-
Field Detail
-
PREFIX
public static final java.lang.String PREFIX
- See Also:
- Constant Field Values
-
RECIPIENT_NAME
public static final MAPIProperty RECIPIENT_NAME
-
DELIVERY_TYPE
public static final MAPIProperty DELIVERY_TYPE
-
RECIPIENT_EMAIL_ADDRESS
public static final MAPIProperty RECIPIENT_EMAIL_ADDRESS
-
RECIPIENT_SEARCH
public static final MAPIProperty RECIPIENT_SEARCH
-
RECIPIENT_SMTP_ADDRESS
public static final MAPIProperty RECIPIENT_SMTP_ADDRESS
-
RECIPIENT_DISPLAY_NAME
public static final MAPIProperty RECIPIENT_DISPLAY_NAME
-
-
Method Detail
-
getRecipientNumber
public int getRecipientNumber()
-
getRecipientSearchChunk
public ByteChunk getRecipientSearchChunk()
-
getRecipientNameChunk
public StringChunk getRecipientNameChunk()
-
getRecipientEmailChunk
public StringChunk getRecipientEmailChunk()
-
getRecipientSMTPChunk
public StringChunk getRecipientSMTPChunk()
-
getDeliveryTypeChunk
public StringChunk getDeliveryTypeChunk()
-
getRecipientDisplayNameChunk
public StringChunk getRecipientDisplayNameChunk()
-
getRecipientName
public java.lang.String getRecipientName()
Tries to find their name, in whichever chunk holds it.
-
getRecipientEmailAddress
public java.lang.String getRecipientEmailAddress()
Tries to find their email address, in whichever chunk holds it given the delivery type.
-
getProperties
public java.util.Map<MAPIProperty,java.util.List<PropertyValue>> getProperties()
Description copied from interface:ChunkGroupWithPropertiesReturns all the Properties contained in the Chunk, along with their Values. Normally, each property will have one value, sometimes none, and rarely multiple (normally for Unknown etc). For fixed sized properties, the value can be fetched straight from thePropertyValue. For variable sized properties, you'll need to go via the chunk.- Specified by:
getPropertiesin interfaceChunkGroupWithProperties
-
getAll
public Chunk[] getAll()
-
getChunks
public Chunk[] getChunks()
Description copied from interface:ChunkGroupReturns the chunks that make up the group. Should certainly contain all the interesting Chunks, but needn't always contain all of the Chunks.- Specified by:
getChunksin interfaceChunkGroup
-
record
public void record(Chunk chunk)
Called by the parser whenever a chunk is found.- Specified by:
recordin interfaceChunkGroup
-
chunksComplete
public void chunksComplete()
Description copied from interface:ChunkGroupCalled by the parser when all chunks have been found.- Specified by:
chunksCompletein interfaceChunkGroup
-
-