Metadata-Version: 2.4
Name: splent_feature_contact
Version: 0.3.0
License-Expression: LGPL-3.0-or-later
Requires-Python: >=3.13
Description-Content-Type: text/markdown
License-File: COPYING
License-File: COPYING.LESSER
Requires-Dist: splent_framework>=1.20.0
Dynamic: license-file

# splent_feature_contact

The `contact` feature of a [SPLENT](https://splent.io) product line.

A SPLENT feature is a Python package that a product composes with others.
Its models, routes, services, templates and hooks are registered when the
product starts. What this feature provides and requires is listed in the
`[tool.splent.contract]` section of `pyproject.toml`, which
`splent feature:contract --write` keeps in sync with the source.

## What it does

A public contact form at `/contact`. Every message is stored, and when a
mail feature is installed it is also sent to the recipient set in the
Contact settings panel, or to the mail From address when none is set. A
captcha feature can veto a submission through the `contact-submitting`
signal, and the `contact.map` hook places a map beside the form.

The panel reads the messages at `/admin/contact`, where they are marked
read or deleted.

## Access

The screens under `/admin/contact` open for the accounts whose role is
`admin` or `staff`, the same pair the admin dashboard lets in. Any other
signed-in account gets 403 and does not see the Contact link in the sidebar,
and an anonymous visitor is sent to log in. The contact form stays open to
everyone, signed in or not.

There is no setting for these roles, and a refinement cannot replace the
views that check them, because it may add routes to this feature but never
replace one of its own. Another feature can decide for these screens with an
access policy registered for the prefix `contact.admin`
(`register_access_policy`, splent_framework 1.20.0). The framework asks the
policy before the roles. It answers True to let an account in, False to
refuse it, or None to leave the decision to the roles, and the sidebar link
follows the same answer. That is the way to let a group of accounts manage
only this section, for example the people who answer the visitors, without
giving them a panel role.
See [Access control](https://docs.splent.io/framework/access-control).

Without such a feature, give the person's account the staff role. Staff
opens every panel screen that asks for `PANEL_ROLES`, not only this one, so
a person who should read nothing but the contact inbox needs a policy
instead.

```bash
splent feature:auth set-role someone@example.com staff
```

## Use it in a product

```bash
splent feature:add splent_feature_contact
```

## Develop

```bash
splent feature:test splent_feature_contact
splent feature:contract splent_feature_contact
```

## Release

```bash
splent feature:release splent_feature_contact --dry-run --bump patch
splent feature:release splent_feature_contact
```

The first command rehearses the release and changes nothing. The second
publishes it to the git forge and to PyPI, and a PyPI version is permanent.
