sup 1.0 → 1.2

data/man/sup-sync-back-maildir.1

@@ -1,15 +1,11 @@
-.\" Automatically generated by Pandoc 2.7.3
+.\" Automatically generated by Pandoc 3.1.9
 .\"
 .TH "SUP-SYNC-BACK-MAILDIR" "1" "August 25, 2014" "Sup User Manual" ""
-.hy
 .SH NAME
-.PP
 sup-sync-back-maildir - Export Xapian entries to Maildir sources on disk
 .SH SYNOPSIS
-.PP
 sup-sync-back-maildir [\f[I]options\f[R]] [\f[I]source uri\&...\f[R]]
 .SH DESCRIPTION
-.PP
 This script parses the Xapian entries for a given Maildir source and
 renames (changes maildir flags) e-mail files on disk according to the
 labels stored in the index.
@@ -35,62 +31,68 @@ sources marked as usual and that have not disabled sync back using the
 configuration parameter sync_back = false in sources.yaml.
 .SH OPTIONS
 .TP
-.B -n, --no-confirm
+-n, --no-confirm
 Don\[cq]t ask for confirmation before synchronizing
 .TP
-.B -m, --no-merge
+-m, --no-merge
 Don\[cq]t merge new supported Maildir flags (R and P)
 .TP
-.B -l, --list-sources
+-l, --list-sources
 List your Maildir sources and exit
 .TP
-.B -u, --unusual-sources-too
+-u, --unusual-sources-too
 Sync unusual sources too if no specific source information is given
 .TP
-.B --version
+--version
 Print version and exit
 .TP
-.B -h, --help
+-h, --help
 Show brief help message
 .SH FILES
 .TP
-.B $HOME/.sup/sources.yaml
+$HOME/.sup/sources.yaml
 Configuration file for Sup mail sources
 .SH SEE ALSO
-.PP
 sup(1), sup-add(1), sup-config(1), sup-dump(1), sup-sync(1),
 sup-tweak-labels(1)
 .SH REPORTING BUGS
-.PP
 You are welcome to submit bug reports to the Sup issue tracker, located
 at
 .PP
-<https://github.com/sup-heliotrope/sup/issues>
+\c
+.UR https://github.com/sup-heliotrope/sup/issues
+.UE \c
 .SH CONTACT INFORMATION
 .TP
-.B The Sup web page:
-<http://supmua.org/>
-.TP
-.B Code repository:
-<https://github.com/sup-heliotrope/sup/>
+The Sup web page:
+\c
+.UR https://sup-heliotrope.github.io/
+.UE \c
 .TP
-.B Sup Wiki:
-<https://github.com/sup-heliotrope/sup/wiki/>
+Code repository:
+\c
+.UR https://github.com/sup-heliotrope/sup/
+.UE \c
 .TP
-.B Sup IRC channel:
-#sup \[at] freenode.net
+Sup Wiki:
+\c
+.UR https://github.com/sup-heliotrope/sup/wiki/
+.UE \c
 .TP
-.B Mailing list:
+Mailing list:
 supmua\[at]googlegroups.com
 .RS
 .PP
 supmua+subscribe\[at]googlegroups.com
 .PP
-Archives: <https://groups.google.com/d/forum/supmua/>
+Archives: \c
+.UR https://groups.google.com/d/forum/supmua/
+.UE \c
 .RE
 .SH COPYRIGHT
-.PP
-Copyright \[co] 2006-2009 William Morgan <mworgan-sup@masanjin.net>
+Copyright © 2006-2009 William Morgan \c
+.MT mworgan-sup@masanjin.net
+.ME \c
 .PP
 Copyright \[at] 2013-2014 Sup developers
 .PP
@@ -98,5 +100,7 @@ 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)
 any later version.
 .SH AUTHORS
-Sup was originally written by William Morgan <wmorgan-sup@masanjin.net>
-and is now developed and maintained by the Sup developers.
+Sup was originally written by William Morgan \c
+.MT wmorgan-sup@masanjin.net
+.ME \c
+\ and is now developed and maintained by the Sup developers.

data/man/sup-sync.1

@@ -1,15 +1,11 @@
-.\" Automatically generated by Pandoc 2.7.3
+.\" Automatically generated by Pandoc 3.1.9
 .\"
 .TH "SUP-SYNC" "1" "April 9, 2012" "Sup User Manual" ""
-.hy
 .SH NAME
-.PP
 sup-sync - sychronize the Sup index with message sources
 .SH SYNOPSIS
-.PP
 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.
@@ -30,86 +26,92 @@ 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)
 .TP
-.B --restore dumpfile
+--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[R]
 .TP
-.B -x, -
+-x, -
 When using the default source state, mark messages as archived.
 .TP
-.B -r, --read
+-r, --read
 When using the default source state, mark messages as read.
 .TP
-.B --extra-labels \f[I]STRING\f[R]
+--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
+-v, --verbose
 Print message ids as they\[cq]re processed.
 .TP
-.B -o, --optimize
+-o, --optimize
 As the final operation, optimize the index.
 .TP
-.B --all-sources
+--all-sources
 Scan over all sources.
 .TP
-.B -n, --dry-run
+-n, --dry-run
 Don\[cq]t actually modify the index.
 Probably only useful with --verbose.
 .TP
-.B --version
+--version
 Show version information
 .TP
-.B -h, --help
+-h, --help
 Show help message
 .SH FILES
 .TP
-.B $HOME/.sup/sources.yaml
+$HOME/.sup/sources.yaml
 Configuration file for Sup mail sources
 .SH SEE ALSO
-.PP
 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
 at
 .PP
-<https://github.com/sup-heliotrope/sup/issues>
+\c
+.UR https://github.com/sup-heliotrope/sup/issues
+.UE \c
 .SH CONTACT INFORMATION
 .TP
-.B The Sup web page:
-<http://supmua.org/>
-.TP
-.B Code repository:
-<https://github.com/sup-heliotrope/sup/>
+The Sup web page:
+\c
+.UR https://sup-heliotrope.github.io/
+.UE \c
 .TP
-.B Sup Wiki:
-<https://github.com/sup-heliotrope/sup/wiki/>
+Code repository:
+\c
+.UR https://github.com/sup-heliotrope/sup/
+.UE \c
 .TP
-.B Sup IRC channel:
-#sup \[at] freenode.net
+Sup Wiki:
+\c
+.UR https://github.com/sup-heliotrope/sup/wiki/
+.UE \c
 .TP
-.B Mailing list:
+Mailing list:
 supmua\[at]googlegroups.com
 .RS
 .PP
 supmua+subscribe\[at]googlegroups.com
 .PP
-Archives: <https://groups.google.com/d/forum/supmua/>
+Archives: \c
+.UR https://groups.google.com/d/forum/supmua/
+.UE \c
 .RE
 .SH COPYRIGHT
-.PP
-Copyright \[co] 2006-2009 William Morgan <mworgan-sup@masanjin.net>
+Copyright © 2006-2009 William Morgan \c
+.MT mworgan-sup@masanjin.net
+.ME \c
 .PP
 Copyright \[at] 2013-2014 Sup developers
 .PP
@@ -117,5 +119,7 @@ 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)
 any later version.
 .SH AUTHORS
-Sup was originally written by William Morgan <wmorgan-sup@masanjin.net>
-and is now developed and maintained by the Sup developers.
+Sup was originally written by William Morgan \c
+.MT wmorgan-sup@masanjin.net
+.ME \c
+\ and is now developed and maintained by the Sup developers.

data/man/sup-tweak-labels.1

@@ -1,85 +1,87 @@
-.\" Automatically generated by Pandoc 2.7.3
+.\" Automatically generated by Pandoc 3.1.9
 .\"
 .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
 .SH SYNOPSIS
-.PP
 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 \[lq]sup-add
 --help\[rq].
 .SH OPTIONS
 .TP
-.B -a \f[I]STRING\f[R], --add \f[I]STRING\f[R]
+-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: )
 .TP
-.B -r \f[I]STRING\f[R], --remove \f[I]STRING\f[R]
+-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: )
 .TP
-.B -q \f[I]QUERY\f[R], --query \f[I]QUERY\f[R]
+-q \f[I]QUERY\f[R], --query \f[I]QUERY\f[R]
 A Sup search query
 .SH OTHER OPTIONS
 .TP
-.B -v, --verbose
+-v, --verbose
 Print message ids as they\[cq]re processed
 .TP
-.B -e, --very-verbose
+-e, --very-verbose
 Print message names and subjects as they\[cq]re processed
 .TP
-.B --all-sources
+--all-sources
 Scan over all sources
 .TP
-.B -n, --dry-run
+-n, --dry-run
 Don\[cq]t actually modify the index.
 Probably only useful with --verbose
 .TP
-.B --version
+--version
 Show version information
 .TP
-.B -h, --help
+-h, --help
 Show help message
 .SH SEE ALSO
-.PP
 sup(1), sup-add(1)
 .SH REPORTING BUGS
-.PP
 You are welcome to submit bug reports to the Sup issue tracker, located
 at
 .PP
-<https://github.com/sup-heliotrope/sup/issues>
+\c
+.UR https://github.com/sup-heliotrope/sup/issues
+.UE \c
 .SH CONTACT INFORMATION
 .TP
-.B The Sup web page:
-<http://supmua.org/>
-.TP
-.B Code repository:
-<https://github.com/sup-heliotrope/sup/>
+The Sup web page:
+\c
+.UR https://sup-heliotrope.github.io/
+.UE \c
 .TP
-.B Sup Wiki:
-<https://github.com/sup-heliotrope/sup/wiki/>
+Code repository:
+\c
+.UR https://github.com/sup-heliotrope/sup/
+.UE \c
 .TP
-.B Sup IRC channel:
-#sup \[at] freenode.net
+Sup Wiki:
+\c
+.UR https://github.com/sup-heliotrope/sup/wiki/
+.UE \c
 .TP
-.B Mailing list:
+Mailing list:
 supmua\[at]googlegroups.com
 .RS
 .PP
 supmua+subscribe\[at]googlegroups.com
 .PP
-Archives: <https://groups.google.com/d/forum/supmua/>
+Archives: \c
+.UR https://groups.google.com/d/forum/supmua/
+.UE \c
 .RE
 .SH COPYRIGHT
-.PP
-Copyright \[co] 2006-2009 William Morgan <mworgan-sup@masanjin.net>
+Copyright © 2006-2009 William Morgan \c
+.MT mworgan-sup@masanjin.net
+.ME \c
 .PP
 Copyright \[at] 2013-2014 Sup developers
 .PP
@@ -87,5 +89,7 @@ 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)
 any later version.
 .SH AUTHORS
-Sup was originally written by William Morgan <wmorgan-sup@masanjin.net>
-and is now developed and maintained by the Sup developers.
+Sup was originally written by William Morgan \c
+.MT wmorgan-sup@masanjin.net
+.ME \c
+\ and is now developed and maintained by the Sup developers.

data/man/sup.1

@@ -1,15 +1,11 @@
-.\" Automatically generated by Pandoc 2.7.3
+.\" Automatically generated by Pandoc 3.1.9
 .\"
 .TH "SUP" "1" "April 8, 2014" "Sup User Manual" ""
-.hy
 .SH NAME
-.PP
 sup - a curses-based email client
 .SH SYNOPSIS
-.PP
 sup [\f[I]options\f[R]]
 .SH DESCRIPTION
-.PP
 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
@@ -21,92 +17,98 @@ 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.
 Use \[en]hooks-matching to filter
 .TP
-.B -m, --hooks-matching=<s>
+-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.)
 .TP
-.B -o, --no-initial-poll
+-o, --no-initial-poll
 Don\[cq]t poll for new messages when starting.
 .TP
-.B -s \f[I]QUERY\f[R], --search \f[I]QUERY\f[R]
+-s \f[I]QUERY\f[R], --search \f[I]QUERY\f[R]
 Search for this query upon startup
 .TP
-.B -c \f[I]STRING\f[R], --compose \f[I]STRING\f[R]
+-c \f[I]STRING\f[R], --compose \f[I]STRING\f[R]
 Compose message to this recipient upon startup
 .TP
-.B -j \f[I]STRING\f[R], --subject \f[I]STRING\f[R]
+-j \f[I]STRING\f[R], --subject \f[I]STRING\f[R]
 When composing, use this subject
 .TP
-.B -v, --version
+-v, --version
 Print version and exit
 .TP
-.B -h, --help
+-h, --help
 Show brief help message
 .SH ENVIRONMENT
 .TP
-.B SUP_LOG_LEVEL
+SUP_LOG_LEVEL
 Set log level verbosity.
 Valid values ordered by decresing verbosity: debug info warn error.
 Default log level is info.
 .TP
-.B SUP_BASE\[rs]
+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
 .TP
-.B $HOME/.sup/sources.yaml
+$HOME/.sup/sources.yaml
 Configuration file for Sup mail sources
 .TP
-.B $HOME/.sup/colors.yaml
+$HOME/.sup/colors.yaml
 Color theme for Sup
 .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)
 .SH REPORTING BUGS
-.PP
 You are welcome to submit bug reports to the Sup issue tracker, located
 at
 .PP
-<https://github.com/sup-heliotrope/sup/issues>
+\c
+.UR https://github.com/sup-heliotrope/sup/issues
+.UE \c
 .SH CONTACT INFORMATION
 .TP
-.B The Sup web page:
-<http://supmua.org/>
-.TP
-.B Code repository:
-<https://github.com/sup-heliotrope/sup/>
+The Sup web page:
+\c
+.UR https://sup-heliotrope.github.io/
+.UE \c
 .TP
-.B Sup Wiki:
-<https://github.com/sup-heliotrope/sup/wiki/>
+Code repository:
+\c
+.UR https://github.com/sup-heliotrope/sup/
+.UE \c
 .TP
-.B Sup IRC channel:
-#sup \[at] freenode.net
+Sup Wiki:
+\c
+.UR https://github.com/sup-heliotrope/sup/wiki/
+.UE \c
 .TP
-.B Mailing list:
+Mailing list:
 supmua\[at]googlegroups.com
 .RS
 .PP
 supmua+subscribe\[at]googlegroups.com
 .PP
-Archives: <https://groups.google.com/d/forum/supmua/>
+Archives: \c
+.UR https://groups.google.com/d/forum/supmua/
+.UE \c
 .RE
 .SH COPYRIGHT
-.PP
-Copyright \[co] 2006-2009 William Morgan <mworgan-sup@masanjin.net>
+Copyright © 2006-2009 William Morgan \c
+.MT mworgan-sup@masanjin.net
+.ME \c
 .PP
 Copyright \[at] 2013-2014 Sup developers
 .PP
@@ -114,5 +116,7 @@ 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)
 any later version.
 .SH AUTHORS
-Sup was originally written by William Morgan <wmorgan-sup@masanjin.net>
-and is now developed and maintained by the Sup developers.
+Sup was originally written by William Morgan \c
+.MT wmorgan-sup@masanjin.net
+.ME \c
+\ and is now developed and maintained by the Sup developers.

data/shell.nix

@@ -0,0 +1 @@
+contrib/nix/ruby3.3-shell.nix

data/sup.gemspec

@@ -4,7 +4,7 @@ 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"
@@ -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,7 +51,7 @@ 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", "~> 1.1"
+  s.add_runtime_dependency "rmail", ">= 1.1.2", "< 2"
   s.add_runtime_dependency "highline"
   s.add_runtime_dependency "optimist"
   s.add_runtime_dependency "lockfile"
@@ -60,12 +60,14 @@ SUP: please note that our old mailing lists have been shut down,
   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", "< 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--
+