Metadata-Version: 2.1
Name: mailman-rest-event-tim
Version: 1.0.1
Summary: Sends mailman events to a REST endpoint
Home-page: https://github.com/dezhidki/mailman-rest-events
Author: Denis Zhidkikh
Author-email: dezhidki@jyu.fi
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/dezhidki/mailman-rest-events/issues
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Topic :: Communications :: Email
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# Mailman event sender

This package is a plugin for [mailman 3](https://docs.mailman3.org/en/latest/) which allows to send webhook-like events to configurable endpoints.

## Configuration

As for every plugin, register it in `mailman.cfg`:

```cfg
[plugin.mailman_rest_event]
class: mailman_rest_event.plugin.RestEventPlugin
enabled: yes
# Or specify your own location
configuration: /etc/mailman3/mailman-rest-event.cfg 
```

Then configure the plugin in `mailman-rest-event.cfg`:

```cfg
[general]
# URL to which events will be sent
webhook_url: https://example.com/mailman/event
# Response timeout for event calls
timeout: 2

# Username and key used to authenticate the URL
# These credentials will be sent as Authorization Basic header
[auth]
user: auth_user
key: auth_key
```

