Files
kumomta/docs/reference/addressheader/list.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

19 lines
526 B
Markdown

# list
```lua
local list = addressheader.list
```
Returns a lua table consisting of one entry per address in the header. Each
entry is a single simple address object that has `domain`, `user`, `email` and
`name` fields with the same semantics as `addressheader`.
```lua
for _, address in ipairs(msg:to_header().list) do
print('to entry', address)
-- prints something like:
-- to entry {"name":null,"address":"user@example.com"}
-- to entry {"name":"John Smith","address":"john.smith@example.com"}
end
```