purebred: An mail user agent built around notmuch

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

An MUA built around notmuch. Mutt-inspired console interface, but embracing the notmuch storage / search paradigm.

Requirements

GHC >= 8.8
notmuch
a local mailer (e.g. sendmail)

Status

The project is in development and is not ready for serious use. Contributions are welcome (bug reports, feedback, doc, code, etc). See HACKING for more info.

[Skip to Readme]

Properties

Versions	2022.1
Change log	None available
Dependencies	attoparsec, base (>=4.13 && <5), brick (>=1.0 && <1.3), bytestring, case-insensitive, containers, deepseq (>=1.4.2), directory (>=1.2.5.0), dyre (>=0.9.1), exceptions, filepath, lens, mime-types, mtl, notmuch (>=0.3.1 && <0.4), optparse-applicative (>=0.13), purebred, purebred-email (>=0.5 && <0.7), random (>=1.2.0), stm (>=2.4), stm-delay (>=0.1), temporary, text, text-zipper, time (>=1.8), typed-process (>=0.2.8.0), vector (>=0.12.0.0), vty, word-wrap [details]
License	AGPL-3.0-or-later
Copyright	2017-2022 Purebred contributors
Author	Róman Joost & Fraser Tweedale
Maintainer	frase@frase.id.au
Category	Email
Home page	https://github.com/purebred-mua/purebred#readme
Source repo	head: git clone https://github.com/purebred-mua/purebred.git
Uploaded	by frasertweedale at 2022-09-28T05:45:05Z

Modules

Data
- Text
  - Data.Text.Markup
Purebred
- Brick
  - Purebred.Brick.Markup
- Purebred.Config
- Purebred.Plugin
  - Purebred.Plugin.TweakConfig
- Storage
  - Purebred.Storage.Mail
  - Purebred.Storage.Tags
- Purebred.System
  - Purebred.System.Logging
  - Purebred.System.Process
- Purebred.Types
  - Purebred.Types.Display
  - Purebred.Types.Error
  - Purebred.Types.Event
  - Purebred.Types.LazyVector
  - Purebred.Types.Mailcap
  - Parser
    - Purebred.Types.Parser.ByteString
    - Purebred.Types.Parser.Text
  - Purebred.Types.UI
- UI
  - Purebred.UI.Actions
  - Purebred.UI.App
  - ComposeEditor
    - Purebred.UI.ComposeEditor.Keybindings
    - Purebred.UI.ComposeEditor.Main
  - Draw
    - Purebred.UI.Draw.Main
  - FileBrowser
    - Purebred.UI.FileBrowser.Keybindings
    - Purebred.UI.FileBrowser.Main
  - GatherHeaders
    - Purebred.UI.GatherHeaders.Keybindings
  - Help
    - Purebred.UI.Help.Keybindings
    - Purebred.UI.Help.Main
  - Index
    - Purebred.UI.Index.Keybindings
    - Purebred.UI.Index.Main
  - Purebred.UI.Keybindings
  - Mail
    - Purebred.UI.Mail.Keybindings
    - Purebred.UI.Mail.Main
  - Purebred.UI.Notifications
  - Status
    - Purebred.UI.Status.Main
  - Purebred.UI.Utils
  - Purebred.UI.Validation
  - Purebred.UI.Views
  - Purebred.UI.Widgets
- Purebred.Version

Flags

Automatic Flags

Name	Description	Default
with_lazyvector	Enables lazy loading of the thread listing (see issue #284 before enabling).	Disabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

purebred-2022.1.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

frasertweedale, romanofski

For package maintainers and hackage trustees

edit package information

Readme for purebred-2022.1

[back to package description]

purebred

An MUA built around notmuch.

Requirements

GHC >= 8.8
notmuch
a local mailer (e.g. sendmail)

Status

This project is immature, but please join us and help. We welcome all kinds of contributions (bug reports, testing, documentation, code). See HACKING for more info. If you want to jump right in, have a look at the easy fix issues.

Roadmap

In no particular order, planned features include:

Plugin interface for processing mail before presentation. This will enable encrypted mail (OpenPGP, S/MIME) plugins, among other things.
Address book support.
Improved mailcap support.
Rendering and UI improvements.

Try it

Try out purebred with the following choices. Note well: apart from cabal-install, none of the other options are tested by our CI and may be broken, or out of date.

Fedora

We operate a Fedora Copr repository which provides easily installable RPM packages.

Nix

If you're using the nix package manager - whether on NixOS or any other Linux distribution - you can build purebred too. You can use try out purebred without installing it:

$ nix build && result/bin/purebred

and nix profile install to install the application:

$ nix profile install .#purebred-with-packages

There is also a default.nix file to be used with legacy nix.

Arch Linux

We officially don't support Arch Linux, but will support any packaging efforts. Please see #352 for links to help building Purebred.

Cabal

Install development packages for system library dependencies first. They are needed to compile the Haskell notmuch bindings. Note that package names vary among distributions.

libtalloc-devel
notmuch-devel

Make sure you have one of our supported GHC versions and cabal-install >= 2.4 installed. From a cloned checkout:

# Update the package list needed for cabal to download dependencies
$ cabal v2-update

# Builds all dependencies, the purebred library and executable and
# installs it to ~/.cabal/bin
$ cabal v2-build
Resolving dependencies...
Build profile: ...
In order, the following will be built (use -v for more details):
 - ...
 - ...
$ cabal v2-install exe:purebred

# start purebred
$ ~/.cabal/bin/purebred