summaryrefslogtreecommitdiff
path: root/email-print-mime-structure.1.pod
diff options
context:
space:
mode:
authorSean Whitton <spwhitton@spwhitton.name>2019-09-20 21:04:55 -0700
committerSean Whitton <spwhitton@spwhitton.name>2019-09-20 21:04:55 -0700
commitbabab12934608c9ad91c3fe12d2e8f57bcc19692 (patch)
treebe7d45326330c3ac85a10d67b1e0c8dc1e52171b /email-print-mime-structure.1.pod
parent07541ca67c5774f172cbf7dbbf42c99220a433c1 (diff)
parentc3865570be223bc1876d69b3a910c5fae168ebb7 (diff)
downloadmailscripts-babab12934608c9ad91c3fe12d2e8f57bcc19692.tar.gz
Merge tag 'debian/0.11-1' into buster-bpo
mailscripts release 0.11-1 for unstable (sid) [dgit] [dgit distro=debian no-split --quilt=linear] # gpg: Signature made Sun 15 Sep 2019 08:18:22 AM MST # gpg: using RSA key 9B917007AE030E36E4FC248B695B7AE4BF066240 # gpg: Good signature from "Sean Whitton <spwhitton@spwhitton.name>" [ultimate] # Primary key fingerprint: 8DC2 487E 51AB DD90 B5C4 753F 0F56 D055 3B6D 411B # Subkey fingerprint: 9B91 7007 AE03 0E36 E4FC 248B 695B 7AE4 BF06 6240
Diffstat (limited to 'email-print-mime-structure.1.pod')
-rw-r--r--email-print-mime-structure.1.pod62
1 files changed, 62 insertions, 0 deletions
diff --git a/email-print-mime-structure.1.pod b/email-print-mime-structure.1.pod
new file mode 100644
index 0000000..ab1ec05
--- /dev/null
+++ b/email-print-mime-structure.1.pod
@@ -0,0 +1,62 @@
+=encoding utf8
+
+=head1 NAME
+
+email-print-mime-structure - display a tree-like view of the MIME structure of an e-mail
+
+=head1 SYNOPSIS
+
+B<email-print-mime-structure> <B<message.eml>
+
+=head1 DESCRIPTION
+
+B<email-print-mime-structure> reads a MIME message from stdin and
+produces a treelike representation to stdout.
+
+If the user wants the parts numbered, they can feed the output through
+something like "cat -n".
+
+
+=head1 OPTIONS
+
+None.
+
+=head1 EXAMPLE
+
+=over 4
+
+ $ email-print-mime-structure <test.eml
+ └┬╴multipart/signed 6546 bytes
+ ├─╴text/plain inline 895 bytes
+ └─╴application/pgp-signature inline [signature.asc] 836 bytes
+
+=back
+
+=head1 LIMITATIONS
+
+B<email-print-mime-structure> currently does not try to decrypt
+encrypted e-mails, so it cannot display the MIME structure that is
+inside the message's cryptographic envelope.
+
+B<email-print-mime-structure>'s output is not stable, and is not
+intended to be interpreted by machines, so please do not depend on it
+in scripts!
+
+B<email-print-mime-structure> displays some data from within the
+e-mail, but does not sanitize it before display. Some particularly
+cleverly-malformed MIME parameters might be able to induce apparent
+formatting changes or emit arbitrary characters to stdout.
+
+B<email-print-mime-structure> expects to be run in a UTF-8-friendly
+environment.
+
+=head1 SEE ALSO
+
+https://tools.ietf.org/html/rfc2045, https://tools.ietf.org/html/rfc2049
+
+=head1 AUTHOR
+
+B<email-print-mime-structure> and this manpage were written by Daniel
+Kahn Gillmor and Jameson Graef Rollins, with suggestions and feedback
+from many others in the community that develops the notmuch mail user
+agent. It originated in the notmuch source tree.