imap-backup API Documentation

This is the developer documentation for imap-backup's code.

Usage documentation is on GitHub.

You can get an overview of the program's structure from the {file:ARCHITECTURE.md ARCHITECTURE} file.

The {file:CHANGELOG.md CHANGELOG} has a history of the changes to the program.

Design Goals

• Secure - use a local configuration file protected by permissions
• Restartable - calculate start point based on already downloaded messages
• Standalone - do not rely on an email client or MTA

Development

See the development documentation.

Testing

See the testing documentation.

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request