Package io.github.jmcleodfoss.pst

This package contains classes for reading Microsoft PST files. The file format is documented in [MS:PST] Outlook Personal Folders (.pst) File Format (MSDN)
  • Interface Summary 
    Interface Description
    BTreeLeaf
    The BTreeLeaf class is a marker for all B-tree leaf objects.
    BTreeNode
    The BTreeNode interface defines the functions required for intermediate and leaf B-tree nodes.
    NodeMap
    The NodeMap interface describes classes which allow a node to be found in the node B-tree.
    TreeCustomNodeText
    The TreeCustomNodeText interface provides a library-specific mechanism for obtaining tree node text.
  • Class Summary 
    Class Description
    Appointment
    The Appointment class holds information about a calendar entry.
    Attachment
    The Attachment class represents an attachment object within a PST message object.
    BTreeOnHeap
    The BTreeOnHeap class represents a B-tree contained on a heap defined by a node in the node B-tree.
    ByteUtil
    The ByteUtil class contains utility functions for dealing with bytes.
    Contact
    The Contact class represents a PST contact message object.
    DistributionList
    The DistributionList class represents a PST contact distribution list message object.
    DistributionList.Entry
    The Entry class flags an object as being a distribution list entry.
    EmptyIterator
    The EmptyIterator class is an iterator for empty lists.
    EntryID
    The EntryID class contains a PST file Entry ID (ENTRYID structure).
    Folder
    The Folder class represents a folder within a PST file.
    Header
    The Header object is the PST header.
    HeapOnNode
    The HeapOnNode class represents a heap stored on a node in the node B-Tree.
    IPF
    The IPF holds the list of IPF folder types.
    JournalEntry
    The JournalEntry class represents a PST sticky note message object.
    LPTLeaf
    The LPTLeaf class is the base class for node and sub-node B-Tree leaf entries, both of which may be used to create table contexts.
    Message
    The Message class represents a PST email message.
    MessageObject
    The MessageObject class is the base class for all content objects (appointments, contacts, journal entries, messages, etc.)
    MessageObjectWithBody
    The MessageObjectWithBody class represents message objects which are expected to have a Body (and possibly a BodyHTML) tag.
    MessageStore
    The MessageStore class is a (thin) wrapper around the message store PC, with a few convenience functions.
    NameToIDMap
    The NameIDToMap class wraps the PropertyContext node NID_NAME_ID_TO_MAP (0x61) to provide names for the properties therein.
    NBTEntry
    The NBTEntry class represents a node B-tree leaf entry.
    NID
    The NID class represents a PST file node ID.
    NodeSubnodeBTree
    The NodeSubnodeBtree provides a B-Tree containing all nodes and subnodes.
    OutputSeparator
    The OutputSeparator class provides the frill of printing a separator line out for the second and subsequent calls to the emit function.
    PagedBTree
    The PagedBTree class is the base class for B-trees stored on pages within the PST file (i.e.
    PagedBTree.PageContext<I extends io.github.jmcleodfoss.pst.BTree,​L extends BTreeLeaf>
    The PageContext class contains information required to keep track of the current position in the B-tree during input.
    PropertyContext
    The PropertyContext class contains a PST file property context.
    PropertyID Deprecated.
    PropertyLIDs
    Known Property Long IDs
    PropertyTag Deprecated.
    PropertyTagName Deprecated.
    PropertyTags
    Known Property tags
    PST
    The PST class is a convenience collection of entities describing a PST file.
    PSTFile
    The PSTFile class is a convenience container class used to read later data from the file.
    ReadOnlyTableModel
    The ReadOnlyTableModel is a version of DefaultTableModel which does not permit cells to be edited.
    ReadOnlyTreeModel
    The ReadOnlyTreeModel abstract class implements trivial versions of functions irrelevant for read-only trees.
    StickyNote
    The StickyNote class represents a PST sticky note message object.
    SubnodeBTree
    The SubnodeBTree class represents the B-tree for the sub-nodes of a node B-tree leaf node.
    TableContext
    The TableContext class represents a PST Table Context, which is a structure on a B-tree-on-heap.
    Task
    The Task class holds information about a task entry.
  • Enum Summary 
    Enum Description
    Unimplemented.Priority
    The Priority enum indicates the priority with with the method or variable should be implemented.
  • Exception Summary 
    Exception Description
    NotHeapNodeException
    The NotHeapNodeException is thrown when a node does not contain a valid heap-on-node.
    NotPropertyContextNodeException
    The NotPropertyContextNodeException is thrown when a node expected to have a Property Context client signature does not
    NotPSTFileException
    The NotPSTFileException is thrown when the first four bytes of the file are not the PST flag bytes.
    NotTableContextNodeException
    The NotTableContextNodeException is thrown when a node expected to have a Table Context client signature does not
    NullDataBlockException
    The NullDataBlockException is thrown when a data block is found to be null unexpectedly.
    UnknownClientSignatureException
    The UnknownClientSignatureException exception indicates an unknown client signature was encountered,
    UnparseablePropertyContextException
    The UnparseablePropertyContextException is thrown when the property context cannot be parsed (probably because of an I/O error).
    UnparseableTableContextException
    The UnparseableTableContextException is thrown when the table context cannot be parsed (probably because of an I/O error).
  • Annotation Types Summary 
    Annotation Type Description
    Unimplemented
    The Unimplemented annotation flags methods which have not yet been implemented, and member variables which are not yet used.