=======================================
 flufl.bounce - Email bounce detectors
=======================================

This package is called ``flufl.bounce``, an email bounce detection library.

The ``flufl.bounce`` library provides a set of heuristic detectors for
discerning the original bouncing email address from a bounce message.  Many
formats found in the wild are supported, as are VERP_ and RFC 3464 (DSN_).
It also provides an API for extension with your own detector formats.


Requirements
============

``flufl.bounce`` requires Python 3.10 or newer.


Documentation
=============

A `simple guide`_ to using the library is available within this package, along
with a detailed `API reference`_.


Project details
===============

 * Project home: https://gitlab.com/flufl/flufl.bounce
 * Report bugs at: https://gitlab.com/flufl/flufl.bounce/issues
 * Code hosting: https://gitlab.com/flufl/flufl.bounce.git
 * Documentation: http://fluflbounce.readthedocs.io/

You can contact the author via barry@python.org.


Copyright
=========

Copyright (C) 2004-2026 Barry A. Warsaw

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.


Table of Contents
=================

* :ref:`genindex`

.. toctree::
    :glob:

    using
    apiref
    NEWS

.. _`simple guide`: using.html
.. _`API reference`: apiref.html
.. _VERP: http://en.wikipedia.org/wiki/Variable_envelope_return_path
.. _DSN: http://www.faqs.org/rfcs/rfc3464.html