aboutsummaryrefslogtreecommitdiff
path: root/email
diff options
context:
space:
mode:
authorArun Isaac2019-08-07 22:58:11 +0530
committerArun Isaac2019-08-07 22:59:28 +0530
commit3a02125ad752209e349a94ff7a470a2d79aff699 (patch)
tree810cfbbf08656aade5bb743833da429396794dd3 /email
parent88d5b26f058917c27b45569683ad8e875b23d569 (diff)
downloadguile-email-3a02125ad752209e349a94ff7a470a2d79aff699.tar.gz
guile-email-3a02125ad752209e349a94ff7a470a2d79aff699.tar.lz
guile-email-3a02125ad752209e349a94ff7a470a2d79aff699.zip
doc: Document mbox->emails.
* doc/guile-email.texi (Reading Email): New chapter. * email/email.scm (mbox->emails): Add docstring.
Diffstat (limited to 'email')
-rw-r--r--email/email.scm2
1 files changed, 2 insertions, 0 deletions
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))