README.md in imap-backup-0.0.5 vs README.md in imap-backup-1.0.0

- old
+ new

@@ -12,23 +12,27 @@ [Rubygem]: http://rubygems.org/gems/imap-backup "Ruby gem at rubygems.org" [Continuous Integration]: http://travis-ci.org/joeyates/imap-backup "Build status by Travis-CI" # Installation - $ gem install 'imap-backup' +```shell +$ gem install 'imap-backup' +``` # Setup Run: - $ imap-backup setup +```shell +$ imap-backup setup +``` The setup system is a menu-driven command line application. It creates ~/.imap-backup directory and configuration file. E.g.: -``` +```json { "accounts": [ { "username": "my.user@gmail.com", @@ -42,10 +46,31 @@ } ] } ``` +It connects to GMail by default, but you can also specify a server: + +```json +{ + "accounts": + [ + { + "username": "my.user@gmail.com", + "password": "secret", + "server": "my.imap.example.com", + "local_path": "/path/to/backup/root", + "folders": + [ + {"name": "[Gmail]/All Mail"}, + {"name": "my_folder"} + ] + } + ] +} +``` + # Security Note that email usernames and passwords are held in plain text in the configuration file. @@ -55,22 +80,34 @@ # Run Backup Manually, from the command line: - $ imap-backup +```shell +$ imap-backup +``` Altertatively, add it to your crontab. +# Result + +Each folder is saved to an mbox file. +Alongside each mbox is a fine *.imap which lists the source IMAP UIDs to allow +a full restore. + # Other Usage List IMAP folders: - imap-backup folders +```shell +$ imap-backup folders +``` Get statistics of emails to download per folder: - imap-backup status +```shell +$ imap-backup status +``` # Design Goals * Secure - use a local file protected by permissions * Restartable - calculate start point based on already downloaded messages