vbMAPI Outlook/MAPI Code Library
(v1.16.0)

ref: vbMAPI_Folder

On this page you'll find:

Overview

Equivalent MAPI object: IMAPIFolder
Equivalent Outlook Redemption object: Redemption.RDOFolder
Equivalent Outlook Object Model object: Outlook.MAPIFolder
Parent: vbMAPI_Store

Class Description

This object is a wrapper for the MAPI IMAPIFolder object.  You use this object to indirectly access messages and sub-folders of a folder.  Use the Items method to access the vbMAPI_FolderItems collection (for messages) or the Folders method to access the vbMAPI_Folders collection.


Property Get Properties() As vbMAPI_Properties

Exposes a collection of the MAPI properties set on this folder.  The default member of the vbMAPI_Properties class is Item, therefore in VB you can call vbMAPI_Folder.Properties(PropTag) directly.

Property Get NamedProperties(ByVal PropertySetGUID As String, _
              ByVal ID As Variant, _
              ByVal DataType As EnumMAPIPropDataTypes) As vbMAPI_Property

Provides access to MAPI named properties for this folder.

PropertySetGUID: A string representation of the property set GUID (e.g. )
ID: The name (string) or property identifier (integer) representing the property to query from the property set.
DataType: The MAPI data type of the property.

Property Get Items() As vbMAPI_FolderItems

Exposes a collection of items (messages) in the form of a vbMAPI_FolderItems collection class.

Property Get Folders() As vbMAPI_Folders

Exposes a collection of sub-folders in the form of a vbMAPI_Folders collection class.

Property Get DefaultItemType() As EnumMessageItemType

Returns the default item type for messages in this folder.

Property Get DefaultMessageClass() As String

Returns the default item type (as a String message class, e.g. ) for messages in this folder.

Property Get ContainerClass() As String

Property Let ContainerClass(ByVal RetVal As String)

Returns/sets the value of MAPI property PR_CONTAINER_CLASS for this folder.

Property Get Name() As String

Property Let Name(ByVal RetVal As String)

Returns/sets the value of MAPI property PR_DISPLAY_NAME for this folder.

Property Get Description() As String

Property Let Description(ByVal RetVal As String)

Returns/sets the value of MAPI property PR_COMMENT for this folder.

Property Get EntryID() As String

Returns the value of MAPI property PR_ENTRYID for this folder.

Property Get ParentEntryID() As String

Returns the value of MAPI property PR_PARENT_ENTRYID for this folder.

Property Get StoreEntryID() As String

Returns the value of MAPI property PR_STORE_ENTRYID for this folder.

Property Get FolderKind() As EnumFolderKind

Returns the value of MAPI property PR_FOLDER_TYPE for this folder.

Property Get UnReadItemCount() As Long

Returns the value of MAPI property PR_CONTENT_UNREAD for this folder.

Property Get SearchKey() As String

Returns the value of the MAPI property PR_SEARCH_KEY from this folder.

Property Get Parent() As vbMAPI_Folder

Returns the parent folder object.

Property Get Session() As vbMAPI_Session

Returns the session object associated with this object.

Property Get MAPIOBJECT() As Variant

Returns the IMAPIFolder object associated with this item.


Enumeration description: EnumMessageItemType


ItemType_MailItem = &H0
ItemType_AppointmentItem = &H1
ItemType_ContactItem = &H2
ItemType_TaskItem = &H3
ItemType_JournalItem = &H4
ItemType_NoteItem = &H5
ItemType_PostItem = &H6
ItemType_DistributionListItem = &H7


Enumeration description: EnumFolderKind


FolderKind_Root = &H0
FolderKind_Generic = &H1
FolderKind_Search = &H2