How to: Save Auto-Archive Properties of a Folder in Solution Storage
Outlook Developer Reference |
This topic shows a solution that saves its private data in a few MAPI auto-archive properties. The solution stores these properties in a StorageItem object of the folder to which the auto-archive properties apply. StorageItem objects are stored as hidden data in the associated portion of a folder, and because solutions can optionally encrypt their data, they offer the privacy required of solution data. Because the MAPI auto-archive properties are not exposed as explicit built-in properties in the Outlook object model, the solution uses the PropertyAccessor on the StorageItem object to set these properties.
The following illustrates the procedure:
- The
ChangeAgingProperties
function accepts the following as input parameters:oFolder
is the Folder object to which the aging properties apply and where their values are stored.AgeFolder
indicates whether to archive or delete items in the folder as specified.DeleteItems
indicates whether to delete, instead of archive, items that are older than the aging period.FileName
indicates a specific file for archiving aged items. If this is an empty string, the default archive file, archive.pst, will be used.Granularity
indicates the unit of time for aging, whether archiving is to be calculated in units of months, weeks, or days.Period
indicates the amount of time in the given granularity. Together, theGranularity
andPeriod
values indicate an aging period. Items in the given folder older than this aging period are to be archived or deleted as specified. For example, aGranularity
of 2 andPeriod
of 14 specifies an aging period of 14 days, when items in the given folder older than 14 days should be either archived or deleted as specified.Default
indicates which settings should be set to the default. The possible values are 0, 1, and 3:- 0 indicates nothing assumes a default value.
- 1 indicates that only the file location assumes a default value. This is the same as checking Archive this folder using these settings and Move old items to default archive folder in the AutoArchive tab of the Properties dialog box for the folder.
- 3 indicates all settings assume a default value. This is the same as checking Archive items in this folder using default settings in the AutoArchive tab of the Properties dialog box for the folder.
- The validity of the parameters is checked.
- If the parameters are valid, Folder.GetStorage is used to create or get an existing StorageItem object with the message class, IPC.MS.Outlook.AgingProperties.
- PropertyAccessor is then used to set the auto-archive properties on the StorageItem, StorageItem.Save is used to save changes to the StorageItem.
- The
TestAgingProps
procedure sets the auto-archive settings for the aging properties of the current folder so that items older than six months are moved to the default archive file.
Remarks
- Place the code in the built-in ThisOutlookSession module.
- Run the
TestAgingProps
procedure to set aging properties on the current folder in the active explorer.
Note |
---|
Whether it is implemented as a VBA macro or a COM add-in, the solution is a trusted caller and can therefore access the PropertyAccessor. To improve this example, wrap the following VBA code in a .NET class for better error trapping and enumeration for Granularity. |
|
See Also