summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/guile-email.texi9
-rw-r--r--email/email.scm2
2 files changed, 11 insertions, 0 deletions
diff --git a/doc/guile-email.texi b/doc/guile-email.texi
index aa462cb..ed43d5a 100644
--- a/doc/guile-email.texi
+++ b/doc/guile-email.texi
@@ -24,6 +24,7 @@ Documentation License''.
* Data Types:: Data types provided by guile-email
* Encoding and Decoding:: Encoding and decoding Base64, Quoted-Printable
and Q-encoding
+* Reading Email:: Reading emails from the mbox format
* Contributing:: Contributing
Indices
@@ -444,6 +445,14 @@ Decode Q-encoding encoded string @var{str} and return the decoded
bytevector.
@end deffn
+@node Reading Email
+@chapter Reading Email
+
+@deffn {Scheme Procedure} mbox->emails port
+Read next email from @var{port} and return as a bytevector. @var{port}
+is an input port reading an mbox file.
+@end deffn
+
@node Contributing
@chapter Contributing
diff --git a/email/email.scm b/email/email.scm
index fdba01f..2c4178e 100644
--- a/email/email.scm
+++ b/email/email.scm
@@ -901,4 +901,6 @@ list of header keys and values."
email))
(define (mbox->emails port)
+ "Read next email from PORT and return as a bytevector. PORT is an
+input port reading an mbox file."
(read-objects read-next-email-in-mbox port))