IDistList : IMAPIContainer
Applies to: Outlook 2013 | Outlook 2016
Provides access to distribution lists in modifiable address book containers. IDistList can create, copy, and delete distribution lists, in addition to performing name resolution.
| Property | Value |
|---|---|
| Header file: |
Mapidefs.h |
| Exposed by: |
Distribution list objects |
| Implemented by: |
Address book providers |
| Called by: |
Client applications |
| Interface identifier: |
IID_IDistList |
| Pointer type: |
LPDISTLIST |
| Transaction model: |
Transacted |
Vtable order
This interface does not have any unique methods.
| Required properties | Access |
|---|---|
| PR_ADDRTYPE (PidTagAddressType) |
Read/write |
| PR_DISPLAY_NAME (PidTagDisplayName) |
Read/write |
| PR_ENTRYID (PidTagEntryId) |
Read-only |
| PR_OBJECT_TYPE (PidTagObjectType) |
Read-only |
| PR_RECORD_KEY (PidTagRecordKey) |
Read-only |
Remarks
The IDistList interface inherits from IMAPIContainer and includes the same methods as address book containers. Therefore, because the methods of the IDistList interface are identical to those of the IABContainer interface, they are not duplicated here.
A distribution list or object that implements IDistList is a collection of messaging user objects, or individual recipients. A distribution list can consist of all messaging user objects, or some messaging user and some distribution lists.
There are typically two types of distribution lists:
Distribution lists that are expanded by the underlying messaging system. This type of list has an address, PR_EMAIL_ADDRESS (PidTagEmailAddress), and is treated the same as if it were an individual recipient.
Distribution lists that exist in a local container and are expanded by the client application.
Optional distribution list properties include the following:
PR_LAST_MODIFICATION_TIME (PidTagLastModificationTime)
PR_DISPLAY_TYPE (PidTagDisplayType)
PR_DETAILS_TABLE (PidTagDetailsTable)
Notice that PR_ADDRTYPE is required, but PR_EMAIL_ADDRESS (PidTagEmailAddress) is not. That is because a distribution list without an email address can still receive messages, but its member list must be expanded. If the PR_ADDRTYPE property is set to MAPIPDL, MAPI performs the expansion. If PR_ADDRTYPE is a value other than MAPIPDL, the transport provider performs the expansion.
For additional information about how to use the IDistList methods, see the reference entries for the parallel methods of IABContainer.