> For the complete documentation index, see [llms.txt](https://brightercommand.gitbook.io/paramore-brighter-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://brightercommand.gitbook.io/paramore-brighter-documentation/outbox-and-inbox/brighterinboxsupport/mongodbinbox.md).

# MongoDb Inbox

The MongoDB Inbox allows use of MongoDB for Brighter's inbox support.

> **Reference** · Applies to **Brighter V10**

## MongoDB Inbox Usage

The MongoDB Inbox allows use of MongoDB for [Brighter's inbox support](/paramore-brighter-documentation/outbox-and-inbox/brighterinboxsupport.md). The configuration is described in [Dispatcher Configuration Reference](/paramore-brighter-documentation/brighter-configuration/brighterbasicconfiguration/dispatcherconfigurationreference.md#inbox).

For this we will need the *Inbox* packages for the MongoDB *Inbox*.

* **Paramore.Brighter.Inbox.MongoDb**
* **Paramore.Brighter.MongoDb**

## MongoDB Inbox Configuration

### Basic Configuration

```csharp
private static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureServices((hostContext, services) =>
        {
            ConfigureBrighter(hostContext, services);
        });

private static void ConfigureBrighter(HostBuilderContext hostContext, IServiceCollection services)
{
    // MongoDB connection string
    var connectionString = "mongodb://localhost:27017";
    var databaseName = "BrighterDatabase";
    
    // Configure MongoDB
    var mongoDbConfiguration = new MongoDbConfiguration(connectionString, databaseName)
    {
        Inbox = new MongoDbCollectionConfiguration
        {
            Name = "Inbox",
            MakeCollection = OnResolvingACollection.Validate,
            TimeToLive = TimeSpan.FromDays(7) // Optional: Auto-expire messages after 7 days
        }
    };

    services.AddConsumers(options =>
    {
        options.InboxConfiguration = new InboxConfiguration(
            new MongoDbInbox(mongoDbConfiguration),
            scope: InboxScope.Commands,
            onceOnly: true,
            actionOnExists: OnceOnlyAction.Throw
        );
    });
}
```

In Brighter 10.7.0 this configuration takes effect only in an application that also calls `AddProducers`; see [Global Inbox Configuration in a Consumer-Only Application](/paramore-brighter-documentation/outbox-and-inbox/brighterinboxsupport.md#global-inbox-configuration-in-a-consumer-only-application).

### Advanced Configuration

For more advanced scenarios, you can provide custom MongoDB client settings and collection configurations:

```csharp
private static void ConfigureBrighter(HostBuilderContext hostContext, IServiceCollection services)
{
    // Create MongoDB client with custom settings
    var mongoClient = new MongoClient(new MongoClientSettings
    {
        ConnectionString = new ConnectionString("mongodb://localhost:27017"),
        RetryWrites = true,
        RetryReads = true
    });
    
    var mongoDbConfiguration = new MongoDbConfiguration(mongoClient, "BrighterDatabase")
    {
        Inbox = new MongoDbCollectionConfiguration
        {
            Name = "Inbox",
            MakeCollection = OnResolvingACollection.Create,
            TimeToLive = TimeSpan.FromHours(24),
            Settings = new MongoCollectionSettings
            {
                ReadPreference = ReadPreference.Primary,
                WriteConcern = WriteConcern.WMajority
            },
            CreateCollectionOptions = new CreateCollectionOptions
            {
                // Additional collection creation options if needed
            }
        }
    };

    services.AddConsumers(options =>
    {
        options.InboxConfiguration = new InboxConfiguration(
            new MongoDbInbox(mongoDbConfiguration),
            scope: InboxScope.Commands,
            onceOnly: true,
            actionOnExists: OnceOnlyAction.Throw
        );
    });
}
```

### Using a Connection Provider

You can also use a custom connection provider for more control over the MongoDB connection:

```csharp
private static void ConfigureBrighter(HostBuilderContext hostContext, IServiceCollection services)
{
    var mongoDbConfiguration = new MongoDbConfiguration("mongodb://localhost:27017", "BrighterDatabase")
    {
        Inbox = new MongoDbCollectionConfiguration
        {
            Name = "Inbox",
            MakeCollection = OnResolvingACollection.Validate
        }
    };
    
    var connectionProvider = new MongoDbConnectionProvider(mongoDbConfiguration);

    services.AddConsumers(options =>
    {
        options.InboxConfiguration = new InboxConfiguration(
            new MongoDbInbox(connectionProvider, mongoDbConfiguration),
            scope: InboxScope.Commands,
            onceOnly: true,
            actionOnExists: OnceOnlyAction.Throw
        );
    });
}
```

## MongoDB Inbox Collection Management

The MongoDB Inbox supports different strategies for collection management through the `MakeCollection` property:

* **`OnResolvingACollection.Assume`**: Assumes the collection already exists (default behavior)
* **`OnResolvingACollection.Validate`**: Validates that the collection exists, throws an exception if it doesn't
* **`OnResolvingACollection.Create`**: Creates the collection if it doesn't exist

## MongoDB Inbox Time-To-Live (TTL) Support

The MongoDB Inbox supports automatic message expiration using MongoDB's TTL feature. You can configure this through the `TimeToLive` property in the collection configuration:

```csharp
Inbox = new MongoDbCollectionConfiguration
{
    Name = "Inbox",
    TimeToLive = TimeSpan.FromDays(30) // Messages will be automatically deleted after 30 days
}
```

When TTL is configured, MongoDB will automatically create a TTL index on the `TimeStamp` field and remove expired documents.

## MongoDB Inbox Message Structure

The MongoDB Inbox stores messages with the following structure:

* **Id**: Composite key containing the command ID and context key
* **TimeStamp**: When the message was created
* **CommandType**: The full type name of the command
* **CommandBody**: JSON serialized command data
* **ExpireAfterSeconds**: Optional expiration time for individual messages

## MongoDB Inbox Error Handling

The MongoDB Inbox will throw appropriate exceptions for various error conditions:

* **ArgumentException**: When required configuration is missing
* **InboxException**: For inbox-specific errors like duplicate messages when `OnceOnlyAction.Throw` is configured

## Dependencies

The MongoDB Inbox requires the following NuGet packages:

```powershell
dotnet add package Paramore.Brighter.Inbox.MongoDb
dotnet add package Paramore.Brighter.MongoDb
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://brightercommand.gitbook.io/paramore-brighter-documentation/outbox-and-inbox/brighterinboxsupport/mongodbinbox.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.