Verified Commit 26085ca5 authored by Nikos Papagiannopoulos's avatar Nikos Papagiannopoulos
Browse files

Add usage instructions

parent 1b042dad
Pipeline #291694877 passed with stage
in 4 minutes
......@@ -17,7 +17,7 @@ Features:
- from email
- from name
- to email
- to nam
- to name
- Output duplicate emails
- Output as PHP array
- Option to use cache file, which speeds up the process
......@@ -27,6 +27,53 @@ Features:
- Option to output a file list only
- Option to delete the duplicate emails
To do:
- Temporary a fixed set of rules are used but later there
should be options to choose the rules
Usage:
```
bin/duplicate-email-finder --help
Description:
Find duplicate Emails in a Maildir directory.
Usage:
duplicate-email-finder [options] [--] <maildir>
Arguments:
maildir Maildir path
Options:
--no-cache Disables the use of the cache and refreshes the cache
--files Outputs only email file paths
--exclude-first Exclude first duplicate email file path from output
--exclude-last Exclude last duplicate email file path from output
--output=OUTPUT Save output to a file instead of displaying it
--delete Delete the selected emails
--use-attachment-content Add E-mail Attachment Contents to the comparison criteria
--use-attachment-filename Add E-mail Attachment Filenames to the comparison criteria
--use-attachment-mimetype Add E-mail Attachment Mimetypes to the comparison criteria
--use-body-html Add E-mail Body HTML to the comparison criteria
--use-body-text Add E-mail Body Text to the comparison criteria
--use-cc-email Add E-mail CC Addresses to the comparison criteria
--use-cc-name Add E-mail CC Names to the comparison criteria
--use-date Add E-mail Date to the comparison criteria
--use-from-email Add E-mail From Addresses to the comparison criteria
--use-from-name Add E-mail From Names to the comparison criteria
--use-to-email Add E-mail to-address to the comparison criteria
--use-to-name Add E-mail to-name to the comparison criteria
-h, --help Display help for the given command. When no command is given display help for the duplicate-email-finder command
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi Force ANSI output
--no-ansi Disable ANSI output
-n, --no-interaction Do not ask any interactive question
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
```
You can use the Maildir inside the fixtures to test the command.
Example:
```bash
devilbox@php-7.3.16 in /shared/httpd/DuplicateEmailFinder $ bin/duplicate-email-finder tests/fixtures/Maildir --files --exclude-first
tests/fixtures/Maildir/.Personal/cur/1601332792.M790307P28397.Somehost,S=6682,W=6777:2,S
tests/fixtures/Maildir/.Personal/cur/1601332792.M661090P28397.Somehost,S=4334,W=4401:2,S
```
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment