Metadata-Version: 2.3
Name: mailman3-fedmsg-plugin
Version: 1.0.1
Summary: Emit fedora-messaging messages from Mailman 3
License: LGPL-3.0-or-later
Keywords: fedora,fedora-messaging
Author: Aurélien Bompard
Author-email: aurelien@bompard.org
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: backoff (>=2.2.1,<3.0.0)
Requires-Dist: fedora-messaging (>=3.4.1,<4.0.0)
Requires-Dist: mailman (>=3.0.0)
Requires-Dist: mailman3-fedmsg-plugin-schemas (>=1.0.0)
Requires-Dist: zope-interface (>=6.2,<8.0.0)
Project-URL: Homepage, https://github.com/fedora-infra/mailman3-fedmsg-plugin
Project-URL: Repository, https://github.com/fedora-infra/mailman3-fedmsg-plugin
Description-Content-Type: text/markdown

# Mailman3 Fedmsg plugin

Publish notifications about emails to the Fedora Messaging bus.

Enable this by adding the following to your `mailman.cfg` file:

```
[archiver.fedora_messaging]
# The class implementing the IArchiver interface.
class: mailman3_fedmsg_plugin.Archiver
enable: yes
```

Your Fedora Messaging configuration file must be working.

You can exclude certain lists from publication by adding them to the
`excluded_lists` key in the Fedora Messaging configuration files's
`[consumer_config]` section:

```
[consumer_config]
excluded_lists = ["bugzilla.lists.fedoraproject.org, commits.lists.fedoraproject.org"]
```

The values must be the list ID (dotted format) and they must be separated by
commas if you want to exclude multiple lists.

In this section, you can also set the URL of the HyperKitty instance
where the messages are archived, if any:

```
[consumer_config]
archive_base_url = "https://lists.fedoraproject.org/archives/"
```

In the same section, you can set the list of domains that the plugin can
extract usernames from:

```
[consumer_config]
# Domains where we can extract the username from the address
owned_domains = ["fedoraproject.org", "centos.org"]
```

