sup 0.22.1 → 1.1

data/man/sup-sync.1

@@ -1,106 +1,84 @@
-.TH "SUP\-SYNC" "1" "April 9, 2012" "Sup User Manual" ""
+.\" Automatically generated by Pandoc 2.9.2.1
+.\"
+.TH "SUP-SYNC" "1" "April 9, 2012" "Sup User Manual" ""
+.hy
 .SH NAME
 .PP
-sup\-sync \- sychronize the Sup index with message sources
+sup-sync - sychronize the Sup index with message sources
 .SH SYNOPSIS
 .PP
-sup\-sync [\f[I]options\f[]] source ...
+sup-sync [\f[I]options\f[R]] source \&...
 .SH DESCRIPTION
 .PP
 Synchronizes the Sup index with one or more message sources by adding
 messages, deleting messages, or changing message state in the index as
 appropriate.
 .PP
-"Message state" means read/unread, archived/inbox, starred/unstarred,
-and all user\-defined labels on each message.
+\[lq]Message state\[rq] means read/unread, archived/inbox,
+starred/unstarred, and all user-defined labels on each message.
 .PP
-"Default source state" refers to any state that a source itself has
-keeps about a message.
-Sup\-sync uses this information when adding a new message to the index.
+\[lq]Default source state\[rq] refers to any state that a source itself
+has keeps about a message.
+Sup-sync uses this information when adding a new message to the index.
 The source state is typically limited to read/unread, archived/inbox
 status and a single label based on the source name.
-Messages using the default source state are placed in the inbox (i.e.
-not archived) and unstarred.
+Messages using the default source state are placed in the inbox
+(i.e.\ not archived) and unstarred.
 .PP
 If no sources are given, sync from all usual sources.
-Supported source URI schemes can be seen by running "sup\-add \-\-help".
+Supported source URI schemes can be seen by running \[lq]sup-add
+--help\[rq].
 .SH MESSAGE STATE OPTIONS
 .TP
-.B \-\-asis
+--asis
 If the message is already in the index, preserve its state.
 Otherwise, use default source state (default)
-.RS
-.RE
 .TP
-.B \-\-restore dumpfile
-Restore message state from a dump file created with sup\-dump.
-If a message is not in this dumpfile, act as \-\-asis
-.RS
-.RE
+--restore dumpfile
+Restore message state from a dump file created with sup-dump.
+If a message is not in this dumpfile, act as --asis
 .TP
-.B \-\-discard
+--discard
 Discard any message state in the index and use the default source state.
-\f[B]Dangerous!\f[]
-.RS
-.RE
+\f[B]Dangerous!\f[R]
 .TP
-.B \-x, \-
+-x, -
 When using the default source state, mark messages as archived.
-.RS
-.RE
 .TP
-.B \-r, \-\-read
+-r, --read
 When using the default source state, mark messages as read.
-.RS
-.RE
 .TP
-.B \-\-extra\-labels \f[I]STRING\f[]
-When using the default source state, also apply these user\-defined
-labels (a comma\-separated list) (default)
-.RS
-.RE
+--extra-labels \f[I]STRING\f[R]
+When using the default source state, also apply these user-defined
+labels (a comma-separated list) (default)
 .SH OTHER OPTIONS
 .TP
-.B \-v, \-\-verbose
-Print message ids as they\[aq]re processed.
-.RS
-.RE
+-v, --verbose
+Print message ids as they\[cq]re processed.
 .TP
-.B \-o, \-\-optimize
+-o, --optimize
 As the final operation, optimize the index.
-.RS
-.RE
 .TP
-.B \-\-all\-sources
+--all-sources
 Scan over all sources.
-.RS
-.RE
 .TP
-.B \-n, \-\-dry\-run
-Don\[aq]t actually modify the index.
-Probably only useful with \-\-verbose.
-.RS
-.RE
+-n, --dry-run
+Don\[cq]t actually modify the index.
+Probably only useful with --verbose.
 .TP
-.B \-\-version
+--version
 Show version information
-.RS
-.RE
 .TP
-.B \-h, \-\-help
+-h, --help
 Show help message
-.RS
-.RE
 .SH FILES
 .TP
-.B $HOME/.sup/sources.yaml
+$HOME/.sup/sources.yaml
 Configuration file for Sup mail sources
-.RS
-.RE
 .SH SEE ALSO
 .PP
-sup(1), sup\-add(1), sup\-config(1), sup\-dump(1),
-sup\-sync\-back\-maildir(1), sup\-tweak\-labels(1)
+sup(1), sup-add(1), sup-config(1), sup-dump(1),
+sup-sync-back-maildir(1), sup-tweak-labels(1)
 .SH REPORTING BUGS
 .PP
 You are welcome to submit bug reports to the Sup issue tracker, located
@@ -109,39 +87,31 @@ at
 <https://github.com/sup-heliotrope/sup/issues>
 .SH CONTACT INFORMATION
 .TP
-.B The Sup web page:
-<http://supmua.org/>
-.RS
-.RE
+The Sup web page:
+<https://sup-heliotrope.github.io/>
 .TP
-.B Code repository:
+Code repository:
 <https://github.com/sup-heliotrope/sup/>
-.RS
-.RE
 .TP
-.B Sup Wiki:
+Sup Wiki:
 <https://github.com/sup-heliotrope/sup/wiki/>
-.RS
-.RE
 .TP
-.B Sup IRC channel:
-#sup \@ freenode.net
-.RS
-.RE
+Sup IRC channel:
+#sup \[at] freenode.net
 .TP
-.B Mailing list:
-supmua\@googlegroups.com
+Mailing list:
+supmua\[at]googlegroups.com
 .RS
 .PP
-supmua+subscribe\@googlegroups.com
+supmua+subscribe\[at]googlegroups.com
 .PP
 Archives: <https://groups.google.com/d/forum/supmua/>
 .RE
 .SH COPYRIGHT
 .PP
-Copyright © 2006\-2009 William Morgan <mworgan-sup@masanjin.net>
+Copyright \[co] 2006-2009 William Morgan <mworgan-sup@masanjin.net>
 .PP
-Copyright \@ 2013\-2014 Sup developers
+Copyright \[at] 2013-2014 Sup developers
 .PP
 Permission is granted to copy and distribute this manual under the terms
 of the GNU General Public License; either version 2 or (at your option)

data/man/sup-tweak-labels.1

@@ -1,69 +1,54 @@
-.TH "SUP\-TWEAK\-LABELS" "1" "April 9, 2012" "Sup User Manuel" ""
+.\" Automatically generated by Pandoc 2.9.2.1
+.\"
+.TH "SUP-TWEAK-LABELS" "1" "April 9, 2012" "Sup User Manuel" ""
+.hy
 .SH NAME
 .PP
-sup\-tweak\-labels \- batch modification of message state already in
-index
+sup-tweak-labels - batch modification of message state already in index
 .SH SYNOPSIS
 .PP
-sup\-tweak\-labels [\f[I]options\f[]] source ...
+sup-tweak-labels [\f[I]options\f[R]] source \&...
 .SH DESCRIPTION
 .PP
 Batch modification of message state for messages already in the index.
 .PP
-Supported source URI schemes can be seen by running "sup\-add \-\-help".
+Supported source URI schemes can be seen by running \[lq]sup-add
+--help\[rq].
 .SH OPTIONS
 .TP
-.B \-a \f[I]STRING\f[], \-\-add \f[I]STRING\f[]
-One or more labels (comma\-separated) to add to every message from the
+-a \f[I]STRING\f[R], --add \f[I]STRING\f[R]
+One or more labels (comma-separated) to add to every message from the
 specified sources (default: )
-.RS
-.RE
 .TP
-.B \-r \f[I]STRING\f[], \-\-remove \f[I]STRING\f[]
-One or more labels (comma\-separated) to remove from every message from
+-r \f[I]STRING\f[R], --remove \f[I]STRING\f[R]
+One or more labels (comma-separated) to remove from every message from
 the specified sources, if those labels are present (default: )
-.RS
-.RE
 .TP
-.B \-q \f[I]QUERY\f[], \-\-query \f[I]QUERY\f[]
+-q \f[I]QUERY\f[R], --query \f[I]QUERY\f[R]
 A Sup search query
-.RS
-.RE
 .SH OTHER OPTIONS
 .TP
-.B \-v, \-\-verbose
-Print message ids as they\[aq]re processed
-.RS
-.RE
+-v, --verbose
+Print message ids as they\[cq]re processed
 .TP
-.B \-e, \-\-very\-verbose
-Print message names and subjects as they\[aq]re processed
-.RS
-.RE
+-e, --very-verbose
+Print message names and subjects as they\[cq]re processed
 .TP
-.B \-\-all\-sources
+--all-sources
 Scan over all sources
-.RS
-.RE
 .TP
-.B \-n, \-\-dry\-run
-Don\[aq]t actually modify the index.
-Probably only useful with \-\-verbose
-.RS
-.RE
+-n, --dry-run
+Don\[cq]t actually modify the index.
+Probably only useful with --verbose
 .TP
-.B \-\-version
+--version
 Show version information
-.RS
-.RE
 .TP
-.B \-h, \-\-help
+-h, --help
 Show help message
-.RS
-.RE
 .SH SEE ALSO
 .PP
-sup(1), sup\-add(1)
+sup(1), sup-add(1)
 .SH REPORTING BUGS
 .PP
 You are welcome to submit bug reports to the Sup issue tracker, located
@@ -72,39 +57,31 @@ at
 <https://github.com/sup-heliotrope/sup/issues>
 .SH CONTACT INFORMATION
 .TP
-.B The Sup web page:
-<http://supmua.org/>
-.RS
-.RE
+The Sup web page:
+<https://sup-heliotrope.github.io/>
 .TP
-.B Code repository:
+Code repository:
 <https://github.com/sup-heliotrope/sup/>
-.RS
-.RE
 .TP
-.B Sup Wiki:
+Sup Wiki:
 <https://github.com/sup-heliotrope/sup/wiki/>
-.RS
-.RE
 .TP
-.B Sup IRC channel:
-#sup \@ freenode.net
-.RS
-.RE
+Sup IRC channel:
+#sup \[at] freenode.net
 .TP
-.B Mailing list:
-supmua\@googlegroups.com
+Mailing list:
+supmua\[at]googlegroups.com
 .RS
 .PP
-supmua+subscribe\@googlegroups.com
+supmua+subscribe\[at]googlegroups.com
 .PP
 Archives: <https://groups.google.com/d/forum/supmua/>
 .RE
 .SH COPYRIGHT
 .PP
-Copyright © 2006\-2009 William Morgan <mworgan-sup@masanjin.net>
+Copyright \[co] 2006-2009 William Morgan <mworgan-sup@masanjin.net>
 .PP
-Copyright \@ 2013\-2014 Sup developers
+Copyright \[at] 2013-2014 Sup developers
 .PP
 Permission is granted to copy and distribute this manual under the terms
 of the GNU General Public License; either version 2 or (at your option)

data/man/sup.1

@@ -1,85 +1,81 @@
+.\" Automatically generated by Pandoc 2.9.2.1
+.\"
 .TH "SUP" "1" "April 8, 2014" "Sup User Manual" ""
+.hy
 .SH NAME
 .PP
-sup \- a curses\-based email client
+sup - a curses-based email client
 .SH SYNOPSIS
 .PP
-sup [\f[I]options\f[]]
+sup [\f[I]options\f[R]]
 .SH DESCRIPTION
 .PP
-Sup is a console\-based email client for people with a lot of email.
+Sup is a console-based email client for people with a lot of email.
 .PP
 It presents an interface of a list of threads, which are each
 hierarchical collections email messages.
 Threads can have multiple tags applied to them.
-It supports a very fast full\-text search, automatic contact\-list
+It supports a very fast full-text search, automatic contact-list
 management, custom code insertion via a Ruby hook system, and more.
-If you're the type of person who treats email as an extension of your
-long\-term memory, Sup is for you.
+If you\[cq]re the type of person who treats email as an extension of
+your long-term memory, Sup is for you.
 .SH OPTIONS
 .TP
-.B \-l, \-\-list\-hooks
+-l, --list-hooks
 List all hooks and descriptions, and quit.
-.RS
-.RE
+Use \[en]hooks-matching to filter
+.TP
+-m, --hooks-matching=<s>
+If given, list all hooks and descriptions matching the given pattern.
+Needs the \[en]list-hooks option (default: )
 .TP
-.B \-n, \-\-no\-threads
+-n, --no-threads
 Turn off threading.
 Helps with debugging.
 (Necessarily disables background polling for new messages.)
-.RS
-.RE
 .TP
-.B \-o, \-\-no\-initial\-poll
-Don\[aq]t poll for new messages when starting.
-.RS
-.RE
+-o, --no-initial-poll
+Don\[cq]t poll for new messages when starting.
 .TP
-.B \-s \f[I]QUERY\f[], \-\-search \f[I]QUERY\f[]
+-s \f[I]QUERY\f[R], --search \f[I]QUERY\f[R]
 Search for this query upon startup
-.RS
-.RE
 .TP
-.B \-c \f[I]STRING\f[], \-\-compose \f[I]STRING\f[]
+-c \f[I]STRING\f[R], --compose \f[I]STRING\f[R]
 Compose message to this recipient upon startup
-.RS
-.RE
 .TP
-.B \-j \f[I]STRING\f[], \-\-subject \f[I]STRING\f[]
+-j \f[I]STRING\f[R], --subject \f[I]STRING\f[R]
 When composing, use this subject
-.RS
-.RE
 .TP
-.B \-v, \-\-version
+-v, --version
 Print version and exit
-.RS
-.RE
 .TP
-.B \-h, \-\-help
+-h, --help
 Show brief help message
-.RS
-.RE
+.SH ENVIRONMENT
+.TP
+SUP_LOG_LEVEL
+Set log level verbosity.
+Valid values ordered by decresing verbosity: debug info warn error.
+Default log level is info.
+.TP
+SUP_BASE\[rs]
+Specify home directory for configuration files and xapian index,
+defaults to: $HOME/.sup.
 .SH FILES
 .TP
-.B $HOME/.sup/config.yaml
+$HOME/.sup/config.yaml
 Configuration file for Sup
-.RS
-.RE
 .TP
-.B $HOME/.sup/sources.yaml
+$HOME/.sup/sources.yaml
 Configuration file for Sup mail sources
-.RS
-.RE
 .TP
-.B $HOME/.sup/colors.yaml
+$HOME/.sup/colors.yaml
 Color theme for Sup
-.RS
-.RE
 .SH SEE ALSO
 .PP
-mail(1), sup\-add(1), sup\-config(1), sup\-dump(1),
-sup\-import\-dump(1), sup\-recover\-sources(1), sup\-sync(1),
-sup\-sync\-back\-maildir(1), sup\-tweak\-labels(1)
+mail(1), sup-add(1), sup-config(1), sup-dump(1), sup-import-dump(1),
+sup-recover-sources(1), sup-sync(1), sup-sync-back-maildir(1),
+sup-tweak-labels(1)
 .SH REPORTING BUGS
 .PP
 You are welcome to submit bug reports to the Sup issue tracker, located
@@ -88,39 +84,31 @@ at
 <https://github.com/sup-heliotrope/sup/issues>
 .SH CONTACT INFORMATION
 .TP
-.B The Sup web page:
-<http://supmua.org/>
-.RS
-.RE
+The Sup web page:
+<https://sup-heliotrope.github.io/>
 .TP
-.B Code repository:
+Code repository:
 <https://github.com/sup-heliotrope/sup/>
-.RS
-.RE
 .TP
-.B Sup Wiki:
+Sup Wiki:
 <https://github.com/sup-heliotrope/sup/wiki/>
-.RS
-.RE
 .TP
-.B Sup IRC channel:
-#sup \@ freenode.net
-.RS
-.RE
+Sup IRC channel:
+#sup \[at] freenode.net
 .TP
-.B Mailing list:
-supmua\@googlegroups.com
+Mailing list:
+supmua\[at]googlegroups.com
 .RS
 .PP
-supmua+subscribe\@googlegroups.com
+supmua+subscribe\[at]googlegroups.com
 .PP
 Archives: <https://groups.google.com/d/forum/supmua/>
 .RE
 .SH COPYRIGHT
 .PP
-Copyright © 2006\-2009 William Morgan <mworgan-sup@masanjin.net>
+Copyright \[co] 2006-2009 William Morgan <mworgan-sup@masanjin.net>
 .PP
-Copyright \@ 2013\-2014 Sup developers
+Copyright \[at] 2013-2014 Sup developers
 .PP
 Permission is granted to copy and distribute this manual under the terms
 of the GNU General Public License; either version 2 or (at your option)

data/sup.gemspec

@@ -4,13 +4,13 @@ require 'sup/version'
 
 Gem::Specification.new do |s|
   s.name = "sup"
-  s.version = ENV["REL"] || (::Redwood::VERSION == "git" ? "999" : ::Redwood::VERSION)
+  s.version = ENV["REL"] || (/-git-/ =~ ::Redwood::VERSION ? "999" : ::Redwood::VERSION)
   s.date = Time.now.strftime "%Y-%m-%d"
   s.authors = ["William Morgan", "Gaute Hope", "Hamish Downer", "Matthieu Rakotojaona"]
   s.email   = "supmua@googlegroups.com"
   s.summary = "A console-based email client with the best features of GMail, mutt and Emacs"
-  s.homepage = "http://supmua.org"
-  s.license = 'GPL-2'
+  s.homepage = "https://sup-heliotrope.github.io/"
+  s.license = 'GPL-2.0'
   s.description = <<-DESC
     Sup is a console-based email client for people with a lot of email.
 
@@ -32,7 +32,7 @@ SUP: please note that our old mailing lists have been shut down,
      https://github.com/sup-heliotrope/sup/wiki/Installation%3A-OpenBSD.
   EOF
 
-  s.files         = `git ls-files -z`.split("\x0")
+  s.files         = File.read("Manifest.txt").split
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ["lib"]
@@ -51,20 +51,23 @@ SUP: please note that our old mailing lists have been shut down,
   ## ext/mkrf_conf_xapian.rb and Gemfile.
 
   s.add_runtime_dependency "ncursesw", "~> 1.4.0"
-  s.add_runtime_dependency "rmail-sup", "~> 1.0.1"
+  s.add_runtime_dependency "rmail", ">= 1.1.2", "< 2"
   s.add_runtime_dependency "highline"
-  s.add_runtime_dependency "trollop", ">= 1.12"
+  s.add_runtime_dependency "optimist"
   s.add_runtime_dependency "lockfile"
   s.add_runtime_dependency "mime-types", "> 2.0"
   s.add_runtime_dependency "locale", "~> 2.0"
-  s.add_runtime_dependency "chronic", "~> 0.9.1"
+  s.add_runtime_dependency "chronic"
   s.add_runtime_dependency "unicode", "~> 0.4.4"
+  s.add_runtime_dependency "unicode-display_width"
+  s.add_runtime_dependency "string-scrub" if /^2\.0\./ =~ RUBY_VERSION
 
-  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "bundler", ">= 1.3", "< 3"
   s.add_development_dependency "rake"
-  s.add_development_dependency 'minitest', '~> 5.5.1'
+  s.add_development_dependency 'minitest', '~> 5.5'
   s.add_development_dependency "rr", "~> 1.1"
   s.add_development_dependency "gpgme", ">= 2.0.2"
   s.add_development_dependency "pry"
+  s.add_development_dependency "rubocop-packaging" unless /^2\.[012]\./ =~ RUBY_VERSION
 
 end

data/test/dummy_source.rb

@@ -25,32 +25,38 @@ class DummySource < Source
     return @messages ? @messages.length - 1 : 0
   end
 
-  def load_header offset
-    Source.parse_raw_email_header StringIO.new(raw_header(offset))
+  def with_file_for id
+    fn = @messages[id]
+    File.open(fn, 'rb') { |f| yield f }
   end
 
-  def load_message offset
-    RMail::Parser.read raw_message(offset)
+  def load_header id
+    with_file_for(id) { |f| parse_raw_email_header f }
   end
 
-  def raw_header offset
+  def load_message id
+    with_file_for(id) { |f| RMail::Parser.read f }
+  end
+
+  def raw_header id
     ret = ""
-    f = StringIO.new(@messages[offset])
-    until f.eof? || (l = f.gets) =~ /^$/
-      ret += l
+    with_file_for(id) do |f|
+      until f.eof? || (l = f.gets) =~ /^$/
+        ret += l
+      end
     end
     ret
   end
 
-  def raw_message offset
-    @messages[offset]
+  def raw_message id
+    with_file_for(id) { |f| f.read }
   end
 
-  def each_raw_message_line offset
-    ret = ""
-    f = StringIO.new(@messages[offset])
-    until f.eof?
-      yield f.gets
+  def each_raw_message_line id
+    with_file_for(id) do |f|
+      until f.eof?
+        yield f.gets
+      end
     end
   end
 end

data/test/fixtures/embedded-message.eml

@@ -0,0 +1,34 @@
+Return-Path: <return@example.com>
+From: Sender <sender@example.com>
+To: <recipient@example.invalid>
+Subject: Email with embedded message
+MIME-Version: 1.0
+Content-Type: multipart/mixed; boundary="----------=_4F506AC2.EE281DC4"
+Message-Id: <9181f493-df49-4af5-8ad2-e1a8eb692a98>
+Date: Wed, 15 Jul 2020 19:48:41 +0100
+
+This is a multi-part message in MIME format.
+
+------------=_4F506AC2.EE281DC4
+Content-Type: text/plain; charset=iso-8859-1
+Content-Disposition: inline
+Content-Transfer-Encoding: 8bit
+
+Example outer message.
+Example second line.
+
+
+------------=_4F506AC2.EE281DC4
+Content-Type: message/rfc822; x-spam-type=original
+Content-Transfer-Encoding: 8bit
+
+From: "Embed sender" <embed@example.com>
+To: <rcpt2@example.invalid>
+Subject: Embedded subject line
+Date: Wed, 15 Jul 2020 12:34:56 +0000
+
+Example embedded message.
+Second line.
+
+------------=_4F506AC2.EE281DC4--
+