Files
kumomta/docs/reference/events/smtp_server_mail_from.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

856 B

smtp_server_mail_from

kumo.on('smtp_server_mail_from', function(sender, conn_meta) end)

Called by the ESMTP server in response to the client issuing a "MAIL FROM" command. The event handler is passed the sender address parameter from the MAIL FROM command.

The sender address is an EnvelopeAddress object.

{{since('2023.08.22-4d895015', indent=True)}} The conn_meta parameter represents the connection metadata and can be used to share state between the various SMTP listener event handlers. See Connection Metadata for more information.

You may choose to reject the connection via kumo.reject.

kumo.on('smtp_server_mail_from', function(sender)
  if sender.domain == 'bad.domain' then
    kumo.reject(420, 'not thanks')
  end
end)