granicus.if.org Git - neomutt/blob - README.md

   1 # This is the NeoMutt Project
   2
   3 [![Stars](https://img.shields.io/github/stars/neomutt/neomutt.svg?style=social&label=Stars)](https://github.com/neomutt/neomutt "Give us a Star")
   4 [![Twitter](https://img.shields.io/twitter/follow/NeoMutt_Org.svg?style=social&label=Follow)](https://twitter.com/NeoMutt_Org "Follow us on Twitter")
   5 [![Contributors](https://img.shields.io/badge/Contributors-168-orange.svg)](https://github.com/neomutt/neomutt/blob/master/AUTHORS.md "All of NeoMutt's Contributors")
   6 [![Release](https://img.shields.io/github/release/neomutt/neomutt.svg)](https://github.com/neomutt/neomutt/releases/latest "Latest Release Notes")
   7 [![License: GPL v2](https://img.shields.io/badge/License-GPL%20v2-blue.svg)](https://github.com/neomutt/neomutt/blob/master/COPYRIGHT.md "Copyright Statement")
   8 [![Code build](https://img.shields.io/travis/neomutt/neomutt.svg?label=code)](https://travis-ci.org/neomutt/neomutt "Latest Automatic Code Build")
   9 [![Coverity Scan](https://img.shields.io/coverity/scan/8495.svg)](https://scan.coverity.com/projects/neomutt-neomutt "Latest Code Static Analysis")
  10 [![Website build](https://img.shields.io/travis/neomutt/neomutt.github.io.svg?label=website)](https://travis-ci.org/neomutt/neomutt.github.io "Latest Website Test")
  11
  12 ## What is NeoMutt?
  13
  14 * NeoMutt is a project of projects.
  15 * A place to gather all the patches against Mutt.
  16 * A place for all the developers to gather.
  17
  18 Hopefully this will build the community and reduce duplicated effort.
  19
  20 NeoMutt was created when Richard Russon (@FlatCap) took all the old Mutt patches,
  21 sorted through them, fixed them up and documented them.
  22
  23 ## What Features does NeoMutt have?
  24
  25 | Name                 | Description
  26 | -------------------- | ------------------------------------------------------
  27 | Attach Headers Color | Color attachment headers using regex, just like mail bodies
  28 | Compose to Sender    | Send new mail to the sender of the current mail
  29 | Compressed Folders   | Read from/write to compressed mailboxes
  30 | Conditional Dates    | Use rules to choose date format
  31 | Encrypt-to-Self      | Save a self-encrypted copy of emails
  32 | Fmemopen             | Replace some temporary files with memory buffers
  33 | Forgotten Attachment | Alert user when (s)he forgets to attach a file to an outgoing email.
  34 | Global Hooks         | Define actions to run globally within NeoMutt
  35 | Ifdef                | Conditional config options
  36 | Index Color          | Custom rules for theming the email index
  37 | Initials Expando     | Expando for author's initials
  38 | Kyoto Cabinet        | Kyoto Cabinet backend for the header cache
  39 | Limit Current Thread | Focus on one Email Thread
  40 | LMDB                 | LMDB backend for the header cache
  41 | Multiple FCC         | Save multiple copies of outgoing mail
  42 | Nested If            | Allow complex nested conditions in format strings
  43 | New Mail             | Execute a command upon the receipt of new mail.
  44 | NNTP                 | Talk to a Usenet news server
  45 | Notmuch              | Email search engine
  46 | Progress Bar         | Show a visual progress bar on slow operations
  47 | Quasi-Delete         | Mark emails that should be hidden, but not deleted
  48 | Reply With X-Orig-To | Direct reply to email using X-Original-To header
  49 | Sensible Browser     | Make the file browser behave
  50 | Sidebar              | Panel containing list of Mailboxes
  51 | Skip Quoted          | Leave some context visible
  52 | Status Color         | Custom rules for theming the status bar
  53 | TLS-SNI              | Negotiate with a server for a TLS/SSL certificate
  54 | Trash Folder         | Automatically move deleted emails to a trash bin
  55
  56 ## Contributed Scripts and Config
  57
  58 | Name                   | Description
  59 | ---------------------- | ---------------------------------------------
  60 | Header Cache Benchmark | Script to test the speed of the header cache
  61 | Keybase                | Keybase Integration
  62 | Useful programs        | List of useful programs interacting with NeoMutt
  63 | Vi Keys                | Easy and clean Vi-keys for NeoMutt
  64 | Vim Syntax             | Vim Syntax File
  65
  66 ## How to Install NeoMutt?
  67
  68 NeoMutt may be packaged for your distribution, and otherwise it can be built from
  69 source. Please refer to the instructions on the
  70 [distro page](https://neomutt.org/distro.html).
  71
  72 ## Where is NeoMutt?
  73
  74 - Source Code:     https://github.com/neomutt/neomutt
  75 - Releases:        https://github.com/neomutt/neomutt/releases/latest
  76 - Questions/Bugs:  https://github.com/neomutt/neomutt/issues
  77 - Website:         https://neomutt.org
  78 - IRC:             [irc://irc.freenode.net/neomutt](https://webchat.freenode.net/ "IRC Web Client") - please be patient.
  79   We're a small group, so our answer might take some time.
  80 - Mailinglists:    [neomutt-users](mailto:neomutt-users-request@neomutt.org?subject=subscribe)
  81   and [neomutt-devel](mailto:neomutt-devel-request@neomutt.org?subject=subscribe)
  82 - Development:     https://neomutt.org/dev.html
  83 - Contributors:    [Everyone who has helped NeoMutt](AUTHORS.md)
  84
  85 ### Mutt
  86
  87 While NeoMutt is technically a fork of Mutt, the intention of the project is not to
  88 diverge from Mutt, but rather to act as a common ground for developers to improve Mutt.
  89
  90 Collecting, sorting out and polishing patches to be incorporated upstream (into Mutt),
  91 as well as being a place to gather and encourage further collaboration while reducing
  92 redundant work, are among the main goals of NeoMutt. NeoMutt merges all changes from Mutt.
  93
  94 More information is available on the [About](https://neomutt.org/about.html) page on
  95 the NeoMutt website.
  96
  97 Mutt was created by **Michael Elkins** and is now maintained by **Kevin McCarthy**.
  98
  99 https://neomutt.org/guide/miscellany.html#acknowledgements
 100