{"id":13473864,"url":"https://github.com/joeyates/imap-backup","last_synced_at":"2026-10-19T11:49:13.430Z","repository":{"id":3553625,"uuid":"4614540","full_name":"joeyates/imap-backup","owner":"joeyates","description":"Backup and Migrate IMAP Email Accounts","archived":false,"fork":false,"pushed_at":"2026-03-30T14:41:16.000Z","size":2895,"stargazers_count":1711,"open_issues_count":9,"forks_count":92,"subscribers_count":19,"default_branch":"main","last_synced_at":"2026-09-22T12:15:29.092Z","etag":null,"topics":["backup","imap","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/joeyates.png","metadata":{"files":{"readme":".github/README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null},"funding":{"github":["joeyates"]}},"created_at":"2012-06-10T11:22:37.000Z","updated_at":"2026-09-22T11:45:45.000Z","dependencies_parsed_at":"2024-01-13T03:01:05.182Z","dependency_job_id":"39d6a0d6-49ed-456e-91a8-862b549e9d79","html_url":"https://github.com/joeyates/imap-backup","commit_stats":{"total_commits":1371,"total_committers":13,"mean_commits":"105.46153846153847","dds":"0.013129102844638973","last_synced_commit":"97bd7a659a9d095861806e28daf25934b46868a4"},"previous_names":[],"tags_count":145,"template":false,"template_full_name":null,"purl":"pkg:github/joeyates/imap-backup","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joeyates%2Fimap-backup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joeyates%2Fimap-backup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joeyates%2Fimap-backup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joeyates%2Fimap-backup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joeyates","download_url":"https://codeload.github.com/joeyates/imap-backup/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joeyates%2Fimap-backup/sbom","scorecard":{"id":527441,"data":{"date":"2025-08-11","repo":{"name":"github.com/joeyates/imap-backup","commit":"1dc4f0ae1fe4c82ed8024009ada758aadee7d01a"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.4,"checks":[{"name":"Maintained","score":10,"reason":"30 commit(s) and 14 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'contents' permission set to 'read': .github/workflows/publish-image.yaml:19","Warn: jobLevel 'packages' permission set to 'write': .github/workflows/publish-image.yaml:20","Warn: no topLevel permission defined: .github/workflows/main.yml:1","Warn: no topLevel permission defined: .github/workflows/publish-image.yaml:1"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/joeyates/imap-backup/main.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/joeyates/imap-backup/main.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/joeyates/imap-backup/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-image.yaml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/joeyates/imap-backup/publish-image.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish-image.yaml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/joeyates/imap-backup/publish-image.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish-image.yaml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/joeyates/imap-backup/publish-image.yaml/main?enable=pin","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   4 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-20T04:47:15.552Z","repository_id":3553625,"created_at":"2025-08-20T04:47:15.552Z","updated_at":"2025-08-20T04:47:15.552Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":344872684,"owners_count":38356429,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-10-03T21:59:58.778Z","status":"online","status_checked_at":"2026-10-19T02:00:06.414Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backup","imap","ruby"],"created_at":"2024-07-31T16:01:07.558Z","updated_at":"2026-10-19T11:49:13.106Z","avatar_url":"https://github.com/joeyates.png","language":"Ruby","funding_links":["https://github.com/sponsors/joeyates"],"categories":["Ruby","ruby","Uncategorized"],"sub_categories":["Uncategorized"],"readme":"![Version](https://img.shields.io/gem/v/imap-backup?label=Version\u0026logo=rubygems)\n[![Build Status](https://github.com/joeyates/imap-backup/actions/workflows/main.yml/badge.svg)][CI Status]\n![Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/joeyates/b54fe758bfb405c04bef72dad293d707/raw/coverage.json)\n![License](https://img.shields.io/github/license/joeyates/imap-backup?color=brightgreen\u0026label=License)\n[![Stars](https://img.shields.io/github/stars/joeyates/imap-backup?style=social)][GitHub Stars]\n![Activity](https://img.shields.io/github/last-commit/joeyates/imap-backup/main)\n\n# imap-backup\n\nBackup, restore and migrate email accounts.\n\n# Quick Start\n\n```sh\nbrew install imap-backup # for macOS\ngem install imap-backup --no-document # for Linux\nimap-backup setup\nimap-backup\n```\n\n# Modes\n\nThere are two types of backups:\n\n* Keep all (the default) - progressively saves a local copy of all emails,\n* Mirror - adds and deletes emails from the local copy to keep it up to date with the account.\n\n# What You Can Do with a Backup\n\n* Copy - copy messages from one account to another, tracking copies in order to avoid duplicates.\n* Restore - push the local copy back to the original account.\n\nSee below for a [full list of commands](#commands).\n\n# Installation\n\n\u003cdetails\u003e\n\u003csummary\u003eDocker or Podman\u003c/summary\u003e\nIf you have Docker or Podman installed, the easiest way to use imap-backup\nis via the container image.\n\nYou'll need to choose a path on your computer where your backups will be saved,\nwe'll use `./my-data` here.\n\nIf you have just one account, you can do as follows\n\n```sh\ndocker run \\\n  --volume ./my-data:/data \\\n  --dns 8.8.8.8 \\\n  ghcr.io/joeyates/imap-backup:latest \\\n  imap-backup single backup \\\n    --email me@example.com \\\n    --password mysecret \\\n    --server imap.example.com \\\n    --path /data/me_example.com\n```\n\nPodman will work exactly the same.\n\nNotes:\n\n* If you're using Docker, add `--user $(id -u):$(id -g)` so that the files\n  created by the container are owned by you and not by root,\n* Pass imap-backup the `--password-environment-variable=VARIABLE_NAME` or\n  `--password-file=FILE` option to avoid having your password in\n  the command line history:\n\n```sh\ndocker run --env THE_PASSWORD=$THE_PASSWORD \\\n  ... \\\n  imap-backup single backup \\\n    --password-environment-variable=THE_PASSWORD \\\n    ...\n```\n\nor\n\n```sh\ndocker run \\\n  ... \\\n  imap-backup single backup \\\n    --password-file=/data/password.txt \\\n    ...\n```\n\nIf you have multiple accounts, you can create a configuration file.\n\nYou'll need to choose a path on your computer where your configuration will be saved,\nwe'll use `./my-config` here.\n\nFirst, run the menu-driven setup program to configure your accounts\n\n```sh\ndocker run \\\n  --volume ./my-config:/config \\\n  --volume ./my-data:/data \\\n  --dns 8.8.8.8 \\\n  --tty \\\n  --interactive \\\n  ghcr.io/joeyates/imap-backup:latest \\\n  imap-backup setup \\\n    --config /config/imap-backup.json\n```\n\nThen, run the backup\n\n```sh\ndocker run \\\n  --volume ./my-config:/config \\\n  --volume ./my-data:/data \\\n  --dns 8.8.8.8 \\\n  ghcr.io/joeyates/imap-backup:latest \\\n  imap-backup backup \\\n    --config /config/imap-backup.json\n```\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eHomebrew (macOS)\u003c/summary\u003e\n  \n![Homebrew installs](https://img.shields.io/homebrew/installs/dm/imap-backup?label=Homebrew%20installs)\n\nIf you have [Homebrew](https://brew.sh/), do this:\n\n```sh\nbrew install imap-backup\n```\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eAs a Ruby Gem\u003c/summary\u003e\n  \n* [Rubygem]\n\n```sh\ngem install imap-backup --no-document\n```\n\nIf that doesn't work, see the [detailed installation instructions](/docs/installation/rubygem.md).\n\n[Rubygem]: https://rubygems.org/gems/imap-backup \"Ruby gem at rubygems.org\"\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eFrom Source Code\u003c/summary\u003e\n  \nIf you want to use imap-backup directly from the source code, see [here](/docs/installation/source.md).\n  \n\u003c/details\u003e\n\n# Setup\n\nNormally you will want to backup a number of email accounts.\nDoing so requires the creation of a config file.\n\nYou do this via a menu-driven command line program:\n\nRun:\n\n```sh\nimap-backup setup\n```\n\nAs an alternative, if you only want to backup a single account,\nyou can pass all the necessary parameters directly to the `single backup` command\n(see the [`single backup`](/docs/commands/single-backup.md) docs).\n\n## GMail\n\nTo use imap-backup with GMail, Office 365 and other services that require\nOAuth2 authentication, you can use [email-oauth2-proxy](https://github.com/simonrob/email-oauth2-proxy).\nSee [this blog post about using imap-backup with email-oauth2-proxy](https://joeyates.info/posts/back-up-gmail-accounts-with-imap-backup-using-email-oauth2-proxy/).\n\n# Backup\n\nManually, from the command line:\n\n```sh\nimap-backup\n```\n\nAlternatively, add it to your crontab.\n\nBackups can also be inspected, for example via [`local show`](/docs/commands/local-show.md)\nand exported via [`utils export-to-thunderbird`](/docs/commands/utils-export-to-thunderbird.md).\n\n# Commands\n\n* [`backup`](/docs/commands/backup.md)\n* [`copy`](/docs/commands/copy.md)\n* [`local accounts`](/docs/commands/local-accounts.md)\n* [`local check`](/docs/commands/local-check.md)\n* [`local folders`](/docs/commands/local-folders.md)\n* [`local list`](/docs/commands/local-list.md)\n* [`local show`](/docs/commands/local-show.md)\n* [`remote folders`](/docs/commands/remote-folders.md)\n* [`restore`](/docs/commands/restore.md)\n* [`setup`](/docs/commands/setup.md)\n* [`single backup`](/docs/commands/single-backup.md)\n* [`utils export-to-thunderbird`](/docs/commands/utils-export-to-thunderbird.md)\n* [`utils ignore-history`](/docs/commands/utils-ignore-history.md)\n\nFor a full list of available commands, run\n\n```sh\nimap-backup help\n```\n\nFor more information about a command, run\n\n```sh\nimap-backup help COMMAND\n```\n\n# Performance\n\nThere are a couple of performance tweaks that you can use\nto improve backup speed.\n\nThese are activated via two settings:\n\n* Global setting \"Delay download writes\",\n* Account setting \"Multi-fetch size\".\n\nSee [the performance document](/docs/performance.md) for more information.\n\n# Troubleshooting\n\nIf you have problems:\n\n1. ensure that you have the latest release,\n2. run `imap-backup` with the `-v` or `--verbose` parameter.\n\n# Development\n\nSee the [Developer Documentation].\n\n[Developer Documentation]: https://rubydoc.info/gems/imap-backup \"Developer Documentation at Rubydoc.info\"\n[GitHub Stars]: https://github.com/joeyates/imap-backup/stargazers \"GitHub Stars\"\n[CI Status]: https://github.com/joeyates/imap-backup/actions/workflows/main.yml\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoeyates%2Fimap-backup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoeyates%2Fimap-backup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoeyates%2Fimap-backup/lists"}