Metadata-Version: 2.1
Name: odoo-addon-mail_recipient_blocklist
Version: 18.0.1.0.0.3
Requires-Python: >=3.10
Requires-Dist: odoo==18.0.*
Summary: Block outgoing emails by configurable recipient patterns
Home-page: https://github.com/OCA/mail
License: AGPL-3
Author: Tecnativa, Odoo Community Association (OCA)
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 18.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Description-Content-Type: text/x-rst

.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

========================
Mail Recipient Blocklist
========================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:032629712d655a9dfd2d9c47b32e65148b75b78856efa51bdaac2192dca21f95
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
    :target: https://odoo-community.org/page/development-status
    :alt: Beta
.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fmail-lightgray.png?logo=github
    :target: https://github.com/OCA/mail/tree/18.0/mail_recipient_blocklist
    :alt: OCA/mail
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/mail-18-0/mail-18-0-mail_recipient_blocklist
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
    :target: https://runboat.odoo-community.org/builds?repo=OCA/mail&target_branch=18.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

Blocks outgoing emails addressed to recipients matching configurable
block rules. Rules can match exact emails, domains, contained text,
wildcard patterns or regular expressions. The block is enforced both on
queued Odoo emails (``mail.mail``) and on direct SMTP deliveries
(``ir.mail_server``).

**Table of contents**

.. contents::
   :local:

Usage
=====

To configure blocked recipients:

1. Go to **Settings > Technical > Email > Recipient Block Rules**.

   |Recipient block rule menu|

2. Create a new rule or edit an existing one. For each rule, set a name,
   choose the pattern type, define the pattern, and keep the rule
   active.

   |Recipient block rule form|

3. Choose the pattern type according to the recipients you need to
   block:

   - **Exact email**: matches one complete email address.
   - **Domain**: matches all recipients in a domain.
   - **Contains**: matches recipients containing the configured text.
   - **Wildcard**: supports shell-style wildcards such as
     ``*@example.com``.
   - **Regular expression**: supports Python regular expressions.

4. Save the rule. Outgoing emails are filtered before delivery. If all
   recipients are blocked, the email is cancelled. If only some
   recipients are blocked, Odoo sends the email to the remaining allowed
   recipients.

   |Recipient block rule result|

A default rule blocks Amazon Marketplace aliases matching
``@marketplace.amazon.``.

Archived rules are ignored. If all matching rules are archived, Odoo
will use its standard outgoing mail flow for those recipients.

.. |Recipient block rule menu| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_recipient_blocklist/static/description/recipient_block_rule_menu.png
.. |Recipient block rule form| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_recipient_blocklist/static/description/recipient_block_rule_form.png
.. |Recipient block rule result| image:: https://raw.githubusercontent.com/OCA/mail/18.0/mail_recipient_blocklist/static/description/recipient_block_rule_result.png

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/mail/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/mail/issues/new?body=module:%20mail_recipient_blocklist%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
-------

* Tecnativa

Contributors
------------

- `Tecnativa <https://www.tecnativa.com>`__:

  - Sergio Teruel

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

.. |maintainer-sergio-teruel| image:: https://github.com/sergio-teruel.png?size=40px
    :target: https://github.com/sergio-teruel
    :alt: sergio-teruel

Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-sergio-teruel| 

This module is part of the `OCA/mail <https://github.com/OCA/mail/tree/18.0/mail_recipient_blocklist>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
