Opening a Message Store Folder
Applies to: Office 2010 | Outlook 2010 | Visual Studio
Before any folder can be opened, its entry identifier must be available. For most folders, this means retrieving their PR_ENTRYID properties. For special folders, such as some of the IPM subtree folders and other root folders, MAPI defines special entry identifier properties that are accessible by calling the message store's IMAPIProp::GetProps method. These entry identifiers are always long-term and are named as follows:
Folder |
Entry identifier property |
|---|---|
Outbox folder |
PR_IPM_OUTBOX_ENTRYID (PidTagIpmOutboxEntryId) (IPM message class only) |
Deleted Items folder |
PR_IPM_WASTEBASKET_ENTRYID (PidTagIpmWastebasketEntryId) |
Sent Items folder |
PR_IPM_SENTMAIL_ENTRYID (PidTagIpmSentMailEntryId) |
IPM root folder |
PR_IPM_SUBTREE_ENTRYID (PidTagIpmSubtreeEntryId) |
Search-results root folder |
PR_FINDER_ENTRYID (PidTagFinderEntryId) |
Common views root folder |
PR_COMMON_VIEWS_ENTRYID (PidTagCommonViewsEntryId) |
Personal views root folder |
PR_VIEWS_ENTRYID (PidTagViewsEntryId) |
Contacts root folder |
PR_IPM_CONTACT_ENTRYID (PidTagIpmContactEntryId) |
Drafts root folder |
PR_IPM_DRAFTS_ENTRYID (PidTagIpmDraftsEntryId) |
Journal root folder |
PR_IPM_JOURNAL_ENTRYID (PidTagIpmJournalEntryId) |
Calendar root folder |
PR_IPM_APPOINTMENT_ENTRYID (PidTagIpmAppointmentEntryId) |
Notes root folder |
PR_IPM_NOTE_ENTRYID (PidTagIpmNoteEntryId) |
Tasks root folder |
PR_IPM_TASK_ENTRYID (PidTagIpmTaskEntryId) |
Before you try to retrieve one of these special entry identifiers, retrieve the PR_VALID_FOLDER_MASK (PidTagValidFolderMask) property of the message store. PR_VALID_FOLDER_MASK is a bitmask that identifies which of the special entry identifiers exist. There is one bit for each of the special folders. If the bit is set, it indicates that the corresponding folder is supported and has a valid entry identifier. For example, if the Deleted Items folder exists and has a valid entry identifier, the FOLDER_IPM_WASTEBASKET_VALID bit will be set in PR_VALID_FOLDER_MASK.
To open the folder where all incoming messages of a particular class are placed
Call IMsgStore::GetReceiveFolder to retrieve its entry identifier, setting the lpszMessageClass parameter to point to a character string identifying the message class. For example, if you want to open the Inbox for your IPM subtree, point lpszMessageClass to IPM. If you want to open the receive folder for IPC messages, set it to point to IPC. If there is no registered receive folder for the message class, GetReceiveFolder chooses the receive folder whose associated message class matches the longest possible prefix of the message class passed in. For more information, see MAPI Receive Folders. Note that the PR_IPM_OUTBOX_ENTRYID property is used to open the Outbox folder only for IPM messages. If you are opening the Outbox for IPC messages, use instead the entry identifier for its receive folder. Both incoming and outgoing IPC messages are placed in the receive folder.
Call one of four OpenEntry methods to open the folder and return an interface pointer that you can use to access it. You can call any one of the following methods to open a folder:
The specific method that you choose depends on the folder to be opened and the objects that are available at the time. Because the IMAPISession method can open any folder for any message store in the current profile, call this OpenEntry when you do not know anything about the folder to be opened. If you know which message store owns the folder and you have a pointer to the message store, call IMsgStore::OpenEntry. For example, use the IMsgStore method to open a receive folder. If you have a pointer to the message store provider's logon object, call IMSLogon::OpenEntry. Because these calls go directly to the message store provider rather than through MAPI, processing is faster. If the folder you are opening is a subfolder of a folder that you already have open, call the open folder's IMAPIContainer::OpenEntry method. The IMAPIContainer method only opens subfolders of a currently opened folder and is the only method guaranteed to work with short-term entry identifiers.
If you want to be able to make changes to the folder to be opened, specify an access level by setting either the MAPI_BEST_ACCESS or MAPI_MODIFY flag in the OpenEntry call. These flags are suggestions to the message store provider to grant the highest level of access, for MAPI_BEST_ACCESS, or read/write access, for MAPI_MODIFY, when opening the folder. Because these flags are only suggestions, the folder may or may not be opened with the access level you expect. By retrieving the PR_ACCESS (PidTagAccess) property, you can determine the range of operations that can be performed on the open folder. However, because many message store providers calculate the value for this property on demand rather than supporting it as a folder property or as a column in their hierarchy table, retrieving it can be time-consuming. An alternate strategy is to attempt whatever operation you need to perform and return an error if necessary.