New article
Recently updated
Understanding the Collections.txt file
Who is this article for?Adminswho manage shared Collections.
Shared folderaccess is required.
Collections.txt is used to control which Collections are available to Users.
Note that this is just the (.mmcollection) file based collections. For the dynamic auto-discovered collections, you need to edit the corresponding rules file accordingly, in the shared configuration folder.
1. File location
Your file is located in the Shared Configuration folder. For it to be read, it needs to be called Collections.txt at all times.
A sample file can be found in the Mail Manager installation folder, by default these are:
- C:\Program Files\Mail Manager\Collections.txt
- %localappdata%\Mail Manager\Program Files\Collections.txt
2. File format
When editing the file, ensure you are using a plain text editor, like Notepad. Do not use Microsoft Word (or similar).
Follow the below formatting when making changes.
| Element | Description |
|---|---|
| ; | Lines beginning with a semicolon will be ignored by Mail Manager. They are used for comments. |
| % | Can be used as a wildcard. |
| [remove] | Valid keyword section. Removes specified Collections from user installations. Can contain multiple lines. |
| [add on] | Valid keyword section. Adds and switches on specified Collections to user installations. Can contain multiple lines. |
| [add off] | Valid keyword section. Adds but switches off specified Collections to user installations. Can contain multiple lines. |
Specify only one .mmCollection per line. If no path is specified, it assumes the Collection file is located in the Shared Configuration folder.
You can use environment variables in the path, e.g.: %userprofile%\Dropbox.
When removing Collections, ensure the full path is included or use a wildcard (e.g.: %\Test.mmCollection for UNC/Drive paths, or %/Test.mmCollection for URL paths).
3. Examples
Removing a Collection
In this example, the Collection file is no longer required, so we used [remove] and include the full path.
[remove]
%\Archived Projects.mmCollection
\\Server01\Administration\Staff.mmCollection
%/Projects.mmCollection
https://company.sharepoint.com/sites/Administration/Shared%20Documents/Staff.mmCollection
If the path is not included the Collection will not be removed.
Adding a Collection
In this example, we added two Collection files.
One Collection will be switched on and its filing locations visible when using Mail Manager to file and search. The other will be available to all users, but the locations will not visible when filing or searching.
[add on]
Projects.mmCollection
[add off]
Archived Projects.mmCollection
Adding a Collection (Different location)
In this example, we added Collection files are not located in the Shared Configuration folder.
[add on]
H:\%username%.mmCollection
\\Server01\Administration\Administration.mmCollection
https://company.sharepoint.com/sites/Administration/Shared%20Documents/Staff.mmCollection