mirror of
https://github.com/mailscope/kumomta.git
synced 2026-08-19 02:48:18 +00:00
Wez Furlong
42bf5c5e61
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).
51 lines
690 B
Markdown
51 lines
690 B
Markdown
# remove_x_headers
|
|
|
|
```
|
|
message:remove_x_headers([NAMES])
|
|
```
|
|
|
|
When called with no parameters, removes all headers with an `"X-"` prefix from
|
|
the message.
|
|
|
|
When called with a list of header names, only those headers, if present in the
|
|
message, will be removed from the message.
|
|
|
|
For example, with a message content of:
|
|
|
|
```
|
|
X-Campaign-ID: 12345
|
|
X-Mailer: foobar
|
|
Subject: the subject
|
|
|
|
The body
|
|
```
|
|
|
|
calling:
|
|
|
|
```lua
|
|
message:remove_x_headers()
|
|
```
|
|
|
|
will result in the body changing to:
|
|
|
|
```
|
|
Subject: the subject
|
|
|
|
The body
|
|
```
|
|
|
|
but calling:
|
|
|
|
```lua
|
|
message:remove_x_headers { 'x-campaign-id' }
|
|
```
|
|
|
|
will result in the body changing to:
|
|
|
|
```
|
|
X-Mailer: foobar
|
|
Subject: the subject
|
|
|
|
The body
|
|
```
|