collective.volto.acumbamail 1.0.1

An integration for the Acumbamail service with Plone

collective.volto.acumbamail

An integration for the Acumbamail service with Plone.

Features

• Control panel in Plone registry to manage Acumbamail settings.
• RestApi endpoint that exposes these settings for Volto.
• Add a new subscriber to the Acumbamail list.

Screenshot

Add-on Configuration Access

---

Acumbamail Settings control panel

Volto integration

To use this product in Volto, your Volto project needs to include a new add-on: https://github.com/collective/volto-acumbamail

Translations

This product has been translated into

• Basque

• Catalan

• English

• Galician

• Spanish

Compatibility

• Tested with Python 3.12 and Plone 6.1.5.

Installation

Install collective.volto.acumbamail with pip:

pip install collective.volto.acumbamail

And to create the Plone site:

make create-site

Custom REST services

@acumbamail-settings route

Anonymous users can't access registry resources by default with plone.restapi (there is a special permission).

To avoid enabling registry access to everyone, this package exposes a dedicated RestApi route with Acumbamail settings: @acumbamail-settings:

Get the information from the Acumbamail settings via curl command:

curl -X GET http://localhost:8080/Plone/@controlpanels/acumbamail-settings \
  -H "Accept: application/json" \
  --user admin:admin

This route returns a JSON object containing the Acumbamail settings and data via curl command:

{
  "@id": "http://localhost:8080/Plone/@controlpanels/acumbamail-settings",
  "data": {
    "api_key": null,
    "api_url": null,
    "list_id": null
  },
  "group": "Add-on Configuration",
  "schema": {
    "fieldsets": [
      {
        "behavior": "plone",
        "description": "",
        "fields": [
          "api_url",
          "api_key",
          "list_id"
        ],
        "id": "general",
        "title": "General settings"
      }
    ],
    "properties": {
      "api_key": {
        "description": "Your Acumbamail personal token (https://acumbamail.com/api/)",
        "factory": "Text line (String)",
        "title": "API Key",
        "type": "string"
      },
      "api_url": {
        "description": "The URL of the Acumbamail API endpoint.",
        "factory": "Text line (String)",
        "title": "API URL",
        "type": "string"
      },
      "list_id": {
        "description": "Numeric identifier of the list where subscribers will be added.",
        "factory": "Text line (String)",
        "title": "List ID",
        "type": "string"
      }
    },
    "required": [
      "api_url",
      "api_key",
      "list_id"
    ],
    "type": "object"
  },
  "title": "Acumbamail Settings"
}

Below is a PATCH operation to set up the api_url, api_key and list_id fields values of the Acumbamail settings:

curl -i -X PATCH http://localhost:8080/Plone/@controlpanels/acumbamail-settings \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data '{"api_url": "https://acumbamail.com/api/1", "api_key": "204615m3a78w2fgt3t1nm34567890123", "list_id": "4702726"}' \
  --user admin:admin

This route returns a HTTP response:

HTTP/1.1 204 No Content
Connection: close
Date: Sat, 25 Jul 2026 10:00:18 GMT
Server: waitress
Via: waitress
X-Powered-By: Zope (www.zope.dev), Python (www.python.org)

That means you were updated the values in the Acumbamail settings control panel fields correctly!

NOTE: You can validate the update operation, going to Site setup > Add-on settings > Acumbamail settings.

---

@acumbamail-subscribe route

Anonymous users can't access registry resources by default with plone.restapi (there is a special permission).

To avoid enabling registry access to everyone, this package exposes a dedicated RestApi route called @acumbamail-subscribe, below is a POST operation to add a new subscriber to the mailing list:

curl -i -X POST http://localhost:8080/Plone/@acumbamail-subscribe \
  -H "Accept: application/json" \
  -H "Accept-Language: es" \
  --data '{"email": "[e-mail]"}' \
  --user admin:admin

This route can be used in for a Volto integration form componet.

NOTE: You can validate the add operation, going to your Acumbamail Dashboard account.

General resources

This part of the documentation contains reference material, including APIs, configuration values, and environment variables.

The Official API Acumbamail

• Official API Acumbamail Documentation.

The Acumbamail endpoints that using:

• The batchAddSubscribers, is the Acumbamail endpoints that using.

Contribute

• Issue tracker
• Source code
• Documentation

Prerequisites ✅

• An operating system that runs all the requirements mentioned.
• uv
• Make
• Git
• Docker (optional)

Installation 🔧

1. Clone this repository, then change your working directory.

   git clone [e-mail]:collective/collective.volto.acumbamail.git
   cd collective.volto.acumbamail
   

2. Install this code base.

   make install
   

Add features using plonecli or bobtemplates.plone

This package provides markers as strings (<!-- extra stuff goes here -->) that are compatible with plonecli and bobtemplates.plone. These markers act as hooks to add all kinds of subtemplates, including behaviors, control panels, upgrade steps, or other subtemplates from plonecli.

To run plonecli with configuration to target this package, run the following command.

make add <template_name>

For example, you can add a content type to your package with the following command.

make add content_type

You can add a behavior with the following command.

make add behavior

See also:

You can check the list of available subtemplates in the bobtemplates.plone README.md file. See also the documentation of Mockup and Patternslib for how to build the UI toolkit for Classic UI.

Credits

Developed with the support of:

• Instituto Municipal de Deportes - IMD, Seville City Council, Spain.

  

Acknowledgements 🙏

Generated using Cookieplone (0.9.10) and cookieplone-templates (eb40854) on 2025-11-06 19:48:38.313942. A special thanks to all contributors and supporters!

Authors

This product was developed by Leonardo J. Caballero G. [[e-mail]].

Contributors

You can see a list of contributors in the CONTRIBUTORS.md file.

License

The project is licensed under GPLv2.