aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorArun Isaac2025-03-12 22:57:40 +0000
committerArun Isaac2025-03-13 00:56:25 +0000
commit5fb1bc16aeff1e42a6e92045e0bf88dc8c034e39 (patch)
tree5d8d9eb4e8130ac8ec817212d3ee6300310ca8bb /doc
parent284d26ebf06ae0bfe3fb888e895efcebf25d5ff8 (diff)
downloadguile-email-5fb1bc16aeff1e42a6e92045e0bf88dc8c034e39.tar.gz
guile-email-5fb1bc16aeff1e42a6e92045e0bf88dc8c034e39.tar.lz
guile-email-5fb1bc16aeff1e42a6e92045e0bf88dc8c034e39.zip
email: Add accessors for common header fields.
* email/email.scm (sanitize-field): New function. (email-from, email-to, email-cc, email-bcc, email-subject, email-date, email-message-id, email-content-type): New public functions. * doc/guile-email.texi (Data Types): Document them.
Diffstat (limited to 'doc')
-rw-r--r--doc/guile-email.texi14
1 files changed, 13 insertions, 1 deletions
diff --git a/doc/guile-email.texi b/doc/guile-email.texi
index 72d8ee3..b359af4 100644
--- a/doc/guile-email.texi
+++ b/doc/guile-email.texi
@@ -3,7 +3,7 @@
@settitle guile-email
@copying
-Copyright @copyright{} 2019, 2021 Arun Isaac@*
+Copyright @copyright{} 2019, 2021, 2025 Arun Isaac@*
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
@@ -114,6 +114,18 @@ This is the data type representing emails.
Predicate and field accessors for the @code{<email>} data type.
@end deffn
+@deffn {Scheme Procedure} email-from email
+@deffnx {Scheme Procedure} email-to email
+@deffnx {Scheme Procedure} email-cc email
+@deffnx {Scheme Procedure} email-bcc email
+@deffnx {Scheme Procedure} email-subject email
+@deffnx {Scheme Procedure} email-date email
+@deffnx {Scheme Procedure} email-message-id email
+@deffnx {Scheme Procedure} email-content-type email
+Accessors for specific headers in @var{email}. Prefer these to
+@code{email-headers} when possible.
+@end deffn
+
@deffn {Scheme Procedure} make-email headers body
Construct an @code{<email>} object. @var{headers} is an association
list of email headers. @var{body} is either a string or a list of