@hiraokahypertools/pst-extractor - v0.5.0-alpha.2
    Preparing search index...

    Interface IPSTFolder

    interface IPSTFolder {
        get containerClass(): string;
        get containerFlags(): number;
        get contentCount(): number;
        get displayName(): string;
        get folderType(): number;
        get hasSubfolders(): boolean;
        get primaryNodeId(): number;
        get unreadCount(): number;
        getAllProperties(): Property[];
        getEmail(index: number): Promise<IPSTMessage>;
        getEmailCount(): Promise<number>;
        getEmails(): Promise<IPSTMessage[]>;
        getFasterEmailList(
            options?: GetFasterEmailListOptions,
        ): Promise<FasterEmail[]>;
        getProperty(key: number): Property | undefined;
        getSubFolder(index: number): Promise<IPSTFolder>;
        getSubFolderCount(): Promise<number>;
        getSubFolders(): Promise<IPSTFolder[]>;
        requestAccessToUserNode(): Promise<PUNode | undefined>;
        toJSON(): any;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Accessors

    • get contentCount(): number

      Contains the number of messages in a folder, as computed by the message store. For a number calculated by the library use getEmailCount

      Returns number

    • get hasSubfolders(): boolean

      Contains TRUE if a folder contains subfolders. once again, read from the PST, use getSubFolderCount if you want to know

      Returns boolean

    • get primaryNodeId(): number

      Get the primary node ID.

      Returns number

    Methods

    • Readonly

      Number of emails in this folder

      Returns Promise<number>

    • Try to get specified property from PropertyContext.

      Parameters

      • key: number

        0x3001 is PR_DISPLAY_NAME for example

      Returns Property | undefined

      The found one will be returned. Otherwise undefined is returned.

    • Readonly

      The number of child folders in this folder

      Returns Promise<number>

    • Requests access to the user node of the internal PST structure.

      Returns Promise<PUNode | undefined>