Metadata-Version: 2.4
Name: pretix-bounces
Version: 2.0.0
Summary: Allows automatic processing of bounces or automatic replies to emails sent by pretix.
Author-email: pretix team <support@pretix.eu>
Maintainer-email: pretix team <support@pretix.eu>
License: Copyright 2017 Raphael Michel
        
        Licensed under the Apache License, Version 2.0 (the "License");
        you may not use this file except in compliance with the License.
        You may obtain a copy of the License at
        
            http://www.apache.org/licenses/LICENSE-2.0
        
        Unless required by applicable law or agreed to in writing, software
        distributed under the License is distributed on an "AS IS" BASIS,
        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
        See the License for the specific language governing permissions and
        limitations under the License.
        
Project-URL: homepage, https://github.com/pretix/pretix-bounces
Keywords: pretix
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
Dynamic: license-file

Bounce processing for pretix
============================

This is a plugin for `pretix`_. Once installed and configured, it makes pretix use random ``Sender`` headers
for emails like ``noreply-amCwRFatawEjetS8@pretix.eu`` for outgoing emails. The ``From`` and ``Reply-To``
headers remain untouched. It then periodically checks for emails in a specified IMAP inbox and adds replied
emails to the log of an order. This leads to an automatic logging of bounces on pretix-level.

Configuration
-------------

This requires an additional section in the ``pretix.cfg`` config file that looks like this::

    [bounces]
    alias=noreply-%s@mydomain.com
    from_domain=mydomain.com
    server=mail.mydomain.com:993
    user=noreply@mydomain.com
    pass=12345678

The plugin will only be effective for mails sent through the system default mailer (specified in the same file), not
for events with a custom SMTP server. ``from_domain`` can contain multiple comma-separated domains, in which case you
can use a second ``%s`` placeholder in ``alias`` for the domain.

Development setup
-----------------

1. Make sure that you have a working `pretix development setup`_.

2. Clone this repository, eg to ``local/pretix-bounces``.

3. Activate the virtual environment you use for pretix development.

4. Execute ``pip install -e .`` within this directory to register this application with pretix's plugin registry.

5. Execute ``make`` within this directory to compile translations.

6. Restart your local pretix server. You can now use the plugin from this repository for your events by enabling it in
   the 'plugins' tab in the settings.


License
-------

Copyright 2017 Raphael Michel

Released under the terms of the Apache License 2.0


.. _pretix: https://github.com/pretix/pretix
.. _pretix development setup: https://docs.pretix.eu/en/latest/development/setup.html
