{"id":13419921,"url":"https://github.com/astroidmail/astroid","last_synced_at":"2025-03-15T06:30:53.788Z","repository":{"id":14619767,"uuid":"17337103","full_name":"astroidmail/astroid","owner":"astroidmail","description":"A graphical threads-with-tags style, lightweight and fast, e-mail client for Notmuch","archived":false,"fork":false,"pushed_at":"2024-06-29T17:43:33.000Z","size":15105,"stargazers_count":610,"open_issues_count":140,"forks_count":65,"subscribers_count":23,"default_branch":"master","last_synced_at":"2024-07-31T22:52:43.310Z","etag":null,"topics":["astroidmail","astroids","c-plus-plus","email","gpg","gui","keyboard-navigation","lightweight","mail","mua","notmuch"],"latest_commit_sha":null,"homepage":"http://astroidmail.github.io","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/astroidmail.png","metadata":{"files":{"readme":"README.md","changelog":"History.txt","contributing":null,"funding":".github/FUNDING.yml","license":"COPYING.GPL-3.0+","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},"funding":{"github":"gauteh","custom":["https://www.paypal.me/gauteh"]}},"created_at":"2014-03-02T12:19:14.000Z","updated_at":"2024-07-29T10:31:38.000Z","dependencies_parsed_at":"2024-05-21T08:30:28.499Z","dependency_job_id":"047b3018-9bfb-4087-b980-263e478cb2c8","html_url":"https://github.com/astroidmail/astroid","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/astroidmail%2Fastroid","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/astroidmail%2Fastroid/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/astroidmail%2Fastroid/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/astroidmail%2Fastroid/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/astroidmail","download_url":"https://codeload.github.com/astroidmail/astroid/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221548141,"owners_count":16840979,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["astroidmail","astroids","c-plus-plus","email","gpg","gui","keyboard-navigation","lightweight","mail","mua","notmuch"],"created_at":"2024-07-30T22:01:22.860Z","updated_at":"2024-10-26T15:30:58.472Z","avatar_url":"https://github.com/astroidmail.png","language":"C++","funding_links":["https://github.com/sponsors/gauteh","https://www.paypal.me/gauteh"],"categories":["TODO scan for Android support in followings","C++"],"sub_categories":[],"readme":"\u003cimg src=\"https://github.com/astroidmail/astroid/raw/master/ui/icons/horizontal_color.png\" width=\"400px\" alt=\"astroid logo\" /\u003e\n\n\u003e _Astroid_ is a lightweight and fast **Mail User Agent** that provides a graphical interface to searching, displaying and composing email, organized in threads and tags. _Astroid_ uses the [notmuch](http://notmuchmail.org/) backend for blazingly fast searches through tons of email. _Astroid_ searches, displays and composes emails - and rely on other programs for fetching, syncing and sending email. Check out [Astroid in your general mail setup](https://github.com/astroidmail/astroid/wiki/Astroid-in-your-general-mail-setup) for a suggested complete e-mail solution.\n\nThe [tour of how to install, configure and use astroid](https://github.com/astroidmail/astroid/wiki) provides detailed information on setup and usage, while brief instructions are provided [below](#acquiring-astroid).\n\n## Main features\n* lightweight and fast!\n* fully operable by [keyboard](https://github.com/astroidmail/astroid/wiki/Customizing-key-bindings).\n* graphical interface. buffers can be placed in separate windows.\n* display html mail and common attachments inline.\n* [themable and configurable](https://github.com/astroidmail/astroid/wiki/Customizing-the-user-interface).\n* built-in [crypto (PGP/MIME) support](https://github.com/astroidmail/astroid/wiki/Signing%2C-Encrypting-and-Decrypting).\n* editors: [embedded or external vim or emacs](https://github.com/astroidmail/astroid/wiki/Customizing-editor) (or your favourite editor).\n* [syntax highlighting](https://github.com/astroidmail/astroid-syntax-highlight) of patches and code segments.\n* [python and lua plugins](https://github.com/astroidmail/astroid/wiki/Plugins).\n* and much more...\n\n  \u003ca href=\"https://raw.githubusercontent.com/astroidmail/astroid/master/doc/full-demo-embedded.png\"\u003e\n    \u003cimg alt=\"Astroid (with embedded editor)\" src=\"https://raw.githubusercontent.com/astroidmail/astroid/master/doc/full-demo-embedded.png\"\u003e\n  \u003c/a\u003e\n\n## Acquiring astroid\n\nGet astroid through git by:\n\n```sh\n$ git clone https://github.com/astroidmail/astroid.git\n```\n\n## Installation and Usage\n\n### Building\n\n```sh\n$ cd astroid\n$ cmake -H. -Bbuild -GNinja # to use the ninja backend\n$ cmake --build build\n```\n\nRun `cmake -DOPTION=VALUE ..` from `build/` to set any build options (list with `cmake -L`). Subsequent builds can be done by running `ninja` (or `make` if you are using that) from the build directory.\n\nAnd to run the tests do:\n\n```sh\n$ cd build\n$ ctest\n```\n\n### Installing\n\nConfigure with a prefix and install:\n```sh\n$ cmake -H. -Bbuild -GNinja -DCMAKE_INSTALL_PREFIX=/usr/local\n$ cmake --build build --target install\n```\n\nThis will install the `astroid` binary into `/usr/local/bin/`, and data files into `/usr/local/share/astroid/`. Refer to the [installing section](https://github.com/astroidmail/astroid/wiki/Compiling-and-Installing) in the wiki for more information.\n\n### Configuration\n\nThe configuration of `astroid` is kept in the directory `$XDG_CONFIG_HOME/astroid` (normally: `~/.config/astroid/`). Refer to the [configuration section](https://github.com/astroidmail/astroid/wiki/Astroid-setup) in the wiki for how to configure astroid. You can use `astroid --new-config` to create a configuration file filled with the default values. If no file exists, the [default values](https://github.com/astroidmail/astroid/blob/master/src/config.cc#L116) are used.\n\n### Execution and Usage\n\n```sh\n$ ./build/astroid # to run from source repository\n```\n\nPress `?` to get a list of available key bindings in the current mode, navigate up and down using `j` and `k`. Refer to the [usage section](https://github.com/astroidmail/astroid/wiki#usage) in the wiki for more information on usage and customization.\n\n## Patches, Help, Comments and Bugs\n\nReport on the [github page](https://github.com/astroidmail/astroid) or to the mailinglist at: [astroidmail@googlegroups.com](https://groups.google.com/forum/#!forum/astroidmail), subscribe [online](https://groups.google.com/forum/#!forum/astroidmail) or by sending an email to:\n[astroidmail+subscribe@googlegroups.com](mailto:astroidmail+subscribe@googlegroups.com).\n\nContributions to Astroid in the form of patches, documentation and testing are\nvery welcome. Information on how to\n[contribute](https://github.com/astroidmail/astroid/wiki/Contributing) to astroid\ncan be found in the wiki.\n\nYou can usually find us at \u003ca href=\"irc://irc.freenode.net/#astroid\"\u003e#astroid\u003c/a\u003e ([web](https://webchat.freenode.net/?channels=#astroid)) or \u003ca href=\"irc://irc.freenode.net/#notmuch\"\u003e#notmuch\u003c/a\u003e ([web](https://webchat.freenode.net/?channels=#notmuch)) at irc.freenode.net.\n\nThis project adheres to [Contributor Covenant Code of Conduct v1.4](http://contributor-covenant.org/version/1/4/).\n\n## Acknowledgements\n\n  The main inspiration for astroid is the [sup] mail user agent. [sup]\n  provided inspiration for [notmuch] which is a mail indexer. astroid is\n  using [notmuch] as a backend.\n\n  Some parts of the user interface and layout has been\n  inspired by the [Geary] mail client. Also, some inspiration and code stems from ner (another notmuch email client).\n\n## License\n\nSee [LICENSE.md](./LICENSE.md) for licensing information.\n\n[sup]: http://sup-heliotrope.github.io\n[notmuch]: http://notmuchmail.org/\n[Geary]: http://www.yorba.org/projects/geary/\n[gmime]: http://spruce.sourceforge.net/gmime/\n[webkit]: http://webkitgtk.org/\n[GPL]: https://www.gnu.org/copyleft/gpl.html\n[git]: http://git-scm.com/\n[C++11]: http://en.wikipedia.org/wiki/C%2B%2B11\n[boost]: http://www.boost.org/\n[GTK+]: http://www.gtk.org/\n[glib]: https://developer.gnome.org/glib/\n[boost::property_tree]: http://www.boost.org/doc/libs/1_56_0/doc/html/property_tree.html\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fastroidmail%2Fastroid","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fastroidmail%2Fastroid","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fastroidmail%2Fastroid/lists"}