This is the darts.lib.email-address Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Nov 06 13:05:12 2023 GMT+0.
The main system appears first, followed by any subsystem dependency.
darts.lib.email-addressParsing and formatting email addresses (RFC 5322 compliant)
Dirk Eßer
Dirk Esser
MIT
0.1
src (module).
Modules are listed depth-first from the system components tree.
darts.lib.email-address/srcdarts.lib.email-address (system).
package.lisp (file).
parser.lisp (file).
objects.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
darts.lib.email-address/darts.lib.email-address.asddarts.lib.email-address/src/package.lispdarts.lib.email-address/src/parser.lispdarts.lib.email-address/src/objects.lispdarts.lib.email-address/darts.lib.email-address.asddarts.lib.email-address (system).
darts.lib.email-address/src/parser.lispsrc (module).
*allow-obsolete-syntax* (special variable).
*allow-unicode* (special variable).
escape-display-name (function).
escape-local-part (function).
parse-rfc5322-addr-spec (function).
parse-rfc5322-mailbox (function).
parse-rfc5322-mailbox-list (function).
atext-char-p (function).
ctext-char-p (function).
dtext-char-p (function).
fws-char-p (function).
make-buffer (function).
next-token (function).
qtext-char-p (function).
recurr (macro).
darts.lib.email-address/src/objects.lispsrc (module).
address (function).
address (structure).
address-domain (reader).
address-hash (function).
address-local-part (reader).
address-string (function).
address/= (function).
address< (function).
address<= (function).
address= (function).
address> (function).
address>= (function).
addressp (function).
basic-mailbox (class).
mailbox (function).
mailbox (class).
mailbox-address (generic function).
mailbox-display-name (generic function).
mailbox-domain (generic function).
mailbox-local-part (generic function).
mailbox-string (generic function).
mailboxp (generic function).
make-address (function).
print-object (method).
print-object (method).
shared-initialize (method).
%make-addr (function).
address-%hash (reader).
(setf address-%hash) (writer).
address-%string (reader).
(setf address-%string) (writer).
Packages are listed by definition order.
darts.lib.email-addresscommon-lisp.
*allow-obsolete-syntax* (special variable).
*allow-unicode* (special variable).
address (function).
address (structure).
address-domain (reader).
address-hash (function).
address-local-part (reader).
address-string (function).
address/= (function).
address< (function).
address<= (function).
address= (function).
address> (function).
address>= (function).
addressp (function).
basic-mailbox (class).
escape-display-name (function).
escape-local-part (function).
mailbox (function).
mailbox (class).
mailbox-address (generic function).
mailbox-display-name (generic function).
mailbox-domain (generic function).
mailbox-local-part (generic function).
mailbox-string (generic function).
mailboxp (generic function).
make-address (function).
parse-rfc5322-addr-spec (function).
parse-rfc5322-mailbox (function).
parse-rfc5322-mailbox-list (function).
%make-addr (function).
address-%hash (reader).
(setf address-%hash) (writer).
address-%string (reader).
(setf address-%string) (writer).
atext-char-p (function).
ctext-char-p (function).
dtext-char-p (function).
fws-char-p (function).
make-buffer (function).
next-token (function).
qtext-char-p (function).
recurr (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
escape-display-name STRING &optional START END => ANSWER
Returns a copy of the portion of STRING between START (incl.) and END (excl.). If necessary, this function adds quotes around the result, and makes sure, that it satisfies the rules of an email display name.
escape-local-part STRING &optional START END => ANSWER
Returns a copy of the portion of STRING between START (incl.) and END (excl.). If necessary, this function adds quotes around the result, and makes sure, that internal occurrences of #\\ and #\" are properly escaped.
Coerces the given ‘value’ into an instance of class ‘mailbox’ or
a suitable subclass.
- if ‘value’ is already a ‘mailbox’, it is directly returned
- if ‘value’ is an ‘address’, a new mailbox instance is created,
using that address and a display name value of nil.
- if ‘value’ is a string, it is parsed according to the RFC 5322
‘mailbox’ production and a mailbox instance is created from the
results.
If the value cannot be coerced, signals a condition of type ‘type-error’.
Creates a new address from the given component values ‘local-part’ and ‘domain’. Both arguments must be strings. Note, that this function currently does not validate the contents of the given local part and domain values.
parse-rfc5322-addr-spec STRING &key START END => LOCAL-PART DOMAIN POSITION
Parses an email address (rule addr-spec in RFC 5322) from STRING, starting at
index START (inclusive, defaults to 0), and stopping at index END (exclusive,
defaults to the length of STRING).
Returns four values
1. the local part of the email address
2. the domain part of the email address
3. an error code, or nil, if the parsing was successful
4. the index of the first character not processed
This function stops after finding a complete email address, when it encounters an error, or when reaching the END index. The following error codes are defined:
nil no error, a full email address has been found
:bad-local-part no valid local part could be found
:missing-separator the ‘@´ was not found
:bad-domain no valid domain part could be found
:trailing-garbage unprocessed characters remain after the address
parse-rfc5322-mailbox STRING &optional START END => LOCAL-PART DOMAIN DISPLAY-NAME ERROR POSITION
Answers the ‘address’ instance, which describes the actual
email address associated with mailbox ‘object’. This method is part of the
core mailbox protocol, and must be implemented by all objects, which want
to participate in that protocol.
basic-mailbox)) ¶automatically generated reader method
Answers the display name associated with the given mailbox
instance ‘object’. This function is part of the core mailbox protocol and
must be implemented by all objects, which want to participate in that
protocol.
basic-mailbox)) ¶automatically generated reader method
Answers the domain string of this mailbox’s address.
The default method simply extracts the ‘address-domain’ from the object
returned by ‘mailbox-address’ when applied to the given ‘object’.
Answers the local part string of this mailbox’s address.
The default method simply extracts the ‘address-local-part’ from the object
returned by ‘mailbox-address’ when applied to the given ‘object’.
Constructs a string representation of the given mailbox
instance. The result is required to be a well-formed RFC 5322 email address
parsable using the ‘mailbox’ production. The default method should be usable
by almost all concrete ‘mailbox’ implementations.
Tests, whether ‘object’ fulfills the ‘mailbox’ protocol.
This condition is always true by definition for subclasses of class ‘mailbox’.
It may additionally be true for other objects.
Plain email address, composed of the local part (a string) and the domain (another string). Instances of this structure class are immutable after construction. This structure class fully supports the mailbox protocol.
structure-object.
simple-string
(error "missing local part")
This slot is read-only.
simple-string
(error "missing domain")
This slot is read-only.
(or null simple-string)
fixnum
-1
A simple concrete implementation of ‘mailbox’, which
stores the address and display name information in dedicated slots.
A mailbox is basically an email address combined with an
optional display name for that address. This class itself is only a protocol
class, and exists for the purpose of type discrimination only.
| Jump to: | %
(
A C D E F G M N P Q R S |
|---|
| Jump to: | %
(
A C D E F G M N P Q R S |
|---|
| Jump to: | %
*
D L M S |
|---|
| Jump to: | %
*
D L M S |
|---|
| Jump to: | A B C D F M O P S |
|---|
| Jump to: | A B C D F M O P S |
|---|