Class PSTRecipient

Hierarchy (View Summary)

PSTObject
- PSTRecipient

Implements

IPSTRecipient

Properties

`Protected`_node

_node: PLNode

`Protected`_propertyFinder

_propertyFinder: PropertyFinder

`Protected`_rootProvider

_rootProvider: RootProvider

`Protected`_subNode

_subNode: PLSubNode

Accessors

addrType

get addrType(): string
Contains the messaging user's e-mail address type, such as SMTP. https://msdn.microsoft.com/en-us/library/office/cc815548.aspx

Returns string
Implementation of IPSTRecipient.addrType
- Defined in PSTRecipient.class.ts:48

displayName

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

Returns string
Implementation of IPSTRecipient.displayName
Inherited from PSTObject.displayName
- Defined in PSTObject.class.ts:201

emailAddress

get emailAddress(): string
Contains the messaging user's e-mail address. https://msdn.microsoft.com/en-us/library/office/cc842372.aspx

Returns string
Implementation of IPSTRecipient.emailAddress
- Defined in PSTRecipient.class.ts:58

primaryNodeId

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

Returns number
Implementation of IPSTRecipient.primaryNodeId
Inherited from PSTObject.primaryNodeId
- Defined in PSTObject.class.ts:227

recipientFlags

get recipientFlags(): number
Specifies a bit field that describes the recipient status. https://msdn.microsoft.com/en-us/library/office/cc815629.aspx

Returns number
Implementation of IPSTRecipient.recipientFlags
- Defined in PSTRecipient.class.ts:68

recipientOrder

get recipientOrder(): number
Specifies the location of the current recipient in the recipient table. https://msdn.microsoft.com/en-us/library/ee201359(v=exchg.80).aspx

Returns number
Implementation of IPSTRecipient.recipientOrder
- Defined in PSTRecipient.class.ts:78

recipientType

get recipientType(): number
Contains the recipient type for a message recipient. https://msdn.microsoft.com/en-us/library/office/cc839620.aspx
- Consts.MAPI_ORIG (0)
- Consts.MAPI_TO (1)
- Consts.MAPI_CC (2)
- Consts.MAPI_BCC (3)
Returns number
Implementation of IPSTRecipient.recipientType
- Defined in PSTRecipient.class.ts:38

smtpAddress

get smtpAddress(): string
Contains the SMTP address for the address book object. https://msdn.microsoft.com/en-us/library/office/cc842421.aspx

Returns string
Implementation of IPSTRecipient.smtpAddress
- Defined in PSTRecipient.class.ts:88

Methods

getAllProperties

getAllProperties(): Property[]
Get all properties.

Returns Property[]
All properties.
Implementation of IPSTRecipient.getAllProperties
Inherited from PSTObject.getAllProperties
- Defined in PSTObject.class.ts:220

`Protected`getBinaryItem

getBinaryItem(identifier: number): Uint8Array<ArrayBufferLike> | null
Protected
Get a blob.
Parameters
- identifier: number
Returns Uint8Array<ArrayBufferLike> | null
Inherited from PSTObject.getBinaryItem
- Defined in PSTObject.class.ts:184

`Protected`getBooleanItem

getBooleanItem(identifier: number, defaultValue?: boolean): boolean
Protected
Get a boolean.
Parameters
- identifier: number
- OptionaldefaultValue: boolean
Returns boolean
Inherited from PSTObject.getBooleanItem
- Defined in PSTObject.class.ts:79

`Protected`getDateItem

getDateItem(identifier: number): Date | null
Get a date.
Parameters
- identifier: number
Returns Date | null
Inherited from PSTObject.getDateItem
- Defined in PSTObject.class.ts:169

`Protected`getDoubleItem

getDoubleItem(identifier: number, defaultValue?: number): number
Protected
Get a double.
Parameters
- identifier: number
- OptionaldefaultValue: number
Returns number
Inherited from PSTObject.getDoubleItem
- Defined in PSTObject.class.ts:103

`Protected`getIntItem

getIntItem(identifier: number, defaultValue?: number): number
Protected
Parameters
- identifier: number
- OptionaldefaultValue: number
Returns number
Inherited from PSTObject.getIntItem
- Defined in PSTObject.class.ts:58

`Protected`getLongItem

getLongItem(identifier: number, defaultValue?: Long): Long
Protected
Get a long.
Parameters
- identifier: number
- OptionaldefaultValue: Long
Returns Long
Inherited from PSTObject.getLongItem
- Defined in PSTObject.class.ts:124

`Protected`getNodeType

getNodeType(descriptorIdentifier?: number): number
Get the node type for the descriptor id.
Parameters
- OptionaldescriptorIdentifier: number
Returns number
Inherited from PSTObject.getNodeType
- Defined in PSTObject.class.ts:42

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.
Implementation of IPSTRecipient.getProperty
Inherited from PSTObject.getProperty
- Defined in PSTObject.class.ts:211

`Protected`getStringItem

getStringItem(
    identifier: number,
    stringType?: number,
    codepage?: string,
): string
Protected
Get a string.
Parameters
- identifier: number
- OptionalstringType: number
- Optionalcodepage: string
Returns string
Inherited from PSTObject.getStringItem
- Defined in PSTObject.class.ts:149

toJSON

toJSON(): any
JSON stringify the object properties.

Returns any
Implementation of IPSTRecipient.toJSON
Overrides PSTObject.toJSON
- Defined in PSTRecipient.class.ts:105