@hiraokahypertools/pst-extractor 0.2.0-alpha.2 → 0.4.0-alpha.1

package/dist/IPSTFile.d.ts

@@ -0,0 +1,54 @@
+import type { IPSTFolder } from "./IPSTFolder.js";
+import type { IPSTMessageStore } from "./IPSTMessageStore.js";
+import type { PUNode } from "./PUNode.js";
+export interface IPSTFile {
+    /**
+     * Close the file.
+     */
+    close(): Promise<void>;
+    /**
+     * Get name to ID map item.
+     */
+    getNameToIdMapItem(key: number, idx: number): number;
+    /**
+     * Get public string to id map item.
+     */
+    getPublicStringToIdMapItem(key: string): number;
+    /**
+     * Get property name from id.
+     */
+    getPropertyName(propertyId: number, bNamed: boolean): string | undefined;
+    /**
+     * Get name to id map key.
+     */
+    getNameToIdMapKey(propId: number): Long | undefined;
+    /**
+     * Get the message store of the PST file.  Note that this doesn't really
+     * have much information, better to look under the root folder.
+     */
+    getMessageStore(): Promise<IPSTMessageStore>;
+    /**
+     * Get the root folder for the PST file
+     */
+    getRootFolder(): Promise<IPSTFolder>;
+    /**
+     * Get the `Top of Outlook data file` of the PST file
+     */
+    getTopOfOutlookDataFile(): Promise<IPSTFolder>;
+    /**
+     * Requests access to the user node of the internal PST structure.
+     *
+     * - `NID_MESSAGE_STORE` 33
+     * - `NID_NAME_TO_ID_MAP` 97
+     * - `ROOT_FOLDER_DESCRIPTOR_IDENTIFIER` 290 (unsafe)
+     */
+    requestAccessToUserNode(nodeId: number): Promise<PUNode | undefined>;
+    /**
+     * Get the store support mask should be set to `PidTagStoreSupportMask`.
+     */
+    getStoreSupportMask(): number | undefined;
+    /**
+     * JSON stringify the object properties.
+     */
+    toJSON(): any;
+}

package/dist/IPSTFile.js

@@ -0,0 +1 @@
+export {};

package/dist/IPSTFolder.d.ts

@@ -0,0 +1,70 @@
+import type { FasterEmail } from "./FasterEmail.js";
+import type { IPSTMessage } from "./IPSTMessage.js";
+import type { GetFasterEmailListOptions } from "./PSTFolder.class.js";
+import type { PUNode } from "./PUNode.js";
+export interface IPSTFolder {
+    /**
+     * Get folders in one fell swoop, since there's not usually thousands of them.
+     */
+    getSubFolders(): Promise<IPSTFolder[]>;
+    getSubFolder(index: number): Promise<IPSTFolder>;
+    /**
+     * The number of child folders in this folder
+     * @readonly
+     */
+    getSubFolderCount(): Promise<number>;
+    /**
+     * Number of emails in this folder
+     * @readonly
+     */
+    getEmailCount(): Promise<number>;
+    getEmail(index: number): Promise<IPSTMessage>;
+    getEmails(): Promise<IPSTMessage[]>;
+    getFasterEmailList(options?: GetFasterEmailListOptions): Promise<FasterEmail[]>;
+    /**
+     * Contains a constant that indicates the folder type.
+     * https://msdn.microsoft.com/en-us/library/office/cc815373.aspx
+     * @readonly
+     */
+    get folderType(): number;
+    /**
+     * Contains the number of messages in a folder, as computed by the message store.
+     * For a number calculated by the library use getEmailCount
+     * @readonly
+     */
+    get contentCount(): number;
+    /**
+     * Contains the number of unread messages in a folder, as computed by the message store.
+     * https://msdn.microsoft.com/en-us/library/office/cc841964.aspx
+     * @readonly
+     */
+    get unreadCount(): number;
+    /**
+     * Contains TRUE if a folder contains subfolders.
+     * once again, read from the PST, use getSubFolderCount if you want to know
+     * @readonly
+     */
+    get hasSubfolders(): boolean;
+    /**
+     * Contains a text string describing the type of a folder. Although this property is
+     * generally ignored, versions of Microsoft® Exchange Server prior to Exchange Server
+     * 2003 Mailbox Manager expect this property to be present.
+     * https://msdn.microsoft.com/en-us/library/office/cc839839.aspx
+     * @readonly
+     */
+    get containerClass(): string;
+    /**
+     * Contains a bitmask of flags describing capabilities of an address book container.
+     * https://msdn.microsoft.com/en-us/library/office/cc839610.aspx
+     * @readonly
+     */
+    get containerFlags(): number;
+    /**
+     * Requests access to the user node of the internal PST structure.
+     */
+    requestAccessToUserNode(): Promise<PUNode | undefined>;
+    /**
+     * JSON stringify the object properties.
+     */
+    toJSON(): any;
+}

package/dist/IPSTFolder.js

@@ -0,0 +1 @@
+export {};