README.md in imap-backup-1.0.17 vs README.md in imap-backup-1.1.0

- old
+ new

@@ -1,7 +1,11 @@ -# imap-backup [![Build Status](https://secure.travis-ci.org/joeyates/imap-backup.png)][Continuous Integration] +[![Build Status](https://secure.travis-ci.org/joeyates/imap-backup.png)][Continuous Integration] +[![Source Analysis](https://codeclimate.com/github/joeyates/imap-backup/badges/gpa.svg)](https://codeclimate.com/github/joeyates/imap-backup) +[![Test Coverage](https://codeclimate.com/github/joeyates/imap-backup/badges/coverage.svg)](https://codeclimate.com/github/joeyates/imap-backup/coverage) +# imap-backup + *Backup GMail (or other IMAP) accounts to disk* * [Source Code] * [API documentation] * [Rubygem] @@ -64,9 +68,38 @@ "folders": [ {"name": "[Gmail]/All Mail"}, {"name": "my_folder"} ] + } + ] +} +``` + +## Connection options + +You can override the parameters passed to `Net::IMAP` with `connection_options`. + +Specifically, if you are using a self-signed certificate and get SSL errors, e.g. +`certificate verify failed`, you can choose to not verify the TLS connection: + +```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"} + ], + "connection_options": { + "ssl": {"verify_mode": 0}, + "port": 993 + } } ] } ```