How apache/james-project works
Apache James is a modular JVM mail-server platform. Users connect through mail protocols; the server exposes mailbox operations, applies configurable mail-treatment rules, and stores messages and related state using selectable backends. The tree also shows search, quota, event delivery, background tasks, backup, and recovery capabilities. The graph preserves these major product areas, but the sampled sources do not expose protocol-to-mailbox routing or most subsystem wiring, so those relationships are omitted rather than inferred.
Main entry points: StoreMailboxManager.java Mailbox stores · MessageManager.java Mailbox API · S3RecoveryService.java S3 recovery · protocols Mail protocols
Components 21
Mail handling
- Mail protocols
protocols - Mailbox API
mailbox/api/src/main/java/org/apache/james/mailbox/MessageManager.java - Mailet treatment
mailet/api/src/main/java/org/apache/mailet/StorageDirective.java
Mailbox and data
- Mailbox model
mailbox/api/src/main/java/org/apache/james/mailbox/model/Mailbox.java - User identity
core/src/main/java/org/apache/james/core/Username.java - Users repository
server/data/data-api/src/main/java/org/apache/james/user/api/UsersRepository.java - Mailbox stores
mailbox/store/src/main/java/org/apache/james/mailbox/store/StoreMailboxManager.java - Quota management
mailbox/api/src/main/java/org/apache/james/mailbox/quota/MaxQuotaManager.java - Message search
mailbox/opensearch/src/main/java/org/apache/james/mailbox/opensearch/query/QueryConverter.java
Platform services
- Event bus
event-bus/api/src/main/java/org/apache/james/events/EventBus.java - Distributed delivery
event-bus/distributed/src/main/java/org/apache/james/events/RabbitMQEventBus.java - Task manager
server/task/task-api/src/main/java/org/apache/james/task/TaskManager.java - Health checks
core/src/main/java/org/apache/james/core/healthcheck/Result.java
Operations
- Mailbox backup
mailbox/backup/src/main/java/org/apache/james/mailbox/backup/ArchiveService.java - S3 recovery
server/apps/distributed-app/src/main/java/org/apache/james/S3RecoveryService.java
Storage integrations
- Cassandra backend
backends-common/cassandra/src/main/java/org/apache/james/backends/cassandra/components/CassandraDataDefinition.java - Postgres backend
backends-common/postgres/src/main/java/org/apache/james/backends/postgres/PostgresDataDefinition.java - OpenSearch backend
backends-common/opensearch/src/main/java/org/apache/james/backends/opensearch/OpenSearchIndexer.java - RabbitMQ backend
backends-common/rabbitmq/src/main/java/org/apache/james/backends/rabbitmq/RabbitMQConnectionFactory.java - S3 object storage
server/blob/blob-api/src/main/java/org/apache/james/blob/api/BlobStore.java
Other components
- Mail clients
Connections 21
- Mail clients → Mail protocols: connects through
- Mail protocols → Mailbox API: serves mail operations
- Mailbox API → Mailet treatment: applies directives
- Mailet treatment → Mailbox stores: guides storage
- Mailbox stores → Mailbox model: stores mailboxes
mailbox/store/src/main/java/org/apache/james/mailbox/store/StoreMailboxManager.java - Mailbox API → User identity: uses user identity
- Users repository → User identity: indexes users
server/data/data-api/src/main/java/org/apache/james/user/api/UsersRepository.java - Mailbox stores → Cassandra backend: persists with
- Mailbox stores → Postgres backend: persists with
- Mailbox stores → Quota management: supports quota
- Mailbox stores → Message search: supports search
- Mailbox API → Event bus: publishes events
- Event bus → Distributed delivery: dispatches events
- Task manager → S3 recovery: runs recovery task
- Mailbox backup → Mailbox model: archives messages
mailbox/backup/src/main/java/org/apache/james/mailbox/backup/ArchiveService.java - S3 recovery → Mailbox API: restores mail
server/apps/distributed-app/src/main/java/org/apache/james/S3RecoveryService.java - S3 recovery → S3 object storage: reads blobs
server/apps/distributed-app/src/main/java/org/apache/james/S3RecoveryService.java - Message search → OpenSearch backend: queries index
- Distributed delivery → RabbitMQ backend: uses broker
- Cassandra backend → Health checks: reports health
- Postgres backend → Health checks: reports health