Files
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

1.0 KiB

parse_rfc3464

message:parse_rfc3464()

Parses the message data as an RFC 3464 delivery status report.

If the message is not an RFC 3464 report, returns nil. If the message is malformed, raises a lua error.

Otherwise, returns a lua table that looks like:

report = {
  per_message = {
    reporting_mta = {
      mta_type = 'dns',
      name = 'cs.utk.edu',
    },
  },
  -- This is an array style table, with one entry per
  -- recipient in the report
  per_recipient = {
    {
      original_recipient = {
        recipient_type = 'rfc822',
        recipient = 'louisl@larry.slip.umd.edu',
      },
      final_recipient = {
        recipient_type = 'rfc822',
        recipient = 'louisl@larry.slip.umd.edu',
      },
      action = 'failed',
      status = {
        class = 4,
        subject = 0,
        detail = 0,
      },
      diagnostic_code = {
        diagnostic_type = 'smtp',
        diagnostic = '426 connection timed out',
      },
      last_attempt_date = '1994-07-07T21:15:49Z',
    },
  },
}