To get a MAPIFolder object

Outlook provides no built-in way to get a folder if all you know is its name. This sample for getting a MAPIFolder object is based on a path, such as "Public Folders/All Public Folders/Company/Sales". This is an important technique, since you need a MAPIFolder any time you want to move an item. The VB/VBA and VBScript versions differ mainly in their error-handling and declarations.

Usage for either the VB/VBA or VBScript version:

Set objFolder = GetFolder("Public Folders/All Public Folders/Company/Sales")

The path argument needs to be in quotation marks and exactly match the folder hierarchy that the user sees in the Folder List. An easy way to see the path string is to display the Web toolbar (View | Toolbars) and look in its Address box. Omit the "Outlook:" prefix if you copy the path string for use with GetFolder().

NOTE: If any folder name in the path string contains a "/" or "\" character, this routine will not work, because it assumes that those characters are delimiters in the path string.

VBA/VB | VBScript | More Information

Code Sample (Outlook VBA)

Public Function GetFolder(strFolderPath As String)As MAPIFolder ' strFolderPath needs to be something like ' "Public Folders\All Public Folders\Company\Sales" or ' "Personal Folders\Inbox\My Folder" Dim objApp As Outlook.Application Dim objNS As Outlook.NameSpace Dim colFolders As Outlook.Folders Dim objFolder As Outlook.MAPIFolder Dim arrFolders() As String Dim I As Long On Error Resume Next strFolderPath = Replace(strFolderPath, "/", "\") arrFolders() = Split(strFolderPath, "\") Set objApp = Application Set objNS = objApp.GetNamespace("MAPI") Set objFolder = objNS.Folders.Item(arrFolders(0)) If Not objFolder Is Nothing Then For I = 1 To UBound(arrFolders) Set colFolders = objFolder.Folders Set objFolder = Nothing Set objFolder = colFolders.Item(arrFolders(I)) If objFolder Is Nothing Then Exit For End If Next End If Set GetFolder = objFolder Set colFolders = Nothing Set objNS = Nothing Set objApp = Nothing End Function

Code Sample (VBScript for Outlook form)

Function GetFolder(FolderPath) ' folder path needs to be something like ' "Public Folders\All Public Folders\Company\Sales" Dim aFolders Dim fldr Dim i Dim objNS On Error Resume Next strFolderPath = Replace(FolderPath, "/", "\") aFolders = Split(FolderPath, "\") 'get the Outlook objects ' use intrinsic Application object in form script Set objNS = Application.GetNamespace("MAPI") 'set the root folder Set fldr = objNS.Folders(aFolders(0)) 'loop through the array to get the subfolder 'loop is skipped when there is only one element in the array For i = 1 To UBound(aFolders) Set fldr = fldr.Folders(aFolders(i)) 'check for errors If Err <> 0 Then Exit Function Next Set GetFolder = fldr ' dereference objects Set objNS = Nothing End Function

More Information

Code samples

Get Public Folder -- function to return any public folder based on path, regardless of the user's language configuration
Save in Target Folder Sample Form -- Uses a slightly different function to get the MAPIFolder target
To set the storage folder for an outgoing message -- Uses the PickFolder method to get a target folder
Setting a reference to an Exchange Public Folder -- Using PickFolder and EntryID
GetFolderByName -- Returns the MAPIFolder object for a uniquely named folder, without knowing its path


	© 2002-7 TurtleFlock, LLC All right reserved. About OutlookCode.com Send comments to webmaster@outlookcode.com Designed and Implemented by TerraLink USA FrontPage Integration by RobsonDesignWorks


get Sue's code \| forums \| share your own code \| registration