collective.volto.formsupport 2.7.3

@submit-form

Endpoint that the frontend should call as a submit action.

You can call it with a POST on the context where the block form is stored like this:

> curl -i -X POST http://localhost:8080/Plone/my-form/@submit-form -H 'Accept: application/json' -H 'Content-Type: application/json' --data-raw '{"block_id": "123456789", "data": [{"field_id": "foo", "value":"foo", "label": "Foo"},{"field_id": "from", "value": "support@foo.com"}, {"field_id":"name", "value": "John Doe", "label": "Name"}]}'

where:

• my-form is the context where we have a form block

• block_id is the id of the block

• data contains the submitted form data

Calling this endpoint, it will do some actions (based on block settings) and returns a 204 response.

@form-data

This is an expansion component.

There is a rule that returns a form-data item into “components” slot if the user can edit the context (Modify portal content permission) and there is a block that can store data.

Calling with “expand=true”, this endpoint returns the stored data:

> curl -i -X GET http://localhost:8080/Plone/my-form/@form-data -H 'Accept: application/json' -H 'Content-Type: application/json' --user admin:admin

And replies with something similar:

{
    "@id": "http://localhost:8080/Plone/my-form/@form-data",
    "items": [
        {
        "block_id": "123456789",
        "date": "2021-03-10T12:25:24",
        "from": "support@foo.com",
        "id": 912078826,
        "name": "John Doe"
        },
        ...
    ],
    "items_total": 42
}

@form-data-export

Returns a csv file with all data (only for users that have Modify portal content permission):

> curl -i -X GET http://localhost:8080/Plone/my-form/@form-data-export -H 'Accept: application/json' -H 'Content-Type: application/json' --user admin:admin

If form fields changed between some submissions, you will see also columns related to old fields.

@form-data-clear

Reset the store (only for users that have Modify portal content permission):

> curl -i -X GET http://localhost:8080/Plone/my-form/@form-data-clear -H 'Accept: application/json' -H 'Content-Type: application/json' --user admin:admin

Send

If block is set to send data, an email with form data will be sent to the recipient set in block settings or (if not set) to the site address.

If ther is an attachments field in the POST data, these files will be attached to the emal sent.

Store

If block is set to store data, we store it into the content that has that block (with a souper.plone catalog).

The store is an adapter registered for IFormDataStore interface, so you can override it easily.

Only fields that are also in block settings are stored. Missing ones will be skipped.

Each Record stores also two service attributes:

• fields_labels: a mapping of field ids to field labels. This is useful when we export csv files, so we can labels for the columns.

• fields_order: sorted list of field ids. This can be used in csv export to keep the order of fields.

We store these attributes because the form can change over time and we want to have a snapshot of the fields in the Record.

Honeypot configuration

If honeypot dependency is available in the buildout, the honeypot validation is enabled and selectable in forms.

Default field name is protected_1 and you can change it with an environment variable. See collective.honeypot for details.

2.7.3 (2024-07-04)

• Fix subject templating logics. [folix-01]

2.7.2 (2024-07-01)

• Handle field id format used by frontend logics. [folix-01]

2.7.1 (2024-07-01)

• Configurable email subject. [folix-01]

• Configurable mail header and footer. [folix-01]

2.7.0 (2023-04-03)

• Override content-transfer-encoding using MAIL_CONTENT_TRANSFER_ENCODING env [mamico]

• The form block can now be stored in a Volto block container (columns, accordion, tabs, etc) [tiberiuichim]

2.6.2 (2022-11-07)

• Fix collective.honeypot version. [cekk]

2.6.1 (2022-11-07)

• Fix dependencies. [cekk]

2.6.0 (2022-11-07)

• Add collective.honeypot support. [cekk]

2.5.0 (2022-10-04)

• Add limit attachments validation. Can be configured with environment variable. [cekk]

• Export also compiling date in csv. [cekk]

2.4.0 (2022-09-08)

• Add collective.z3cform.norobots support [erral]

2.3.0 (2022-05-26)

• Breaking change: changed the way to store data keys. Now we use field_id as key for Records. [cekk]

• Fix quoting in csv export. [cekk]

• Generate csv columns with proper field labels, and keep the form order. [cekk]

• Captcha support #13. [mamico]

2.2.0 (2022-04-07)

• Notify an event on sumbit. [mamico]

2.1.0 (2022-03-25)

• Support for user_as_bcc field in volto-form-block: send a separate mail for each email field with that flag. [cekk]

2.0.3 (2021-10-25)

• Fix permission checks in serializer. [nzambello]

2.0.2 (2021-10-25)

• Fix permission checks. [cekk]

2.0.1 (2021-10-18)

• [fix] do not send attachments multiple times. [cekk]

2.0.0 (2021-08-19)

• Convert field types: checkbox => multiple_choice and radio => single_choice to follow new schema in volto-form-block (https://github.com/collective/volto-form-block/pull/7). [cekk]

1.0.5 (2021-05-12)

• Added Brazilian Portuguese (pt_BR) translations. [ericof]

1.0.4 (2021-04-15)

• Changed the classifiers inside setup.py. This should fix some installation issues. [arsenico13]

1.0.3 (2021-04-08)

• NEW: The @submit-form entry-point now takes into account if a field is “marked” with “use_as_reply_to” and use that field for “from” and “reply to”. [arsenico13]

1.0.2 (2021-03-24)

• Fix form_data for anon. [cekk]

1.0.1 (2021-03-24)

• Fix README for pypi. [cekk]

1.0.0 (2021-03-24)

• Initial release. [cekk]