Skip to content

Kentico/xperience-by-kentico-virtual-inbox

Xperience by Kentico Virtual Inbox

Kentico Labs CI: Build and Test

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

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?

Screenshots

Administration UI virtual inbox Agent driven virtual inbox MCP server Agent waiting for subscription email via Virtual Inbox MCP

Requirements

Library Version Matrix

Xperience Version Library Version
>= 31.2.0 1.0.0

Dependencies

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:

    // ...
    
    if (env.IsDevelopment())
    {
       builder.Services
         // Adds this library's services
         .AddVirtualInboxClient(builder.Configuration)
         .AddMcpServer() // Host application is responsible for adding the McpServer
         .WithHttpTransport()
         .WithVirtualInboxTools(); // Adds this library's MCP tools
    }
    else
    {
       // Adds this library's services without email capture
       builder.Services.AddVirtualInboxCore();
    }
    // ...
  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"
        }
      }
    }

Warning

If used in a production environment, the MCP server exposes customer data without any authentication. The MCP server feature is intended for development-environments only.

Use environment identification extensions or environment specific settings to disable the MCP server for non-local deployments.

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

Kentico Labs

This project has Kentico Labs limited support.

See SUPPORT.md for more information.

For any security issues see SECURITY.md.

About

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

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Contributors