Get-MapiRecipientDetails

Description

This cmdlet retrieves address book details for one or more recipients.

Syntax
Note: Parameters in orange are optional.
Get-MapiRecipientDetails
-SessionMapiObject<Mapi.NET.Session>
-EntryIDMapiObject<Mapi.NET.EntryID>[]
-PropsToGetMapi.NET.Tags[]
Get-MapiRecipientDetails
-SessionMapiObject<Mapi.NET.Session>
-RecipientEntryMapiObject<Mapi.NET.Recipient>[]
-PropsToGetMapi.NET.Tags[]
Parameters
SessionA Mapi.NET.Session to use when retrieving addresses from the EmailAddress parameter, or all recipients for an address book or all address books.
EntryIDA list of one or more Mapi.NET.EntryID values, each representing a recipient that exists in one of the available Address Books for the current Session.
RecipientEntryA list of one or more Mapi.NET.Recipient objects, each representing a recipient the exists in one of the available Address Books for the current Session.
PropsToGetA optional list of one or more MAPI properties to retrieve for each recipient. When this parameter is omitted, all available properties for the recipient are retrieved.
Remarks

This cmdlet returns one or more Mapi.NET.AddressBookRecipient objects from an address book of the current session.

Note that unlike a Mapi.NET.Recipient, a Mapi.NET.AddressBookRecipient holds an open connection with the address book and should be released when no longer needed by using object.Dispose.  Mapi has limits on the number of 'open' objects that can exist concurrently.  Attempting to open 100s or 1000s of address book entries will likely fail and may cause memory leaks, or application crashes.

It is recommended to first use Get-MapiRecipient to get a list of recipients, then loop though those items calling Get-MapiRecipientDetails followed by Dispose to release the object after use.