Represents a folder in the PST File. Allows you to access child folders or items. Items are accessed through a sort of cursor arrangement. This allows for incremental reading of a folder which may have lots of emails.

Export

Hierarchy

Properties

_node: PLNode
_propertyFinder: PropertyFinder
_rootProvider: RootProvider
_subNode: PLSubNode

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

    Memberof

    PSTFolder

    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

    Memberof

    PSTFolder

    Returns boolean

Methods

  • Protected

    Get a blob.

    Returns

    Memberof

    PSTObject

    Parameters

    • identifier: number

    Returns null | Buffer

  • Protected

    Get a boolean.

    Returns

    Memberof

    PSTObject

    Parameters

    • identifier: number
    • Optional defaultValue: boolean

    Returns boolean

  • Protected

    Get a double.

    Returns

    Memberof

    PSTObject

    Parameters

    • identifier: number
    • Optional defaultValue: number

    Returns number

  • Readonly

    Number of emails in this folder

    Memberof

    PSTFolder

    Returns Promise<number>

  • Protected

    Returns

    Memberof

    PSTObject

    Parameters

    • identifier: number
    • Optional defaultValue: number

    Returns number

  • Protected

    Get a long.

    Returns

    Memberof

    PSTObject

    Parameters

    • identifier: number
    • Optional defaultValue: Long

    Returns Long

  • Get the node type for the descriptor id.

    Returns

    Memberof

    PSTObject

    Parameters

    • Optional descriptorIdentifier: number

    Returns number

  • Try to get specified property from PropertyContext.

    Returns

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

    Parameters

    • key: number

      0x3001 is PR_DISPLAY_NAME for example

    Returns undefined | Property

  • Protected

    Get a string.

    Returns

    Memberof

    PSTObject

    Parameters

    • identifier: number
    • Optional stringType: number
    • Optional codepage: string

    Returns string

  • Readonly

    The number of child folders in this folder

    Memberof

    PSTFolder

    Returns Promise<number>

  • Get folders in one fell swoop, since there's not usually thousands of them.

    Returns

    Memberof

    PSTFolder

    Returns Promise<PSTFolder[]>

Generated using TypeDoc