Mailbox provider

Mailbox Provider provides a unified Drupal API for accessing and processing email messages from Microsoft 365 and Google Workspace mailboxes. It allows administrators and developers to configure mailbox connections without needing provider-specific code.

Features

Mailbox Provider provides a provider-neutral interface for reading and working with email messages across different mailbox services.

Features include:

• Support for Microsoft 365 mailboxes through Microsoft Graph.
• Support for Google Workspace mailboxes through the Gmail API.
• Provider-neutral mailbox API for custom Drupal integrations.
• Configurable mailbox connections and folder selection.
• Integration with OAuth Provider for secure authentication.
• Support for inbox and sent mail access.
• User-specific OAuth token handling.
• Extensible provider architecture for additional mailbox services.

Typical use cases include:

• Processing inbound support or service mailboxes.
• Building email-driven workflows.
• Automating message triage and classification.
• Creating integrations between mailboxes and business systems.
• Monitoring shared mailboxes.
• Importing or analysing email content inside Drupal.

Post-Installation

After installing and enabling the module:

1. Install and configure the Key module.
2. Install and configure OAuth Provider.
3. Create an OAuth account under Configuration > OAuth Service Accounts.
4. Configure the required Microsoft 365 or Google Workspace permissions.
5. Create a mailbox connection under Configuration > Mailbox Connections.
6. Select the mailbox provider, mailbox account, and folder to access.
7. Authorize a mailbox token for the Drupal user who will access the mailbox.

Once configured, the mailbox connection can be used by custom modules or other integrations to read and process email messages.

Mailbox Provider does not create content types or editorial workflows. Instead, it provides mailbox configuration entities and services that can be consumed by other modules.

Additional Requirements

Required:

• Drupal 11
• Key module
• OAuth Provider
• A Microsoft Entra ID application or Google Cloud OAuth application
• Appropriate mailbox permissions and OAuth scopes

Recommended Modules/Libraries

Mailbox Provider works particularly well alongside:

• OAuth Provider for authentication and token management.
• Service Queue modules for asynchronous email processing.
• Microsoft Graph integrations.
• Workflow and automation modules.
• Custom business integration modules.

Similar Projects

Several modules connect Drupal to email systems, but most focus on sending email or implementing provider-specific integrations.

Mailbox Provider focuses on providing a reusable, provider-neutral mailbox abstraction layer that allows consuming modules to interact with mailboxes using a consistent API regardless of the underlying provider.

This allows developers to build integrations once and support multiple mailbox platforms with minimal additional code.

Supporting this Module

Issues, feature requests, bug reports, and merge requests are welcome through the Drupal.org issue queue.

Community feedback helps improve provider support, mailbox capabilities, and developer tooling.

Community Documentation

Documentation currently includes:

• Installation and configuration guidance.
• Mailbox connection setup examples.
• Microsoft 365 configuration guidance.
• Google Workspace configuration guidance.
• Developer examples for reading mailbox messages.

Additional tutorials, example integrations, and walkthroughs will be added as the project evolves.

Developer Notes

Mailbox Provider exposes stable provider-neutral interfaces for mailbox services and messages, allowing custom modules to work with email content without needing to understand provider-specific APIs.

The module is designed as a reusable foundation for email-driven integrations, workflow automation, message processing, and enterprise mailbox solutions built on Drupal.