addr-spec 0.4.1

A wicked, fast UTF-8 email address parser and serializer.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

# addr-spec

A wicked, fast UTF-8 email address parser and serializer. It provides

- unopinionated, _correct_ parsing of email addresses (defined as `addr-spec` in
  [RFC 5322](https://www.rfc-editor.org/rfc/rfc5322)),
- extremely fast serialization and deserialization using low-level memory
  management,
- UTF-8 support with NFC normalization as recommended in
  [RFC 6532](https://datatracker.ietf.org/doc/html/rfc6532),
- format validation based on the grammar set out in
  [Section 3.4.1, RFC 5322](https://www.rfc-editor.org/rfc/rfc5322#section-3.4.1)
  and
  [Section 3.2, RFC 6532](https://datatracker.ietf.org/doc/html/rfc6532#section-3.2),
- and extremely fast serialization and deserialization. (Did we mention it's
  really fast?)

## Features

This crate supports the following features:

- `literals` - This allows parsing and serialization of literal domains.
- `white-spaces` - This allows parsing (but not serialization; see
  [Caveats](#caveats)) of whitepaces.

## Caveats

### Folding white spaces

Serializing folding white spaces (abbr. FWS) is not supported since it is
dependent on the transport mechanism. The `is_quoted` and `is_literal` functions
can be used to manually serialize the email if required. (Just be sure to use
these functions before consuming the address `into_parts`!)

### Comments

At the moment, comments are not supported. All the utilities for parsing them do
internally exist within the library, however parsing them decreases performance.
If you would like support for comments, please file an issue with your use-case.