Interface IPSTMessageStore

interface IPSTMessageStore {
    get displayName(): string;
    get primaryNodeId(): number;
    getAllProperties(): Property[];
    getProperty(key: number): Property | undefined;
    requestAccessToUserNode(): Promise<PUNode | undefined>;
    toJSON(): any;
}

Hierarchy (View Summary)

IPSTObject
- IPSTMessageStore

Implemented by

PSTMessageStore

Index

Accessors

displayName primaryNodeId

Methods

getAllProperties getProperty requestAccessToUserNode toJSON

Accessors

displayName

get displayName(): string
Get the display name of this object. https://msdn.microsoft.com/en-us/library/office/cc842383.aspx

Returns string
Inherited from IPSTObject.displayName
- Defined in IPSTObject.ts:9

primaryNodeId

get primaryNodeId(): number
Get the primary node ID.

Returns number
Inherited from IPSTObject.primaryNodeId
- Defined in IPSTObject.ts:29

Methods

getAllProperties

getAllProperties(): Property[]
Get all properties.

Returns Property[]
All properties.
Inherited from IPSTObject.getAllProperties
- Defined in IPSTObject.ts:24

getProperty

getProperty(key: number): Property | undefined
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.
Inherited from IPSTObject.getProperty
- Defined in IPSTObject.ts:17

requestAccessToUserNode

requestAccessToUserNode(): Promise<PUNode | undefined>
Requests access to the user node of the internal PST structure.

Returns Promise<PUNode | undefined>
- Defined in IPSTMessageStore.ts:8

toJSON

toJSON(): any
JSON the object.

Returns any
Inherited from IPSTObject.toJSON
- Defined in IPSTObject.ts:34