Mailbox Prep Tool for Mimecast Graymail Control
v1.4.1
Graymail is typically defined as "mail that you want, but just not in your inbox right now".
Examples are newsletters and marketing mails which have been subscribed to, but which are not person-to-person email communication.
Once Graymail Control is enabled within the Mimecast Administration Console, the Mailbox Prep Tool for Mimecast Graymail Control allows automated provisioning of:
* A Graymail folder in Outlook
* An Outlook Message Rule to move all received Graymail into the Graymail folder.
Summary of Commands
USAGE:
> Mimecast.Graymail (command) (arguments) | [--? | --help]
COMMANDS:
Connect Connect to Exchange EWS Endpoint
Prep-Mailbox Prep Exchange Mailbox for Graymail
Prep-File Prep Mailboxes listed in a file
Prep-Group Prep Mailboxes in Exchange Group
List-Processed View list of processed mailboxes
Clear-Processed Remove list of processed mailboxes
Unprep-Mailbox Unprep Exchange Mailbox for Graymail
Unprep-File Unprep Mailboxes listed in a file
Unprep-Group Unprep Mailboxes in Exchange Group
EXAMPLES
Start by connecting to your Exchange Server
> Mimecast.Graymail Connect -u admin@company.com
Then specify a distribution group of mailboxes to prepare for Graymail
> Mimecast.Graymail Prep-Group -g group@company.com
Detailed Instructions
Step 1: Connect to Exchange EWS Environment
The first step in the deployment process is to discover and authenticate to your Exchange EWS EndPoint.
Use an account with "Exchange Impersonation" rights to the mailboxes you wish to prep.
Connecting is a one-time operation. All functions thereafter will use this account context.
USAGE:
> Mimecast.Graymail [Connect] (arguments) | [-? | -help]
ARGUMENTS:
-u | -user <Username> Authenticating User Account
[-p | -pass <Password>] Authenticating Password
[-d | -domain <Domain>] Authenticating Domain
[-ews <EWS Host>] EWS Host Name
[-? | -help] Displays this helpful message
EXAMPLES
If your Exchange server supports auto-discovery, simply use your User Principle Name
> Mimecast.Graymail Connect -u myname@company.com
Alternatively, you may use your SAM Username and Domain and specify the EWS host.
> Mimecast.Graymail Connect -u myname -d company -ews ews.company.com
If you do not supply your password on the command line, it will be request at run time.
LIMITATIONS & KNOWN ISSUES
* Given EWS API limitations, this only works for Exchange 2010 sp1 and above.
* Earlier versions of Outlook may not display the created rules correctly.
* Manually configured Outlook client rules for sent messages will be removed.
Step 2: Choose Deployment Method
Mailboxes can be prepared using one of the following methods:
Prep-Mailbox: Prepares one or more mailboxes for Graymail by creating a folder & Exchange rule.
Prep-File: Prepares mailboxes listed in a file for Graymail by creating a folder & Exchange rule in each mailbox.
Prep-Group: Prepares a distribution group for Graymail by creating a folder & Exchange rule in each mailbox.
Examples of each deployment scenario are described below.
----------------------------------------------------------------------------------------------------------------------------------
Prep-Mailbox This method prepares one or more mailboxes for Graymail by creating a folder and Exchange rule. USAGE: > Mimecast.Graymail [Prep-Mailbox] (arguments) | [-? | -help] ARGUMENTS: [-m | -mailboxes <Mailboxes>] Mailboxes to prep [-f | -folder <Folder Name>] Graymail Folder to create (default: Graymail) [-l | -location <Folder Location>] Graymail Folder location (default: Inbox) [-r | -rule <Rule Name>] Graymail Rule to create (default: Mimecast Graymail Rule) [-p | -priority <Rule Priority>] Relative Rule Priority in Mailbox (default: High) [-u | -unread [<true | false>]] Leave Message marked as Unread (default: False) [-c | -continue [<true | false>]] Continue Rules Processing after matching (default: False) [-s | -summary <File Name>] Write Complete Report to this location (default: MailboxPrepSummary.html) [-n | -notify <Email Address>] Send Completion Report to this address [-force [<true | false>]] Force Prep on specified Mailboxes (default: False) [-? | -help] Displays this helpful message EXAMPLES By default, a folder called 'Graymail' is created in the user's Inbox and an Exchange rule called 'Mimecast Graymail Rule' is created in the mailbox. > Mimecast.Graymail Prep-Mailbox -m user01@company.com Multiple mailboxes can be prepped at the same time by using a comma-separated list. > Mimecast.Graymail Prep-Mailbox -m user02@company.com, user03@company.com, user04@company.com The location and name of the Graymail folder may be changed. > Mimecast.Graymail Prep-Mailbox -m user05@company.com -f Bulkmail -l Root The Exchange rule name may also be changed. > Mimecast.Graymail Prep-Mailbox -m user06@company.com -r Bulkmail Filtering By deafult, Bulk Messages are marked as read. This may changed by including the -unread flag > Mimecast.Graymail Prep-Mailbox -m user07@company.com -u On completion, send a report to interested parties. > Mimecast.Graymail Prep-Mailbox -m user08@company.com -n support@company.com LIMITATIONS & KNOWN ISSUES * The only supported locations of the Graymail folder are Root and Inbox.
----------------------------------------------------------------------------------------------------------------------------------
Prep-file This method prepares mailboxes listed in a file for Graymail by creating a folder and Exchange rule in each Mailbox. USAGE: > Mimecast.Graymail [Prep-File] (arguments) | [-? | -help] ARGUMENTS: -i | -input <Input File> File containing Exchange mail address [-f | -folder <Folder Name>] Graymail Folder to create (default: Graymail) [-l | -location <Folder Location>] Graymail Folder location (default: Inbox) [-r | -rule <Rule Name>] Graymail Rule to create (default: Mimecast Graymail Rule) [-p | -priority <Rule Priority>] Relative Rule Priority in Mailbox (default: High) [-u | -unread [<true | false>]] Leave Message marked as Unread (default: False) [-c | -continue [<true | false>]] Continue Rules Processing after matching (default: False) [-s | -summary <File Name>] Write Complete Report to this location (default: MailboxPrepSummary.html) [-n | -notify <Email Address>] Send Completion Report to this address [-force [<true | false>]] Force Prep on specified Mailboxes (default: False) [-? | -help] Displays this helpful message
EXAMPLES
By default, a folder called 'Graymail' is created in the user's Inbox and an Exchange rule called 'Mimecast Graymail Rule' is created in the mailbox.
The file is specified as per standard command line rules.
> Mimecast.Graymail Prep-File -i mailboxes.txt
The location and name of the Graymail folder may be changed.
> Mimecast.Graymail Prep-File -i mailboxes.txt -f Bulkmail -l Root
The Exchange rule name may also be changed.
> Mimecast.Graymail Prep-File -i mailboxes.txt -r Bulkmail Filtering
On completion, send a report to interested parties.
> Mimecast.Graymail Prep-File -i mailboxes.txt -n support@company.com
LIMITATIONS & KNOWN ISSUES
* The only supported locations of the Graymail folder are Root and Inbox
* Only one mailbox can be specified per line.
* Blank lines and lines starting with # are ignored
SAMPLE FILE CONTENT
# sample file contents
user01@company.com
user02@company.com
user03@company.com
# management
myname@company.com
----------------------------------------------------------------------------------------------------------------------------------
Prep-Group This method prepares a distribution group for Graymail by creating a folder and Exchange rule in each mailbox. USAGE: > Mimecast.Graymail [Prep-Group] (arguments) | [-? | -help] ARGUMENTS: -g | -group <Exchange Group> Exchange Group mail address [-f | -folder <Folder Name>] Graymail Folder to create (default: Graymail) [-l | -location <Folder Location>] Graymail Folder location (default: Inbox) [-r | -rule <Rule Name>] Graymail Rule to create (default: Mimecast Graymail Rule) [-p | -priority <Rule Priority>] Relative Rule Priority in Mailbox (default: High) [-u | -unread [<true | false>]] Leave Message marked as Unread (default: False) [-c | -continue [<true | false>]] Continue Rules Processing after matching. (default: False) [-s | -summary <File Name>] Write Complete Report to this location (default: MailboxPrepSummary.html) [-n | -notify <Email Address>] Send Completion Report to this address [-force [<true | false>]] Force Prep on specified Mailboxes (default: False) [-? | -help] Displays this helpful message
EXAMPLES
By default, a folder called 'Graymail' is created in the user's Inbox and an Exchange rule called 'Mimecast Graymail Rule' is created in the mailbox.
The group is specified by its SMTP email address.
> Mimecast.Graymail Prep-Group -g dl01@company.com
The location and name of the Graymail folder may be changed.
> Mimecast.Graymail Prep-Group -g dl02@company.com -f Bulkmail -l Root
The Exchange rule name may also be changed.
> Mimecast.Graymail Prep-Group -g dl03@company.com -r Bulkmail Filtering
On completion, send a report to interested parties.
> Mimecast.Graymail Prep-Group -g dl04@company.com -n support@company.com
LIMITATIONS & KNOWN ISSUES
* The only supported locations of the Graymail folder are Root and Inbox.
----------------------------------------------------------------------------------------------------------------------------------
Removing Graymail Rules and Folders
Graymail features can be removed using one of the following methods:
Unprep-Mailbox: Removes a previously created Graymail folder & Exchange rule from one or more mailboxes.
Unprep-File: Removes a previously created Graymail folder & Exchange rule from mailboxes listed in a file.
Unprep-Group: Removes a previously created Graymail folder & Exchange rule from a distribution group.
Examples of each scenario are described below.
----------------------------------------------------------------------------------------------------------------------------------
Unprep-Group
This method removes a previously-deployed folder and Exchange rule in each mailbox. (If the graymail folder contains email, it will not be deleted).
USAGE:
> Mimecast.Graymail [Unprep-Group] (arguments) | [-? | -help]
ARGUMENTS:
-g | -group <Exchange Group> Exchange Group mail address
[-f | -folder <Graymail Folder>] Graymail Folder to delete (default: Graymail)
[-l | -location <Folder Location>] Graymail Folder location (default: Inbox)
[-r | -rule <Graymail Rule>] Graymail Rule to delete (default: Mimecast Graymail Rule)
[-? | -help] Displays this helpful message
----------------------------------------------------------------------------------------------------------------------------------
Unprep-File
This method removes a previously-deployed folder and Exchange rule in each mailbox. (If the graymail folder contains email, it will not be deleted).
USAGE:
> Mimecast.Graymail [Unprep-File] (arguments) | [-? | -help]
ARGUMENTS:
-i | -input <Input File> File containing Exchange mail address
[-f | -folder <Graymail Folder>] Graymail Folder to delete (default: Graymail)
[-l | -location <Folder Location>] Graymail Folder location (default: Inbox)
[-r | -rule <Graymail Rule>] Graymail Rule to delete (default: Mimecast Graymail Rule)
[-? | -help]
----------------------------------------------------------------------------------------------------------------------------------
Unprep-Mailbox
This method removes a previously-deployed folder and Exchange rule in each mailbox. (If the graymail folder contains email, it will not be deleted). USAGE: > Mimecast.Graymail [Unprep-Mailbox] (arguments) | [-? | -help] ARGUMENTS: [-m | -mailboxes <Mailboxes>] Mailboxes to Unprep [-f | -folder <Graymail Folder>] Graymail Folder to delete (default: Graymail) [-l | -location <Folder Location>] Graymail Folder location (default: Inbox) [-r | -rule <Graymail Rule>] Graymail Rule to delete (default: Mimecast Graymail Rule) [-? | -help] Displays this helpful message
----------------------------------------------------------------------------------------------------------------------------------