From 1849497a07d3cc5abf142094a96913ce75185026 Mon Sep 17 00:00:00 2001 From: bosodo <34586855+bosodo@users.noreply.github.com> Date: Fri, 15 Oct 2021 22:12:10 +0200 Subject: [PATCH] Update README.md --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3c986b7..ffb9298 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# exchange-mailbox-cleaner +# Exchange mailbox cleaner Cleanup tool for Microsoft Exchange mailbox. - Homepage: https://github.com/bosodo/exchange-mailbox-cleaner/ @@ -6,16 +6,28 @@ Cleanup tool for Microsoft Exchange mailbox. You can use it to delete emails from exchange mailboxes, that are not managed by Outlook, OWA or etc. (e.g. technical e-mail accounts). You can also export deleted emails to .eml files. (Default option is hard-delete e-mails). +**Dependency** + +Python 3.6+. Befoure run, install the required dependencies with: +``` +pip install -r requirements.txt +``` + +**Usage** ``` Usage: exch-mbox-cleaner.py (--inbox | --inbox-subdir=) [--days=] [--bckp=DIR] [--dry-run] [(--soft | --trash)] exch-mbox-cleaner.py (-h | --help) exch-mbox-cleaner.py --version - +``` +**Examples** +``` Examples: exch-mbox-cleaner.py exchange.example.org jan_kowalski Password! --inbox --days=180 --bckp='./deleted-emails' exch-mbox-cleaner.py exchange.example.org jan_kowalski Password! --days=180 --bckp='./deleted-emails' - +``` +**Options** +``` Options: -h --help Show this screen. --version Show version.