OL98: How to Programmatically Synchronize Folders

ID: Q184791

The information in this article applies to:

SUMMARY

This article illustrates how you can use the Microsoft Outlook object model to synchronize folders. These programming examples use Visual Basic (VB) and Visual Basic Scripting Edition (VBScript) to perform this task.

MORE INFORMATION

Microsoft provides programming examples for illustration only, without warranty either expressed or implied, including, but not limited to, the implied warranties of merchantability and/or fitness for a particular purpose. This article assumes that you are familiar with the programming language being demonstrated and the tools used to create and debug procedures. Microsoft Support professionals can help explain the functionality of a particular procedure, but they will not modify these examples to provide added functionality or construct procedures to meet your specific needs. If you have limited programming experience, you may want to contact the Microsoft fee-based consulting line at (800) 936-5200. For more information about the support options available from Microsoft, please see the following page on the World Wide Web:

   http://www.microsoft.com/support/supportnet/refguide/default.asp

Before using either of these examples, make sure you are using a profile which is set up to use offline folders.

For more information about creating solutions with Microsoft Outlook 98, please see the following article in the Microsoft Knowledge Base:

   Article-ID: Q182158
   Title     : OL98: (CW) What Are Offline Folders and How Do You Use Them?

Automation Example

Before using the following automation code from a VB or Visual Basic for Applications project, make sure to create a reference to the Microsoft Outlook object library.

   Sub SynchronizeOutlookFolders()
      Dim outapp As Outlook.Application
      Dim olns As Outlook.NameSpace
      Dim MyInbox As Outlook.MAPIFolder
      Dim MyExplorer As Outlook.Explorer
      Dim MyMenu As CommandBar
      Dim MyCmd As CommandBarControl
      Set outapp = New Outlook.Application
      Set olns = outapp.GetNamespace("MAPI")
      Set MyInbox = olns.GetDefaultFolder(olFolderInbox)
      Set MyExplorer = MyInbox.GetExplorer
      ' Reference the Tools menu
      Set MyMenu = MyExplorer.CommandBars.Item("Tools")
      ' Reference the Synchronize All Folders command
      Set MyCmd = MyMenu.Controls("Synchronize").Controls("All Folders")
      ' Execute the Synchronize All Folders command
      MyCmd.Execute
      MyExplorer.Close
   End Sub

VBScript Example

The following example uses a custom Outlook form and VBScript to do the same thing:

1. Open a new mail message form.

2. On the Tools menu, click Forms and then click Design This Form.

3. Click the P.2 tab of the form.

4. Using the Control Toolbox, add a CommandButton control to the page.

5. On the Form menu, click View Code. Type or paste the following code

   into the Script Editor window.

      Sub CommandButton1_Click()
         Set MyExplorer = Application.ActiveExplorer
         Set MyMenu = MyExplorer.CommandBars.Item("Tools")
         Set MyCmd = MyMenu.Controls("Synchronize").Controls("All Folders")
         MyCmd.Execute
      End Sub

6. On the Form menu, click Run This Form.

7. Click the CommandButton on the P.2 page to run the code.

REFERENCES

For more information about using CommandBars in Outlook solutions, please see the following article in the Microsoft Knowledge Base:

   Article-ID: Q182394
   Title     : OL98: How to Use Command Bars in Outlook Solutions

For more information about creating solutions with Microsoft Outlook 98, please see the following articles in the Microsoft Knowledge Base:

   Article-ID: Q180826
   Title     : OL98: Resources for Custom Forms and Programming

   Article-ID: Q182349
   Title     : OL98: Questions About Custom Forms and Outlook Solutions

Search the Microsoft Developer Network (MSDN) Library for the Outlook Help File (VBAOUTL.HLP) and query using the following keywords:

   Outlook Synchronize Folders

Additional query words: OutSol OutSol98

Keywords          : kbdta OffVBS 
Version           : WINDOWS:
Platform          : WINDOWS
Issue type        : kbhowto

Last Reviewed: May 17, 1999