Kentico.Xperience.VirtualInbox 1.0.0

Xperience by Kentico Virtual Inbox

Package	NuGet
Kentico.Xperience.VirtualInbox
Kentico.Xperience.VirtualInbox.Admin
Kentico.Xperience.VirtualInbox.MCP

Description

An in-app hosted virtual inbox for email channel development, testing, and AI agent email access.

What are some use cases for this integration?

• AI agent validation of email content and rendering after code changes.
• AI agent-driven E2E testing of visitor journeys, like automations and membership experiences.
• AI agent-driven customer data generation to validate marketing features like activity tracking for emails and custom activities, content personalization, and customer journeys.
• Demo environments that need email "delivery" without delivering to a real inbox.
• "View this email in your browser" by displaying captured email on a website channel.
• Maintain a clean email queue when you don't have SMTP delivery support in your environment.

Screenshots

Requirements

Library Version Matrix

Dependencies

• ASP.NET Core 8.0
• Xperience by Kentico

Package Installation

Add these package to your application using the .NET CLI.

The core package adds the integration's object types and custom email client.

dotnet add package Kentico.Xperience.VirtualInbox

The admin project adds the virtual inbox administration UI application to the project.

dotnet add package Kentico.Xperience.VirtualInbox.Admin

The MCP project adds Virtual Inbox MCP tools that you can register on your application's MCP server.

dotnet add package Kentico.Xperience.VirtualInbox.MCP

Quick Start

1. Add the Admin and MCP NuGet packages to your Xperience by Kentico ASP.NET Core application.

2. Register the integration's services, an MCP server and the integration's MCP tools:

   // ...
   builder.Services.AddVirtualInboxClient(builder.Configuration); // Adds this library's services
   if (env.IsDevelopment())
   {
      builder.Services
        .AddMcpServer() // Host application is responsible for adding the McpServer
        .WithHttpTransport()
        .WithVirtualInboxTools(); // Adds this library's MCP tools
   }
   // ...
   

3. Enable the MCP server in the middleware pipeline:

   // ...
   app.Kentico().MapRoutes();
   
   if (env.IsDevelopment())
   {
      app.MapMcp("/mcp"); // Host application is responsible for adding the endpoint
   }
   // ...
   

4. Update your appsettings.Development.json to enable the library features:

    "Kentico": {
      "VirtualInbox": {
        "Enabled": true,
      }
    },
   

5. Configure your MCP server for your AI enabled development tool

   {
     "servers": {
       "kentico.docs.mcp": {
         "type": "http",
         "url": "https://docs.kentico.com/mcp"
       },
       "your-app": {
         "type": "http",
         "url": "http://localhost:23146/mcp"
       }
     }
   }
   

Full Instructions

View the Usage Guide for more detailed instructions.

Contributing

To see the guidelines for Contributing to Kentico open source software, please see Kentico's CONTRIBUTING.md for more information and follow the Kentico's CODE_OF_CONDUCT.

Instructions and technical details for contributing to this project can be found in Contributing Setup.

License

Distributed under the MIT License. See LICENSE.md for more information.

Support

This project has Kentico Labs limited support.

See SUPPORT.md for more information.

For any security issues see SECURITY.md.