Fileset Backup Parameters
The following list of parameters control what is going to be included into the associated backup:
Option |
Required |
Default |
Values |
Example |
Description |
---|---|---|---|---|---|
service |
No |
email, contact, calendar, task, (list parameter: it can contain 0, 1 or more elements separated by ‘,’) |
Establish the service or services that will be backed up. If this is not set, the plugin will try to backup all supported services. |
||
user |
No |
Valid email addresses of existing users on the selected exchange service separated by ‘,’ |
Backup mailboxes associated to this list of users. If no user is provided the plugin will use discovery mechanism and include any user with an active mailbox |
||
user_exclude |
No |
Valid email addresses of existing users on the selected exchange service separated by ‘,’ |
Exclude selected mailboxes. If this is the only parameter found for selection, all elements will be included and this list will be excluded |
||
user_regex_include |
No |
Valid regex |
.*@management\.mydomain.com |
Backup matching user mailboxes. Please, only provide list parameters (user + user_exclude) or regex ones. But do not try to combine them |
|
user_regex_exclude |
No |
Valid regex |
.*@guests\.mydomain.com |
Exclude matching user mailboxes. Please, only provide list parameters (user + user_exclude) or regex ones. But do not try to combine them. If this is the only parameter found for user selection, all users will be included and matching users will be excluded |
|
folder |
No |
Folder names separated by ‘,’ |
inbox,company |
Backup only the list of folders of this parameter from the mailboxes of the selected users. If no folder is provided, all folders will be included |
|
folder_exclude |
No |
Folder names separated by ‘,’ |
travel,personal |
Exclude selected folders from the mailboxes of the selected users. If this is the only parameter found for folder selection, all folders will be included and this list will be excluded |
|
folder_regex_include |
No |
Valid regex |
.*mycompany |
Backup matching folders by name. Please, only provide list parameters or regex ones. But do not try to combine them |
|
folder_regex_exclude |
No |
Valid regex |
.*private |
Exclude matching user folders by name. Please, only provide list parameters or regex ones. But do not try to combine them. If this is the only parameter found for folder selection, all folders will be included and matching folders will be excluded |
|
exclude_attachments |
No |
No |
0, no, No, false, FALSE, false, off ; 1, yes, Yes, TRUE, true, on |
Yes |
Exclude any attachment from backup |
mime |
No |
No |
0, no, No, false, FALSE, false, off ; 1, yes, Yes, TRUE, true, on |
Yes |
Backup raw MIME file of items, in addition to the item objects themselves (regular objects are backed up as json formatted objects) |
archive |
No |
No |
0, no, No, false, FALSE, false, off ; 1, yes, Yes, TRUE, true, on |
Yes |
Include In-place archiving tree folders and items of the selected mailboxes |
email_exclude_expr |
No |
String representing a valid Boolean Javascript expression regarding email message fields |
emailSubject.includes(‘private’) && !emailIsRead |
Exclude from backup all messages that match the provided expression |
|
email_exclude_index_expr |
No |
String representing a valid Boolean Javascript expression regarding email message fields |
/.*private.com/.test(emailFrom) |
Exclude only from indexing (catalog email tables) messages matching the provided expression |
|
email_fields_exclude_index |
No |
String representing a list of email message fields |
emailFrom, emailSubject |
Do not store into the index (catalog email tables) the provided list of message fields |
See also
Go back to Fileset Connection Parameters
Go to Fileset Examples
Go back to the Fileset Configuration article.