README

   1 msgthr - container-agnostic, non-recursive message threading
   2 ------------------------------------------------------------
   3
   4 Pure Ruby message threading based on the algorithm described by
   5 JWZ in <https://www.jwz.org/doc/threading.html> and used in
   6 countless mail and news readers; but with some features removed
   7 and improved flexibility:
   8
   9 * Message format-agnostic, not limited to email or NNTP;
  10   but even appropriate for forums, blog comments, IM, etc.
  11   For mail and NNTP messages, that means you must extract
  12   the Message-ID and parse the References and In-Reply-To
  13   headers into an array yourself.
  14
  15 * No recursion; all algorithms are non-recursive to avoid
  16   SystemStackError exceptions in deep message threads.
  17   Memory usage is bound by the number of lightweight containers
  18   needed to represent a thread.
  19
  20 * No pruning of non-leaf ghosts.  Readers are not shielded
  21   from deleted or lost messages.  Equivalent to setting
  22   "hide_missing" to "no" in mutt.
  23
  24 * No grouping by subject[1].  This makes things ideal for short
  25   messages such as chat and status updates.  For email, this
  26   encourages the use of proper client which set In-Reply-To
  27   or References headers.  Equivalent to setting "strict_threads"
  28   to "yes" in mutt.
  29
  30   [1] - Instead, messages with the same Subject can be grouped
  31         by a search engine.  For email, this would be done using
  32         a mail search engine like notmuch or mairix.
  33
  34 Source code
  35 -----------
  36
  37 Our Ruby 1.9.3+ compatible code is available via git,
  38 no C compiler or other dependencies are required:
  39
  40         git clone git://80x24.org/msgthr
  41         git clone https://80x24.org/msgthr.git
  42
  43 Releases may be downloaded via RubyGems:
  44
  45         gem fetch [-v VERSION] msgthr
  46
  47 The code used in this Ruby library was originally derived from
  48 the Mail::Thread module for Perl 5.x:
  49
  50         https://metacpan.org/release/Mail-Thread
  51
  52 Contact
  53 -------
  54
  55 Feedback is welcome via plain-text mail (no HTML, images, etc).
  56 Please send comments, user/dev discussion, patches, bug reports,
  57 and pull requests to the open-to-all mailing list at:
  58
  59         msgthr-public@80x24.org
  60
  61 No subscription will ever be required to post.  Please Cc: all
  62 recipients as subscription will never be necessary.
  63
  64 Mailing list archives are available via HTTPS and NNTP:
  65
  66         https://80x24.org/msgthr-public/
  67         nntp://news.public-inbox.org/inbox.comp.lang.ruby.msgthr
  68
  69 You may optionally subscribe, but will never be required to:
  70
  71         msgthr-public+subscribe@80x24.org
  72
  73 This README is our homepage, we would rather be working on cool
  74 stuff day than worrying about the next browser vulnerability
  75 because CSS/JS/images are all too complicated for us.
  76
  77 RDoc API documentation in simple HTML is available at:
  78
  79         https://80x24.org/msgthr/rdoc/Msgthr.html
  80
  81 Copyright
  82 ---------
  83
  84 Copyright 2016-2017, all contributors (see git repo).
  85 License: GPL-2.0+ <https://www.gnu.org/licenses/gpl-2.0.txt>
  86
  87 msgthr is copyrighted Free Software by all contributors, see logs in
  88 revision control for names and email addresses of all of them.
  89
  90 msgthr is free software; you can redistribute it and/or modify
  91 it under the terms of the GNU General Public License as
  92 published by the Free Software Foundation; either version 2 of
  93 the License, or (at your option) any later version.
  94
  95 msgthr is distributed in the hope that it will be useful, but
  96 WITHOUT ANY WARRANTY; without even the implied warranty of
  97 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  98 GNU General Public License for more details.
  99
 100 You should have received a copy of the GNU General Public
 101 License along with this program; if not, see
 102 https://www.gnu.org/licenses/gpl-2.0.txt