Create a distribution list in the PAB

2022-03-03

Applies to: Outlook 2013 | Outlook 2016

Clients can create a distribution list directly into a modifiable container such as the personal address book (PAB).

Create a sized property tag array with one property tag, PR_DEF_CREATE_DL (PidTagDefCreateDl), as follows:
```
 SizedPropTagArray(1, tagaDefaultDL) =
 {
     1,
     {
         PR_DEF_CREATE_DL
     }
 };
```
Call IAddrBook::GetPAB to retrieve the entry identifier of the PAB. If there is an error or GetPAB returns zero or NULL, do not continue.
```
 LPENTRYID peidPAB = NULL;
 ULONG cbeidPAB = 0;
 lpIAddrBook->GetPAB(&cbeidPAB, &peidPAB);
```

Call IAddrBook::OpenEntry to open the PAB. The ulObjType output parameter should be set to MAPI_ABCONT.

 ULONG ulObjType = 0;
 LPABCONT lpPABCont = NULL;
 lpIAddrBook->OpenEntry(cbeidPAB, peidPAB,
                 NULL,
                 MAPI_MODIFY,
                 &ulObjType,
                 &lpPABCont);

Call the PAB's IMAPIProp::GetProps method to retrieve the PR_DEF_CREATE_DL property, the template that it uses to create a distribution list.
```
 lpPABCont->GetProps(0,
             tagaDefaultDL,
             &lpspvDefDLTpl);
```
If GetProps fails:
1. Call the PAB's IMAPIProp::OpenProperty method to open the PR_CREATE_TEMPLATES (PidTagCreateTemplates) property with the IMAPITable interface.
2. Create a property restriction to search for the row with the PR_ADDRTYPE (PidTagAddressType) column equal to "MAPIPDL."
3. Call IMAPITable::FindRow to locate this row.

Save the entry identifier returned by either GetProps or FindRow.

 peidDefDLTpl = lpspvDefDLTpl->Value.bin.pb;
 cbeidDefDLTpl = lpspvDefDLTpl->Value.bin.cb;

Call the PAB's IABContainer::CreateEntry method to create a new entry using the template represented by the saved entry identifier. Do not assume that the object returned will be a distribution list rather than a messaging user when this call is remoted. Notice that the CREATE_CHECK_DUP flag is passed in the ulFlags parameter to prevent the entry from being added twice.
```
 lpPABCont->CreateEntry(cbeidDefDLTpl,
                 peidDefDLTPL,
                 CREATE_CHECK_DUP_STRICT,
                 &lpNewPABEntry);
```
Call the new entry's IUnknown::QueryInterface method, passing IID_IDistList as the interface identifier, to determine if the entry is a distribution list and supports the IDistList : IMAPIContainer interface. Because CreateEntry returns an IMAPIProp pointer rather than the more specific IMailUser or IDistList pointer, check that a distribution list object was created. If QueryInterface succeeds, you can be sure that you have created a distribution list rather than a messaging user.
Call the distribution list's IMAPIProp::SetProps method to set its display name and other properties.
Call the distribution list's IABContainer::CreateEntry method to add one or more messaging users.
Call the distribution list's IMAPIProp::SaveChanges method when you're ready to save it. To retrieve the entry identifier of the saved distribution list, set the KEEP_OPEN_READWRITE flag and then call IMAPIProp::GetProps requesting the PR_ENTRYID (PidTagEntryId) property.
Release the new distribution list and the PAB by calling their IUnknown::Release methods.
Call MAPIFreeBuffer to release the memory for the entry identifier of the PAB and the sized property tag array.

Share via

Create a distribution list in the PAB

Feedback

Additional resources