Extract objects from MS Outlook/Exchange PST files
Extract objects from MS Outlook/Exchange PST files.
This is based off the code from https://github.com/rjohnsondev/java-libpst. Thanks to Richard Johnson and Orin Eman.
A spec from Microsoft on the PST file format is at https://msdn.microsoft.com/en-us/library/ff385210(v=office.12).aspx.
npm install --save pst-extractor
Start with test.ts for sample code to walk the PST and print out the folder structure to the console. Also, most of the major objects have Mocha test specs which show how the object attributes can be accessed.
A simple test-min.ts script like this.
import { PSTMessage } from 'pst-extractor';
import { PSTFile } from 'pst-extractor';
import { PSTFolder } from 'pst-extractor';
const resolve = require('path').resolve;
let depth = -1;
let col = 0;
const pstFile = new PSTFile(resolve('/path/to/some/pst.pst'));
console.log(pstFile.getMessageStore().displayName);
processFolder(pstFile.getRootFolder());
/**
* Walk the folder tree recursively and process emails.
* @param {PSTFolder} folder
*/
function processFolder(folder: PSTFolder) {
depth++;
// the root folder doesn't have a display name
if (depth > 0) {
console.log(getDepth(depth) + folder.displayName);
}
// go through the folders...
if (folder.hasSubfolders) {
let childFolders: PSTFolder[] = folder.getSubFolders();
for (let childFolder of childFolders) {
processFolder(childFolder);
}
}
// and now the emails for this folder
if (folder.contentCount > 0) {
depth++;
let email: PSTMessage = folder.getNextChild();
while (email != null) {
console.log(getDepth(depth) +
'Sender: ' + email.senderName +
', Subject: ' + email.subject);
email = folder.getNextChild();
}
depth--;
}
depth--;
}
/**
* Returns a string with visual indication of depth in tree.
* @param {number} depth
* @returns {string}
*/
function getDepth(depth: number): string {
let sdepth = '';
if (col > 0) {
col = 0;
sdepth += '\n';
}
for (let x = 0; x < depth - 1; x++) {
sdepth += ' | ';
}
sdepth += ' |- ';
return sdepth;
}
will generate the following output:
Personal folders
|- Top of Personal Folders
| |- Deleted Items
| |- lokay-m
| | |- MLOKAY (Non-Privileged)
| | | |- TW-Commercial Group
| | | | |- Sender: Lee Dennis, Subject: New OBA's
| | | | |- Sender: Reames Julie, Subject: I/B Link Capacity for November and December 2001
| | | | |- Sender: [email protected], Subject: West Texas Capacity
| | | | |- Sender: Buehler Craig, Subject: EOL Confirmation -Transwestern Pipeline Company
| | | | |- Sender: Buehler Craig, Subject: EOL Confirmation -Transwestern Pipeline Company
| | | | |- Sender: Brostad Karen, Subject: New PNR points for Transwestern
| | | | |- Sender: Frazier Perry, Subject: RR expansion contracts.
| | | | |- Sender: Buehler Craig, Subject: TW EOLs
| | | | |- Sender: Lokay, Subject: Bullets 10/26/01
| | | | |- Sender: Frazier Perry, Subject: Verify RR expansion cr's for ROFR.
| | | | |- Sender: Frazier Perry, Subject: Red Rock Adm. cr # 27698 revisions.
| | | | |- Sender: Moore, Subject: TW Weekly Report for October 26, 2001
| | | | |- Sender: Cabrera Reyna, Subject: FW: New PNR points for Transwestern
| | | | |- Sender: Lee Dennis, Subject: TW administrative contract # 27698
| | | |- Systems
| | | | |- Sender: ETS General Announcement/ET&S/Enron@ENRON, Subject: How to prepare your expense report
| | | | |- Sender: Carl Carter, Subject: eRequest
| | | | |- Sender: Puthigai Savita, Subject: EnronOnline -Stack Manager Changes
| | | | |- Sender: Enron Announcements/Corp/Enron@ENRON, Subject: LIM Software Upgrade Notice
| | | | |- Sender: Lee Dennis, Subject: Sending customer information from ENVISION
| | | | |- Sender: Enron Global Technology@ENRON, Subject: Email Retention Policy
| | | | |- Sender: Enron Messaging Administration, Subject: Supported Internet Email Addresses
| | | |- Sent Items
| | | | |- Sender: Lokay, Subject: Cirque du Soleil - Dralion
| | | | |- Sender: Lokay, Subject: Accepted: Updated: Finalize Transwestern Presentations
| | | |- Personal
| | | | |- Sender: Jim Lokay [email protected]@ENRON, Subject: Fwd: Enjoy fall in an Alamo midsize car -- just $169 a week!
| | | | |- Sender: cbulf, Subject: TRIP INFO
| | | | |- Sender: Michelle Lokay, Subject: Check out page 7!
| | | | |- Sender: ClickAtHome, Subject: ClickAtHome is Coming Soon!
| | | | |- Sender: Lisa Norwood, Subject: contact
| | | | |- Sender: Jim Lokay [email protected]@ENRON, Subject: [Fwd: New email address - again!]
| | | | |- Sender: Jim Lokay [email protected]@ENRON, Subject: file
| | | | |- Sender: Enron Announcements/Corp/Enron@ENRON, Subject: An Opportunity to Change Your Electricity Provider
| | | | |- Sender: James Lokay [email protected]@ENRON, Subject: Fwd: RE: Party Request-the Galleria - Sat 8/11/2001 4:00 PM
| | | | |- Sender: Jim Lokay [email protected]@ENRON, Subject: links
| | | | |- Sender: Clickathome,, Subject: Re: Time Warner Cable question
| | | | |- Sender: Ramirez Pilar, Subject: RE: Good Web
| | | | |- Sender: Schoolcraft Darrell, Subject: Wedding
| | | | |- Sender: [email protected]@ENRON, Subject: Dilbert Strip from Jim is waiting for you!
| | | | |- Sender: Lokay, Subject: eBay item 576466888 (Ends Apr-10-01 104814 PDT) - !!!!Green Is In!!!!! Erin Bud
| | | | |- Sender: Lokay, Subject: eBay item 576853567 (Ends Apr-09-01 134449 PDT) - TY Beanie Buddies ERIN Buddy!
| | | | |- Sender: Lokay, Subject: eBay item 577532611 (Ends Apr-09-01 175133 PDT) - VALENTINA BUDDY beanie buddie
| | | | |- Sender: Lokay, Subject: eBay item 577242315 (Ends Apr-12-01 175442 PDT) - Ty Beanie Buddy & Baby - Vale
| | | | |- Sender: Jim Lokay [email protected]@ENRON, Subject: scans
| | | | |- Sender: Jim Lokay [email protected]@ENRON, Subject: Re: VALENTINA BUDDY beanie buddies RETIRED Item #577532611
| | | | |- Sender: Lokay, Subject: Job Opportunity?
| | | | |- Sender: Jim Lokay [email protected]@ENRON, Subject: Quickie
| | | | |- Sender: Jim Lokay [email protected]@ENRON, Subject: In case you needed to know...
| | | | |- Sender: Jim Lokay [email protected]@ENRON, Subject: graphic
| | | | |- Sender: Hitschel Bonnie V. [email protected]@ENRON, Subject: RE:FIESTA
| | | | |- Sender: Jim Lokay [email protected]@ENRON, Subject: Houston
| | | | |- Sender: Fawcett Jeffery, Subject: California Sing-along
| | | | |- Sender: Loe David [email protected]@ENRON, Subject: FW: ONEOK ski trip
| | | | |- Sender: Loe David [email protected]@ENRON, Subject: FW: ONEOK ski trip
| | | | |- Sender: Jim Lokay [email protected]@ENRON, Subject: unit for sale
| | | | |- Sender: Hitschel Bonnie V. [email protected]@ENRON, Subject: FW: Even For You
| | | | |- Sender: Jennifer Smith @ENRON, Subject: Learn Technical Analysis, Early Bird Special for Houston Class
| | | | |- Sender: Watson Kimberly, Subject: Lindy's B-day
| | | | |- Sender: Ramirez Pilar, Subject: FW: Breast Cancer
| | | | |- Sender: Jim Lokay [email protected]@ENRON, Subject: unverified news report
| | | | |- Sender: Lokay, Subject: Accomplishments for Year 2001, as of 05/10
| | | | |- Sender: Lokay, Subject: Rose Rec
| | | | |- Sender: Hitschel Bonnie V. [email protected]@ENRON, Subject: Voluntary Spyware
| | | | |- Sender: Yee Danny [email protected]@ENRON, Subject: Possible Spreadsheet
| | | | |- Sender: [email protected]@ENRON, Subject: <<Concur Expense Document>> - Expense060501
| | | | |- Sender: Hitschel Bonnie V. [email protected]@ENRON, Subject: Just for fun
| | | | |- Sender: Stevens Missy, Subject: RE: Enron Efforts to the Flood victims
| | | | |- Sender: Stuart Charla, Subject: RE: OPEN ENROLLMENT FOR ENRON KIDS' CENTER IS UNDERWAY!!!
| | | | |- Sender: Goradia, Subject:
| | | | |- Sender: [email protected]@ENRON, Subject: Invitation to Golf Outing
| | | | |- Sender: Horton Stanley, Subject: GOOD JOB!
| | | | |- Sender: [email protected]@ENRON, Subject: PPL EnergyPlus Golf Outing
| | | |- Sender: Mailbox - Ftenergy1, Subject: Power Mart '01 - Register online for your FREE exhibition pass!
|- Search Root
|- SPAM Search Folder 2
Note that this is a subset, and all properties are outlined in the respective object .ts file.
| Property | Type | Description | Detailed Doco |
|---|---|---|---|
| body | string | Plain text message body. | https://msdn.microsoft.com/en-us/library/office/cc765874.aspx |
| clientSubmitTime | date | Contains the date and time the message sender submitted a message. | https://technet.microsoft.com/en-us/library/cc839781 |
| displayBCC | string | Contains an ASCII list of the display names of any blind carbon copy (BCC) message recipients, separated by semicolons (;). | https://msdn.microsoft.com/en-us/library/office/cc815730.aspx |
| displayCC | string | Contains an ASCII list of the display names of any carbon copy (CC) message recipients, separated by semicolons (;). | https://msdn.microsoft.com/en-us/library/office/cc765528.aspx |
| displayTo | string | Contains a list of the display names of the primary (To) message recipients, separated by semicolons (;). | https://msdn.microsoft.com/en-us/library/office/cc839687.aspx |
| getAttachment | PSTAttachment | Get specific attachment from table using index. | |
| hasAttachments | boolean | The message has at least one attachment. | https://msdn.microsoft.com/en-us/library/ee160304(v=exchg.80).aspx |
| isRead | boolean | The message is marked as having been read. | https://msdn.microsoft.com/en-us/library/ee160304(v=exchg.80).aspx |
| messageClass | string | Contains a text string that identifies the sender-defined message class, such as IPM.Note. | https://msdn.microsoft.com/en-us/library/office/cc765765.aspx |
| receivedByName | string | Contains the display name of the messaging user who receives the message. | https://msdn.microsoft.com/en-us/library/office/cc840015.aspx |
| senderEmailAddress | string | Contains the message sender's e-mail address. | https://msdn.microsoft.com/en-us/library/office/cc839670.aspx |
| senderName | string | Contains the message sender's display name. | https://msdn.microsoft.com/en-us/library/office/cc815457.aspx |
| subject | string | Contains the full subject of a message. | https://technet.microsoft.com/en-us/library/cc815720 |
- npm run build :
tsc - npm run test :
nyc --reporter=html mocha --opts mocha.opts - npm run readme :
node ./node_modules/.bin/node-readme
| Package | Version | Dev |
|---|---|---|
| long | ^4.0.0 | ✖ |
| uuid-parse | ^1.0.0 | ✖ |
| winston | ^2.4.1 | ✖ |
| @types/chai | ^4.1.2 | ✔ |
| @types/debug | 0.0.30 | ✔ |
| @types/long | ^4.0.0 | ✔ |
| @types/mocha | ^5.0.0 | ✔ |
| @types/node | ^10.1.2 | ✔ |
| @types/winston | ^2.3.9 | ✔ |
| chai | ^4.1.2 | ✔ |
| chai-datetime | ^1.5.0 | ✔ |
| debug | ^3.1.0 | ✔ |
| mocha | ^5.0.5 | ✔ |
| node-readme | ^0.1.9 | ✔ |
| nyc | ^11.6.0 | ✔ |
| rimraf | ^2.6.2 | ✔ |
| source-map-support | ^0.5.4 | ✔ |
| supports-color | ^5.3.0 | ✔ |
| ts-node | ^6.0.3 | ✔ |
| typescript | ^2.8.1 | ✔ |
Contributions welcome; Please submit all pull requests the against master branch. If your pull request contains JavaScript patches or features, you should include relevant unit tests. Please check the Contributing Guidelines for more details. Thanks!
Ed Pfromer ([email protected])
- (Apache-2.0 OR GPL-3.0) : null