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 ARCHITECTURE file.
The 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
Repository
After cloning the repo, run the following command to get
better git blame
output:
git config --local blame.ignoreRevsFile .git-blame-ignore-revs
Testing
Feature Specs
Specs under specs/features
are integration specs.
Some of these specs run against two local IMAP servers
controlled by Podman (or Docker) Compose.
Start them before running the test suite
$ podman-compose -f dev/compose.yml up -d
or, with Docker
$ docker-compose -f dev/compose.yml up -d
Then, run all specs
$ rspec
To exclude container-based tests
$ rspec --tag ~container
To run just the feature specs
rspec spec/features/**/*_spec.rb
Full Test Run
The full test run includes RSpec specs and Rubocop checks
rake
Test Debugging
The feature specs are run 'out of process' via the Aruba gem.
In order to see debugging output from the process,
use last_command_started.output
.
Older Rubies
A Containerfile is available to allow testing with all available Ruby versions,
see the README in the dev
directory.
Performance Specs
PERFORMANCE=1 rspec --order=defined
Beware: the performance spec (just backup for now) takes a very long time to run, approximately 24 hours!
Access Docker imap server
require "net/imap"
require_relative "spec/features/support/30_email_server_helpers"
include EmailServerHelpers
test_connection = test_server_connection_parameters
test_imap = Net::IMAP.new(test_connection[:server], test_connection[:connection_options])
test_imap.login(test_connection[:username], test_connection[:password])
= "From: #{test_connection[:username]}\nSubject: Some Subject\n\nHello!\n"
response = test_imap.append("INBOX", , nil, nil)
test_imap.examine("INBOX")
uids = test_imap.uid_search(["ALL"]).sort
fetch_data_items = test_imap.uid_fetch(uids, ["BODY[]"])
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Added some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request