Files
OpenArchiver/docs/api/ingestion.md
Wei S. 0c42b30c9e V0.5.1 dev (#341)
* OpenAPI root url fix

* Journaling OSS setup

* feat: add preserve-original-file mode for email ingestion for GoBD compliance

- Add `preserveOriginalFile` option to ingestion sources and connectors
- Stream original EML/MBOX/PST emails to temp files instead of holding
  full buffers in memory, reducing memory allocation during ingestion
- Skip attachment binary extraction and EML re-serialization when
  preserve mode is enabled; use raw file on disk as source of truth
- Update `EmailObject` to use `tempFilePath` instead of in-memory `eml`
  buffer across all connectors (EML, MBOX, PST)
- Add new database migration (0032) for `preserve_original_file` column
- Add frontend UI toggle with tooltip (tippy.js) for the new option
- Replace console.warn calls with structured pino logger in connectors

* add isjournaled property to archived_email

* feat(ingestion): add unmerge ingestion source functionality

Introduces the ability to detach a child ingestion source from its
merge group, making it a standalone root source. Changes include:

- Add `unmerge` controller method with auth and error handling
- Add POST `/v1/ingestion-sources/{id}/unmerge` route with OpenAPI docs
- Implement `IngestionService.unmerge` backend logic
- Add unmerge UI action and handler in the frontend ingestion view
- Fix bulk delete to also remove children of deleted root sources
- Update docs with new API operation and merging sources user guide

* code formatting

* Database migration file for enum `partially_active`

* Error handling improvement
2026-03-30 22:29:03 +02:00

44 lines
941 B
Markdown

---
aside: false
---
# Ingestion API
Manage ingestion sources — the configured connections to email providers (Google Workspace, Microsoft 365, IMAP, and file imports). Credentials are never returned in responses.
## Create an Ingestion Source
<OAOperation operationId="createIngestionSource" />
## List Ingestion Sources
<OAOperation operationId="listIngestionSources" />
## Get an Ingestion Source
<OAOperation operationId="getIngestionSourceById" />
## Update an Ingestion Source
<OAOperation operationId="updateIngestionSource" />
## Delete an Ingestion Source
<OAOperation operationId="deleteIngestionSource" />
## Trigger Initial Import
<OAOperation operationId="triggerInitialImport" />
## Pause an Ingestion Source
<OAOperation operationId="pauseIngestionSource" />
## Force Sync
<OAOperation operationId="triggerForceSync" />
## Unmerge an Ingestion Source
<OAOperation operationId="unmergeIngestionSource" />