Files
kumomta/docs/reference/addressheader/_index.md
T
Wez Furlong 42bf5c5e61 docs: adjust reference to improve search terms
We've been hoping that mkdocs-material will ship the much anticipated
search enhancements for some time, but it's time to recognize that
we need to do something to improve the search results with how
things work right now.

This is a big commit that changes the titles of the various pages
from the code-annotated synopsis to just the name of the function.

This makes it much easier now to match things like `kumo.reject`
directly, but `reject` remains awkward to find.

I think this is the best that we can do at this time.

A few functions have been annotated with the `status: deprecated` to
show as deprecated in the toc/nav (shows with a little trash can next
to the name).
2025-05-16 14:02:19 -07:00

21 lines
712 B
Markdown

# AddressHeader object
Represents the parsed form of an email header that holds email addresses,
such as `"From"` and `"To"` headers.
As these headers can contain lists of addresses and groups of addresses, care
needs to be taken when processing them.
Convenience accessors for the common case of a single address are provided, but
they will raise an error when used on an address that is not a simple single
address.
The [addressheader.list](list.md) field can be used to safely operate on the
parsed out set of addresses, regardless of how many are present.
Note that you can use `tostring(address)` to get a JSON rendition of the parsed
address information.
## Available Fields { data-search-exclude }