Graymail Control Mailbox Preparation Tool

Document created by user.oxriBaJeN4 Employee on Sep 21, 2015Last modified by user.oxriBaJeN4 Employee on May 13, 2016
Version 10Show Document
  • View in full screen mode

A definition of graymail is typically defined as, "Mail I want, but just not in my inbox right now". Examples include newsletters/ marketing mails that you've subscribed to, but which are not person to person email communication.

 

Once graymail control is enabled in the Mimecast Administration Console, our Mailbox Preparation Tool allows automated provisioning of:

  • A graymail folder in Outlook.
  • An Outlook rule to move all received graymail into the graymail folder.

 

To use our Mailbox Preparation Tool:

  1. Click this link to download the Mailbox Preparation Tool .ZIP file.
  2. Extract the .ZIP file.
  3. Run the Mimecast.Graymail.EXE file

 

Command Summary

 

TypeDescription
UsageMimecast.Graymail (command) (arguments) | [--? | --help]
CommandsConnectConnects to the Exchange EWS endpoint.
Prep-MailboxPrepares the Exchange mailbox for graymail. See the "Prep-Mailbox" section below for more details.
Prep-FilePrepares the mailboxes listed in a file. See the "Prep-File" section below for more details.
Prep-GroupPrepares the mailboxes in the Exchange group. See the "Prep-Group" section below for more details.
List-ProcessedDisplays a list of processed mailboxes.
Clear-ProcessedRemoves a list of processed mailboxes.
Unprep-MailboxRevokes changes made to the Exchange mailbox for graymail.
Unprep-FileRevokes changes made to the mailboxes listed in a file.
Unprep-GroupRevokes changes made to the mailboxes in the Exchange group.
Examples

Start by connecting to your Exchange Server:

      > Mimecast.Graymail Connect -u admin@company.com

Specify a distribution group of mailboxes to prepare for Graymail:

      > Mimecast.Graymail Prep-Group -g group@company.com

 

Detailed Instructions

 

Connecting to the 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 prepare. Connecting is a one-time operation. All functions thereafter will use this account context.

 

TypeDescription
UsageMimecast.Graymail [Connect] (arguments) | [-? | -help]
Arguments-u | -user <username>The authenticating user account.
-p | -pass <password>]The authenticating password.
[-d | -domain <domain>]The authenticating domain.
[-ews <EWS Host>]The EWS hostname.
[-? | -help]Displays this helpful message.
Examples

If your Exchange server supports auto-discovery, use your User Principle Name:

        > Mimecast.Graymail Connect -u myname@company.com

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 requested at run time.

Limitations and 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 are removed.

 

Selecting the Deployment Method

 

Mailboxes can be prepared using one of the following methods:

  • Prep-Mailbox
  • Prep-File
  • Prep-Group

Prep-Mailbox

 

This prepares one or more mailboxes for graymail by creating a folder and an Exchange rule.

 

TypeDescription
Usage> Mimecast.Graymail [Prep-Mailbox] (arguments) | [-? | -help]
Arguments[-m | -mailboxes <mailboxes>]Specifies the mailboxes to be prepared.
[-f | -folder <folder name>]Specifies the name of the graymail folder to be created (default: Graymail).
[-l | -location <folder location>]Specifies the location of the graymail folder (default: Inbox)
[-r | -rule <rule name>]Specifies the name of the graymail rule to be created (default: Mimecast Graymail Rule).
[-u | -unread [<true | false>]]Specifies that the message should be marked as unread (default: false).
[-c | -continue [<true | false>]]Specifies that rules processing should continue after the graymail rule matching has completed (default: false).
[-s | -summary <file name>]Specifies the file name for a Completion Summary Report (default: MailboxPrepSummary.html).
[-r | -report <file name>]Specifies the file name for a Completion Full Report (default: MailboxPrepReport.html).
[-n | -notify <email address>]Specifies an email address to which the Completion Full Report is sent.
[-force [<true | false>]]Specifies whether preparation is forced on specified mailboxes (default: False).
-? | -help]Displays this helpful message.
[-p | -priority <rule priority>]Specifies the relative rule priority in the mailbox (default: High).
Examples

By default, a folder called "Graymail" is created in the user's Inbox, and an rule called 'Mimecast Graymail Rule' is created in the mailbox:

        > Mimecast.Graymail Prep-Mailbox -m user01@company.com

Multiple mailboxes can be prepared 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 can be changed:

        > Mimecast.Graymail Prep-Mailbox -m user05@company.com -f Bulkmail -l Root

The rule name can 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 -nsupport@company.com

Limitations and Known IssuesThe only supported locations of the graymail folder are Root and Inbox.

 

Prep-File

 

This prepares mailboxes listed in a file for graymail, by creating a folder and an Exchange rule in each mailbox.

 

TypeDescription
Usage> Mimecast.Graymail [Prep-File] (arguments) | [-? | -help]
Arguments-i | -input <input file>Specifies the file containing Exchange mail address.
[-f | -folder <folder name>]Specifies the graymail folder to be created (default: Graymail).
[-l | -location <folder location>]Specifies the location of the graymail folder (default: Inbox).
[-r | -rule <rule name>]Specifies the name of the graymail rule to be created (default: Mimecast Graymail Rule).
[-u | -unread [<true | false>]]Specifies that the message should be marked as unread (default: false).
[-c | -continue [<true | false>]]Specifies that rules processing should continue after the graymail rule matching has completed (default: false).
[-s | -summary <file name>]

Specifies the file name for a Completion Summary Report (default: MailboxPrepSummary.html).

[-r | -report <file name>]Specifies the file name for a Completion Full Report (default: MailboxPrepReport.html).
[-n | -notify <email address>]Specifies an email address to which the Completion Full Report is sent.
[-force [<true | false>]]Specifies whether preparation is forced on specified mailboxes (default: false).
[-? | -help]Displays this helpful message.
[-p | -priority <rule priority>]Specifies the relative rule priority in the mailbox (default: High).
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 can be changed:

        > Mimecast.Graymail Prep-File -i mailboxes.txt -f Bulkmail -l Root

The Exchange rule name can 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 prepares a distribution group for graymail, by creating a folder and Exchange rule in each mailbox.

 

TypeDescription
Usage> Mimecast.Graymail [Prep-Group] (arguments) | [-? | -help]
Arguments-g | -group <exchange group>Specifies the Exchange group email address.
[-f | -folder <folder name>]Specifies the graymail folder to be created (default: Graymail).
[-l | -location <folder location>]Specifies the location of the graymail folder (default: Inbox).
[-r | -rule <rule name>]Specifies the name of the graymail rule to be created (default: Mimecast Graymail Rule).
[-u | -unread [<true | false>]]Specifies that the message should be marked as unread (default: false).
[-c | -continue [<true | false>]]Specifies that rules processing should continue after the graymail rule matching has completed (default: false).
[-s | -summary <file name>]

Specifies the file name for a Completion Summary Report (default: MailboxPrepSummary.html).

[-r | -report <file name>]Specifies the file name for a Completion Full Report (default: MailboxPrepReport.html).
[-n | -notify <email address>]Specifies an email address to which the Completion Full Report is sent.
[-force [<true | false>]]Specifies whether preparation is forced on specified mailboxes (default: false).
[-? | -help]Displays this helpful message.
[-p | -priority <rule priority>]Specifies the relative rule priority in the mailbox (default: High).
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 can be changed:

        > Mimecast.Graymail Prep-Group -g dl02@company.com -f Bulkmail -l Root

The Exchange rule name can 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 IssuesThe only supported locations of the graymail folder are Root and Inbox.

 

Removing Graymail Rules and Folders

 

Graymail features can be revoked from mailboxes using one of the following methods:

  • Prep-Mailbox
  • Prep-File
  • Prep-Group

If the graymail folder being removed contains email, it will not be deleted.

Unprep-Mailbox

 

This removes a graymail folder and Exchange rule from one or more mailboxs.

 

TypeDescription
Usage> Mimecast.Graymail [Unprep-Mailbox] (arguments) | [-? | -help]
Arguments[-m | -mailboxes <mailboxes>]Specifies the mailboxes whose graymail folder and Exchange rule is to be revoked.
[-f | -folder <graymail folder>]Specifies the name of the graymail folder to be deleted (default: Graymail).
[-l | -location <folder location>]Specifies the location of the graymail folder to be deleted (default: Inbox).
[-r | -rule <graymail rule>]Specifies the name of the graymail rule to be deleted (default: Mimecast Graymail Rule).
[-? | -help]Displays this helpful message.

 

Unprep-File

 

This removes a graymail folder and Exchange rule from each mailbox specified in a file.

 

TypeDescription
Usage> Mimecast.Graymail [Unprep-File] (arguments) | [-? | -help]
Arguments-i | -input <input file>

Specifies the file name containing the Exchange mailboxes whose graymail folder and Exchange rule are to be revoked.

[-f | -folder <graymail folder>]Specifies the name of the graymail folder to be deleted (default: Graymail).
[-l | -location <folder location>]Specifies the location of the graymail folder to be deleted (default: Inbox).
[-r | -rule <graymail rule>]Specifies the name of the graymail rule to be deleted (default: Mimecast Graymail Rule).
[-? | -help]Displays this helpful message.

 

Unprep-Group

 

This removes a graymail folder and Exchange rule from each mailbox in a group.

 

TypeDescription
Usage> Mimecast.Graymail [Unprep-Group] (arguments) | [-? | -help]
Arguments-g | -group <exchange group>Specifies the Exchange group email address whose graymail folder and Exchange rule is to be revoked.
[-f | -folder <graymail folder>]Specifies the name of the graymail folder to be deleted (default: Graymail).
[-l | -location <folder location>]Specifies the location of the graymail folder to be deleted (default: Inbox).
[-r | -rule <graymail rule>]Specifies the name of the graymail rule to be deleted (default: Mimecast Graymail Rule).
[-? | -help]Displays this helpful message.

Attachments

    Outcomes