Information in this document, including URL and other Internet Web site references, is subject to change without notice. The example companies, organizations, products, people, and events depicted herein are fictitious. No association with any real company, organization, product, person, or event is intended or should be inferred. Complying with all applicable copyright laws is the responsibility of the user. Without limiting the rights under copyright, no part of this document may be reproduced, stored in or introduced into a retrieval system, or transmitted in any form or by any means (electronic, mechanical, photocopying, recording, or otherwise), or for any purpose, without the express written permission of Microsoft Corporation.
Microsoft may have patents, patent applications, trademarks, copyrights, or other intellectual property rights covering subject matter in this document. Except as expressly provided in any written license agreement from Microsoft, the furnishing of this document does not give you any license to these patents, trademarks, copyrights, or other intellectual property.
© 1999 Microsoft Corporation. All rights reserved.
Microsoft,
The names of actual companies and products mentioned herein may be the trademarks of their respective owners.
Return to Top |
This document describes how to use the Microsoft Exchange Server Mailbox Manager to enforce corporate message retention policies. Additional benefits include simplified management of disk allocation space on Exchange servers, the ability to schedule regular enforcement, and high reliability. The mailbox manager expands the functionality of the "Clean Mailbox" command in the Exchange 5.5 Administrator program by automating many of the processes associated with it. The mailbox manager is intended for organizations with a large number of mailboxes and corporate
Return to Top |
The mailbox manager is a tool to implement corporate email retention policies. Features of the manager include:
Configuration Flexibility Set message deletion by age, folder size, message type and other parameters.
Automation Create a weekly schedule for the mailbox manager to perform message deletion from Exchange mailboxes.
Report Generation Establish detailed reports of message removal and other mailbox manager activities to be logged and sent to administrators.
The mailbox manager works by implementing message deletion policies. A policy is a set of rules that determines whether a message is retained or deleted.
For example, the mailbox manager might be used to implement rules similar to the following:
"Delete all messages more than five days old from users' inboxes."
Deletion policies, the implementation of individual policy rules, and the order in which rules are executed are discussed in the Policies section later in this document.
The following are the system requirements for computers running the mailbox manager.
Microsoft Windows NT© version 4.0 with Service Pack 3 or later;
NOTE The mailbox manager will install and run on versions of Exchange Server 5.5 earlier than Service Pack 2. However, there is a defect in these versions, corrected in Service Pack 2, that will cause continuous memory leaks while the mailbox manager is running.
Return to Top |
The mailbox manager can be installed on any server in an Exchange site, or on multiple servers in the site. Each instance of the mailbox manager maintains its own policy information, and each instance must be individually configured.
The mailbox manager can delete messages in mailboxes that do not reside on the server where the manager is installed.
When the Exchange site consists of multiple Exchange servers, the mailbox manager may be installed on one, more than one, or all servers.
If the manager is installed on one server, that instance of the mailbox manager is responsible for deleting messages on all the servers in a site. This is the simplest configuration from a maintenance standpoint.
NOTE The message deletion policy for the entire site is contained on this one server.
This approach, however, requires the mailbox manager to access mailboxes on servers across local area and wide area network links.
NOTE In this configuration the mailbox manager may create a lot of traffic while executing the policy.
One way to reduce network traffic is to install the manager on multiple servers in the site, and have each instance of the mailbox manager access only those mailboxes physically saved on the same server. However, this requires that each instance of the mailbox manager be configured with an appropriate deletion policy.
NOTE Users should take care to ensure that message deletion policies are not contradictory, and individual mailboxes are not targeted by more than one policy.

In the above illustration, four mailboxes are distributed between two servers and two recipient containers. Mailbox 1 and Mailbox 2 are part of the "Recipients (Marketing)" container. Mailbox 3 and Mailbox 4 are part of the "Recipients (Sales)" container. Mailbox 1 and Mailbox 3 are located on Server 1: In other words Server 1 manages the physical database on which Mailbox 1 and Mailbox 3 are saved. Mailbox 2 and Mailbox 4 are located on Server 2.
In this illustration, the mailbox managers on the two servers have been configured so that only local servers are affected. In other words, the mailbox manager on Server 1 will only act upon Mailbox 1 and Mailbox 3, because these are the only mailboxes located on Server 1. This configuration reduces network traffic, and also ensures that the mailboxes are not targeted by multiple policies.
Return to Top |
Setup consists of two parts, creating the mailbox manager account and setting up the mailbox manager.
The mailbox manager replaces the Mailbox Cleanup Agent (MBClean.exe), which was part of the Microsoft BackOffice Resource Kit, Second Edition. If you have installed the Agent previously its policy settings will be reset when the mailbox manager is installed. The mailbox manager and the Agent may co-exist in the same Exchange site, but not on the same Exchange server. For more information about the Agent, see the Microsoft BackOffice Resource Kit, Second Edition.
The mailbox manager uses a Windows NT service. You must select or create an account for this service to use. This account must have administrator permissions on the Exchange site where the mailbox manager is being installed. In most cases you will want to use the Windows NT account that you used for the other Exchange services, because it automatically has Service Account Administrator permissions on the site.
The account that you select needs to have the Windows NT Log On As Service user right. If you have not already assigned the account this user right, the mailbox manager Setup program will do so for you.
If you are installing mailbox manager from the Service Pack 3 compact disk, run Setup.exe from the Drive:\Eng\server\support\mbmngr\setup directory.
On the Install or Remove Program screen, select Install.
Type the requested additional information:
Service account
The account that runs the mailbox manager service. This account must have the attributes described in the previous section, "Creating the mailbox manager ServiceAccount".
Service account password
The password for the service account.
Service directory
The directory in which mailbox manager files are installed. The default is C:\MBXMAN.
For your convenience, the following information is completed automatically:
Directory Display Name (Microsoft Exchange Server Mailbox Manager for Servername)
The name of the mailbox manager as it appears in the Microsoft Exchange Administrator.
Service Display Name (Microsoft Exchange Server Mailbox Manager)
The name of the mailbox manager as it appears in the Services window of the Service Control Manager.
Click Continue.
Click OK.
Return to Top |
To configure the mailbox manager:
Start the Exchange Administrator program.
All configuration tabs for the mailbox manager are optional, except for the mandatory Policies tab. You can configure the options in any order.
NOTE This tab will only appear if theShow Permissions page for all objects check box has been selected in the Exchange Administrator program.
A read-only list box that displays all Windows NT accounts with inherited rights for this instance of the mailbox manager.
A list of all Windows NT accounts that have rights for this instance of the mailbox manager.
Opens a dialog box where you can select one or more Windows NT accounts and groups to add to the list of accounts and groups with permissions for this instance of the mailbox manager.
Removes the currently selected Windows NT account or group from the list of accounts and groups with permissions for this instance of the mailbox manager.
The type and level of access a Windows NT account or group has to this instance of the mailbox manager. You may select a pre-defined role or select individual rights to create a custom role.
The General tab contains options that affect the general execution of the mailbox manager. It contains settings for the Run mode, Deletion mode and summary report delivery.
The Administrator's Mailbox is the mailbox where the mailbox manager sends administrative reports. These reports contain a table of the number of messages deleted as well as other relevant information. To select or change the Administrator's Mailbox, click the Change button.
If the Clean up Mailboxes option is selected, messages targeted by the active deletion policy will be deleted.
If the Audit option is selected, instead of deleting messages targeted by the active deletion policy, the mailbox manager produces Administrative reports from which it is possible to measure voluntary compliance with corporate message deletion policies.
The Deletion mode determines what happens to messages targeted by the active deletion policy when the mailbox manager runs.
If the Move to Deleted Items folder option is checked, messages are moved to the Deleted Items folder in each client mailbox. This is the default. Messages are deleted as if by the client.
Select Mail Summary Report to Administrator to send a message reporting on the last execution of the mailbox manager to the administrator.
The mailbox manager sends a report that is similar to the following sample.
The Microsoft Exchange Server Mailbox Manager has completed processing mailboxes Started at:04/23/99 20:36:25 Completed at:04/23/99 20:36:33 Mailboxes processed:244 Messages moved:3069 Size of moved messages:4.22 MB Deleted messages:354 Size of deleted messages:1.83 MB
This report is explained in detail in the section, "Logging and Reporting."
Select Attach detailed report file to attach an Administrator's Report to the Summary Report. The Administrator's Report is described below.
The mailbox manager maintains two types of policy rules: those which apply to all affected mailboxes, regardless of recipient container, and those which apply only to mailboxes in a particular recipient container. The mailbox manager also maintains a list of mailboxes that are to be explicitly excluded from automated message deletion.
The order of precedence in which the mailbox manager goes about executing the different parts of a policy is as follows:
If the mailbox is on the Excluded Mailbox list, it is exempt from further processing.
The Deleted Items folder and System Cleanup folder are processed first. Messages older than the specified age limits for these folders are deleted immediately. Message age is the only relevant criterion: message size limits and message class exclusions are ignored when processing the Deleted Items and System Cleanup folders.
The mailbox manager examines every other folder in turn, evaluating whether the folder should be processed. Note that Message Size Limits apply to all the folders in a mailbox (except the Deleted Items and System Cleanup folders).
For each message in an affected folder, if the message class is in the Excluded Message Classes list the message is retained.
For each message in an affected folder, if a Message Size Limit has been set, the size and age of the message are checked. Oversized messages older than the threshold age are deleted.
For each message in an affected folder, if the message is older than the folder's Age Limit for that folder it is deleted.
General Policies apply to all recipient containers you select.
The Message Class feature allows you to exclude certain message classes from deletion. For example, you might not want any contacts to be deleted, regardless of age, or size of the contact item.. To exclude a message class, click Message Classes. The Message Classes dialog box opens. Type the name of the class you want to exclude and click Add each time. The standard
You may also exclude Message Classes and their subclasses by using wildcards. For example, if you choose to exclude "IPM.MyClass.*", the manager will exclude all classes beginning with IPM.MyClass. If you wish to exclude all standard contact items, and all custom message classes derived from the standard contact class, add "IPM.Contact.*" to the list of excluded message classes. If a wildcard is not used, the manager only searches for an exact match for a message class.
Default There are no message classes excluded by default.
The Message Size Limits feature allows you to limit the lifetime of a message based on its size and its age (in days). For example, you can configure the mailbox manager to delete all messages larger than 250 kilobytes (KB) after 10 days.
Applying a Message Size Limit can dramatically increase the length of time it takes for the mailbox manager to process a mailbox.
Default The default settings are 1024 KB and 30 days. If the number of days is set to zero, oversize messages are deleted immediately.
Per Container policies apply on a
Use this dialog box to select mailboxes you want to exclude from automated message deletion.
Default There are no excluded mailboxes.
You may specify the deletion period for items in a particular folder. The default for the interval is 30 days. If the interval is set to 0 days, all messages in that folder are deleted each time the mailbox manager is run.
The Other Folders option sets the age limit for all folders other than those specifically listed on the dialog box. All subfolders, including subfolders of the listed folders, belong to this category. For example, a subfolder of the Inbox folder would not take its age limit from its parent
Default There are no age limits set on any folder when the manager is installed.
When the Use Parent Container Settings check box is selected, recipient containers that are subordinate to another container assume the message deletion policy of the parent recipient container.
NOTE This inheritance of parent container settings is not dynamic. The parent container's policy information is simply copied to its child containers when the Apply or OK buttons are clicked. If you create a new recipient container, it will have no configuration information associated with it until the Exchange Administrator has been run, at which time it will inherit the configuration of its parent container.
When the mailbox manager begins processing mailboxes, it records the start time of the run as the Time Basis for the run. All message age calculations are made relative to this fixed Time Basis value. In other words, even if the mailbox manager were to take several days to complete processing, ages for all items would be computed against the same Time Basis value. The age of a message is computed from the following message properties: when the message was delivered (PR_MESSAGE_DELIVERY_TIME), when the message was sent (PR_CLIENT_SUBMIT_TIME), when the message was created (PR_CREATION_TIME), and when the message was last modified (PR_LAST_MODIFICATION_TIME). If a property has not been set on a message, the next property in the sequence is used.
On the Schedule tab, you specify when the mailbox manager performs the mailbox clean up according to settings on the Policy tab. The time is the local server time of the server running the mailbox manager (not the local time of the server running the Administrator.) The default setting is Saturday at 12:00 Midnight.
The Clean Now feature executes the current mailbox clean up policy within thirty seconds of being clicked.
Clicking Clean Now does not affect the preset schedule as set on the Schedule tab. The mailbox manager will still run at the set time.
If you change your policy settings and press the Clean Now button, you will first be asked to save your changes by pressing the Apply button before the mailbox manager can proceed.
NOTE The Clean Now button is not active if you are a read-only Administrator.
The mailbox manager service can be stopped from the Window NT Service Control Manager. If the mailbox manager service is stopped while the mailbox manager is actively processing mailboxes, it will start its next processing run where it left off. To force the mailbox manager to perform a complete run after being previously interrupted, simply delete the file ProcessedMailboxes.txt from the mailbox manager install directory.
There are several factors to consider when determining the mailbox maintenance schedule:
The amount of message traffic the server is processing at a given time.
When choosing a mailbox maintenance schedule, weigh the benefits of frequent execution against the impact that the execution cycle will have on system performance.
The Notification tab enables you to inform users via
NOTE Notifications are not sent to users if the Run Mode is set to Audit.
Use the Notify User check box to select whether or not users are sent notification messages. The Header, Body, and Footer options allow you to customize the notification message. The default Header text is:
The Microsoft Exchange Server Mailbox Manager has performed an automated cleanup of your mailbox.
The body of the message is automatically generated by the mailbox manager and consists of one line for each affected folder. For example:
23 Items were moved from the Inbox folder to the Deleted Items folder.12 Items were moved from the Inbox\Subfolder to the Deleted Items folder.10 Items were deleted from the Deleted Items folder.
There is no default footer text. You may wish to add some text, for example:
Thank you for your future voluntary compliance with corporate
The mailbox manager can delete messages in mailboxes that are stored locally (on the same server as the mailbox manager) as well as from mailboxes that are stored on other servers. This property page allows you to select which servers in the site will be affected by this instance of the mailbox manager. By default, only mailboxes on the local server are affected. If a server is not explicitly selected, mailboxes on that server will not be processed.
Click Select All to select all the servers in the site.
On the Advanced tab you can set the level of detail in the reports and logs generated by the mailbox manager. The following section discusses the types of reporting and logging that are available and how to use this information for effective mailbox management.
The mailbox manager generates three types of reporting information:
Trace Log Files
All reports contain common information, such as the time the mailbox manager began, the time it finished, the number of messages moved, and other information. The Trace Log Files and Event Log files may contain detailed information, depending upon the Logging Level setting. The administrative reports are intended to give a broad overview of the operations of the mailbox manager.
The Logging Level, set on the Advanced tab, determines what information is captured by the Trace Log Files and Event Log. The Logging Level has no effect on the information in the Administrator's report. The following table describes the information that is captured and where it is registered.
Logging Level |
Event Log |
Trace Log |
1 |
Critical Errors |
None |
2 |
Start, Stop, Critical Errors, and Summary |
None |
3 |
Start, Stop, Critical Errors, and Summary |
Mailbox level statistics |
4 |
Start, Stop, Critical Errors, and Summary |
Mailbox and folder level statistics |
5 |
Start, Stop, Critical Errors, and Summary |
Mailbox and folder level statistics with full trace information |
The summary message that is sent to the event log is in the same format as the message sent to the administrator. This message is explained in the section "Entries in the Event Log" section later in this guide.
Mailbox and folder level statistics, as well as full trace information are captured in the Trace log, which is explained in the "Trace Log" section, later in this guide.
The detailed administrator report is a comma separated file (.csv) that can optionally be attached to the summary message mailed to the administrator. The following is a sample of a detailed administrator report.
TraceType,Date,Time,Object,DisplayName,MbxsProcessed,MsgsStart,SizeMsgsStart,MsgsDeleted,SizeMsgsDeleted,MsgsMoved,SizeMsgsMoved Start,2/5/1999,16:05:00,o=MyOrg/ou=MySite/cn=Configuration/cn=Servers/cn=NEWYORK,NEWYORK,,,,,,, MailboxSummary,2/5/1999,16:05:10,o=MyOrg/ou=MySite/cn=Recipients/cn=Container1/cn=yoshil,YoshiLattimer,,120,338,22,46,0,0 MailboxSummary,2/5/1999,16:05:20,o=MyOrg/ou=MySite/cn=Recipients/cn=Container2/cn=terryh,TerryHargreaves,,101,2243,18,1035,0,0 SkipMailbox,2/5/1999,16:05:30,o=MyOrg/ou=MySite/cn=Recipients/cn=Container2/cn=adelew,AdeleWlliams,,,,,,, ContainerSummary,2/5/1999,16:05:40,o=MyOrg/ou=MySite/cn=Recipients/cn=Container1,Container1,1,,,22,46,0,0 ContainerSummary,2/5/1999,16:05:45,o=MyOrg/ou=MySite/cn=Recipients/cn=Container2,Container2,1,,,18,1035,0,0 ServerSummary,2/5/1999,16:05:50,o=MyOrg/ou=MySite/cn=Configuration/cn=Servers/cn=SERVER1,SERVER1,1,,,22,46,0,0 ServerSummary,2/5/1999,16:05:52,o=MyOrg/ou=MySite/cn=Configuration/cn=Servers/cn=SERVER2,SERVER2,1,,,18,1035,0,0 CleanupSummary,2/5/1999,16:05:55,o=MyOrg/ou=MySite/cn=Configuration/cn=Servers/cn=NEWYORK,NEWYORK,2,,,40,1081,0,0 Stop,2/5/1999,16:06:00,o=MyOrg/ou=MySite/cn=Configuration/cn=Servers/cn=NEWYORK,NEWYORK,,,,,,,
This sample shows the mailbox manager, running on server NEWYORK, started processing at 16:05:00 and stopped at 16:06:00. It processed two mailboxes, one in each of two recipient containers, and skipped a third mailbox. All processed messages were deleted immediately; none were moved to other folders. The processed mailboxes were located on separate servers, and summary information is provided for each server.
NOTE When a field is not defined for a given row type, it is left blank.
Column Heading |
Description |
Trace Type |
Label identifying the kind of information in the CSV file line. |
Date |
Date the entry was written, in |
Time |
Time at which the entry was written, in |
Object |
Object to which the entry refers. For example, the server name or mailbox Distinguished Name. |
Display Name |
Friendly name of the object. For example, the display name of a mailbox. |
MbxsProcessed |
Number of mailboxes processed. |
MsgsStart |
Number of items in a mailbox before processing. |
SizeMsgsStart |
Total size of items in a mailbox before processing. |
MsgsDeleted |
Number of items deleted. |
SizeMsgsDeleted |
Total size of the deleted items in kilobytes (KB), referred to in the MsgsDeleted field. |
MsgsMoved |
Number of items moved from a folder. For example, the number of messages moved from the Inbox folder to Deleted Items folder. |
SizeMsgsMoved |
Total size of the moved items in kilobytes (KB), referred to in the MsgsMoved field. |
Column Heading |
Description |
Start |
Time that Manager started processing. |
Stop |
Object = Distinguished Name of server running Manager |
Skip Mailbox |
Mailbox on the Excluded Mailbox list. |
Mailbox |
Summary information for a cleaned mailbox. |
Container |
Summary information for a processed recipient container. |
Server Summary |
Summary information for a server cleanup by the mailbox manager. Note that an instance of the mailbox manager on one server can target other servers for cleanup. |
Cleanup Summary |
Summary information for all mailbox manager activity across all target servers. |
The Trace Log captures information such as the object affected by the mailbox manager, the number of messages deleted, the type of event that took place, and the time of a given deletion. Trace logs titles are in the format MCAyyyymmdd.log, where yyyy is the year, mm the month and dd the day. They can be found in the same directory where the mailbox manager was installed (C:\MBXMAN by default). Trace Logs are in CSV format, which can be opened in any spreadsheet application, such as Microsoft Excel. Trace Log files can be very large: unwanted log files should be deleted periodically to recover disk space. The following two tables provide an explanation for each row and column.
|
Column Heading |
Description |
Trace Type |
Label identifying the kind of information in the comma separated (CSV) line. |
Sub Type |
Label identifying sub-categories of Trace Type information. For example, the Folder Info trace type can have Sub Types of MsgsStart for the number of messages in the folder before processing, and MsgsEnd for the number of messages after processing. |
Date |
Date when the entry was written. |
Time |
Time when the entry was written. |
Object |
Object to which the entry refers. The server name and mailbox Distinguished Names are two examples. |
Display Name |
Friendly name of the object. For example, a display name of a mailbox. |
Count |
Item count. The interpretation of this field depends on the Trace Type and Sub Type values. |
Error |
Hexadecimal OLE error code. |
Trace Type |
Sub Type |
Description |
Info |
Start |
Time = Time that Manager started processing |
|
Stop |
Time = Time that Manager stopped processing |
Processing Mailbox |
Start |
Object = Distinguished Name of mailbox |
|
Stop |
Object = Distinguished Name of mailbox |
|
Excluded |
Mailbox on the Excluded Mailboxes list for this container. |
|
Error |
Error occurs while processing a mailbox. |
Mailbox Summary |
MsgsStart |
Object = Distinguished Name of mailbox |
|
SizeMsgsStart |
Object = Distinguished Name of mailbox |
|
MsgsDeleted |
Object = Distinguished Name of mailbox |
|
SizeMsgsDeleted |
Object = Distinguished Name of mailbox |
|
MsgsMoved |
Object = Distinguished Name of mailbox |
|
SizeMsgsMoved |
Object = Distinguished Name of mailbox |
Processing Folder |
Start |
Object = Folder path |
|
Stop |
Object = Folder path |
|
Error |
Indicates that an error occurred while processing a folder. |
Folder Config |
Enabled |
Indicates that the folder is enabled for cleaning. |
|
Disabled |
Indicates that the folder is not enabled for cleaning. |
|
AgeLimit |
Object = Folder path |
|
MsgsStart |
Object = Folder path |
|
SizeMsgsStart |
Object = Folder path |
Folder Summary |
MsgsDeleted |
Object = Folder path |
|
SizeMsgsDeleted |
Object = Folder path |
|
MsgsMoved |
Object = Folder path |
|
SizeMsgsMoved |
Object = Folder path |
General Config |
SizeLimit |
Count = Message size limit, in kilobytes. |
|
SizeAgeLimit |
Count = Age limit associated with over-size messages |
|
Mode |
Display Name = {"Audit" | "Delete"} |
|
DeleteMode |
Display Name = {"Immediate" | "Deleted Items" | "System Cleanup"} |
|
DeleteMsgClass |
Display Name = deleted message class (e.g. "IPM.StickyNote") |
|
ContainerCount |
Count = number of configured containers |
TimeBasis |
Date and Time columns record the time against which the mailbox manager does age calculations. The same base time is used for the entire processing run. |
|
Container Config |
AgeLimit |
Display Name = Folder name |
A summary message similar to the following is sent to the event log if the Logging Level is set to 2 or higher.
The Microsoft Exchange Server Mailbox Manager has completed processing mailboxes
Started at: <Start-Time> Stopped at: <End-Time> Mailboxes processed: <Processed-Mailbox-Total> Messages moved: <Moved-Messages-Total> Size of moved messages: <Moved-Messages-Size-Total> Deleted messages: <Deleted-Messages-Total> Size of deleted messages: <Deleted-Messages-Size-Total>
If the run is unsuccessful, the following message is displayed:
Microsoft Exchange Server Mailbox Manager was interrupted before processing was complete - error no = c00002d1. The Microsoft Exchange Server Mailbox Manager has completed processing mailboxes
Started at: <Start-Time> Stopped at: <End-Time> Mailboxes processed: <Processed-Mailbox-Total> Messages moved: <Moved-Messages-Total> Size of moved messages: <Moved-Messages-Size-Total> Deleted messages: <Deleted-Messages-Total> Size of deleted messages: <Deleted-Messages-Size-Total>
Return to Top |