50 lines
2.4 KiB
Markdown
50 lines
2.4 KiB
Markdown
|
# Reuse surface
|
||
|
|
|
||
|
|
This repository is the email building block for a multimodal communication
|
||
|
|
framework that is yet to be designed (INTENT.md, *Mode reference
|
||
|
|
implementation*). This page says what such a framework can depend on, and
|
||
|
|
how stable each part is.
|
||
|
|
|
||
|
|
## Depend on these
|
||
|
|
|
||
|
|
| Part | Where | Stability |
|
||
|
|
|---|---|---|
|
||
|
|
| MAS address spec | `mas-v0.1-spec/` (v0.1.1), `mas-v0.2-spec/` (draft) | v0.1.1 stable. v0.2 draft until a second implementation passes its corpus (MAS-WP-0009) |
|
||
|
|
| Mode contract | `mas-modes-v0.1-spec/` | v0.1 draft. Changes are versioned; messages carry `mas_modes_version` |
|
||
|
|
| Gateway event | `mas-modes-v0.1-spec/schema/mas-event-v0.1.schema.json` | v0.1. Events carry `mas_event_version` |
|
||
|
|
| Conformance corpora | the bundles' `conformance/` | Normative for their version. Consume them unchanged |
|
||
|
|
| `mas_core` | parse (no I/O), discover (exact host), resolve (pure), generate / `for_destination` | Python reference library |
|
||
|
|
| `mas_gateway` | MTA `pipe` and provider `webhook` → event | Reference adapter. The event is the interface, not the code |
|
||
|
|
| Postfix profile | `integrations/postfix/` | Tested against Postfix 3.7 (`tests/test_postfix_profile.py`) |
|
||
|
|
|
||
|
|
## Integrating as an outside master
|
||
|
|
|
||
|
|
Configure the resource type as `slave` (`mas_modes.email_mode.RoleConfig`)
|
||
|
|
and point `master_url` at your system. You then:
|
||
|
|
|
||
|
|
- receive `case.intake` and `case.message`, each carrying a gateway event;
|
||
|
|
- answer `case.assign` with your own case id; email adopts it as
|
||
|
|
`TYPE=ID@domain`;
|
||
|
|
- send replies with `mail.send` (`in_reply_to` a recorded message);
|
||
|
|
principle 10 can refuse them;
|
||
|
|
- decide per case on `autonomous_send` and `transfers` (`block`, or your
|
||
|
|
mode webhook);
|
||
|
|
- own every timeout; end a handoff with `handoff.cancel`.
|
||
|
|
|
||
|
|
## Integrating a mode
|
||
|
|
|
||
|
|
Implement the mode endpoint in CONTRACT.md: accept `handoff.request`,
|
||
|
|
`handoff.update` and `handoff.cancel`, and post `handoff.status` to
|
||
|
|
`status_url` with an increasing `seq`. Never send `timed-out`.
|
||
|
|
`mas_modes/stubs/callback.py` is a complete example.
|
||
|
|
|
||
|
|
## Examples only, not products
|
||
|
|
|
||
|
|
- `examples/ticket_service/`: the reference ticket service, used as the
|
||
|
|
store for email-mastered cases.
|
||
|
|
- `mas_modes/stubs/`: the callback stub and the stub outside master.
|
||
|
|
They never contact a person or a service.
|
||
|
|
- `mas_modes/email_mode.py`: the reference email side. It is
|
||
|
|
single-process, with SQLite and no authentication on its HTTP endpoints,
|
||
|
|
so it is fit for loopback and tests. The contract is the interface.
|