Metadata-Version: 2.1
Name: odoo-addon-shopinvader_api_mass_mailing
Version: 18.0.1.0.0.2
Requires-Python: >=3.10
Requires-Dist: odoo-addon-extendable_fastapi==18.0.*
Requires-Dist: odoo-addon-shopinvader_router_helper==18.0.*
Requires-Dist: odoo==18.0.*
Summary: Add a way to subscribe/unsubscribe to mass mailing list of an endpoint
Home-page: https://github.com/shopinvader/odoo-shopinvader
License: AGPL-3
Author: Akretion, 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

============================
Shopinvader Api Mass Mailing
============================

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

.. |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-shopinvader%2Fodoo--shopinvader-lightgray.png?logo=github
    :target: https://github.com/shopinvader/odoo-shopinvader/tree/18.0/shopinvader_api_mass_mailing
    :alt: shopinvader/odoo-shopinvader

|badge1| |badge2| |badge3|

This module adds per endpoint configurable mailing list and two new
public routes to manage the subscription of a contact to the mailing
list.

- ``/shopinvader_api/mailing/subscribe`` to subscribe a contact to the
  mailing list
- ``/shopinvader_api/mailing/unsubscribe`` to unsubscribe a contact from
  the mailing list

A contact here is defined by its email address, no partner is linked or
created.

It may be intersting to protect these endpoints with a captcha to avoid
abuse, you could take a look at the ``fastapi_captcha`` for instance.

**Table of contents**

.. contents::
   :local:

Usage
=====

Add the mass_mailing_router to your endpoint and configure the mailing
list to use in the endpoint configuration.

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

Bugs are tracked on `GitHub Issues <https://github.com/shopinvader/odoo-shopinvader/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/shopinvader/odoo-shopinvader/issues/new?body=module:%20shopinvader_api_mass_mailing%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
-------

* Akretion

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

- Florian Mounier florian.mounier@akretion.com

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

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

Current maintainer:

|maintainer-paradoxxxzero| 

This module is part of the `shopinvader/odoo-shopinvader <https://github.com/shopinvader/odoo-shopinvader/tree/18.0/shopinvader_api_mass_mailing>`_ project on GitHub.

You are welcome to contribute.
