RapidMX: Autodiscover

Autodiscover support for a RapidMX mail server. Lets a real mail client find this deployment's @rapidmx/activesync-plugin (EAS) and @rapidmx/mapi-plugin server URLs from just an email address: classic POX (POST /autodiscover/autodiscover.xml, serving either the EAS-only MobileSync response or, when a real Outlook desktop client requests it via AcceptableResponseSchema, an Outlook/EXCH response pointing at the MAPI/HTTP endpoint) and the modern JSON variant Microsoft calls "Autodiscover v2" (GET /autodiscover/autodiscover.json/v1.0/<email>?Protocol=ActiveSync, EAS only — this package has no separate JSON discovery variant for MAPI).

Both endpoints are intentionally unauthenticated, matching Autodiscover v2's own spec design: they reveal nothing but deployment-wide server URLs (not secrets) once the requested address is confirmed to belong to a real mailbox — real mailbox access is still fully gated by the JWT-protected EAS/MAPI/REST layers. For a real device to find these endpoints at all, the deployment's DNS needs a CNAME record for autodiscover.<your-domain> (and, optionally, a _autodiscover._tcp SRV record) pointing at wherever this server is mounted — an ops/deployment task, not something this package configures.

Features

• Classic POX Autodiscover (POST /autodiscover/autodiscover.xml) per [MS-ASCMD]'s MobileSync request/ response schema
• A real Outlook desktop response shape per [MS-OXDSCLI]'s Outlook/EXCH 2006a schema, served automatically instead of the MobileSync response whenever a request's AcceptableResponseSchema asks for it — points a real Outlook client at this deployment's MAPI/HTTP endpoint instead of EAS
• Autodiscover v2 (JSON) (GET /autodiscover/autodiscover.json/v1.0/:email?Protocol=ActiveSync) for modern clients that skip the POX request/response XML entirely
• Mailbox resolution against both Mailbox.primarySmtpAddress and Mailbox.aliasAddresses
• Deliberately unauthenticated by design — reveals only deployment-wide server URLs, never a per-mailbox secret
• MongoDB and SQL persistence backends (@rapidmx/autodiscover-plugin/mongo, @rapidmx/autodiscover-plugin/sql)

Installation

NPM

npm i @rapidmx/autodiscover-plugin

Yarn

yarn add @rapidmx/autodiscover-plugin

Requirements

This package targets Node.js >=24.0.0 and is published as an ESM-only package.

The following peer dependencies are required:

| Peer dependency | Required for | | -------------------------- | ------------ | | @rapidmx/restapi | Always | | @rapidrest/core | Always | | @rapidrest/service-core | Always |

Usage

Mount AutodiscoverRouteMongo/AutodiscoverRouteSQL (from @rapidmx/autodiscover-plugin/mongo or /sql) with a one-line subclass supplying your deployment's EAS and MAPI URLs:

import { AutodiscoverRouteMongo } from "@rapidmx/autodiscover-plugin/mongo";
import { RouteDecorators } from "@rapidrest/service-core";
const { Route } = RouteDecorators;

@Route("/autodiscover")
export class MyAutodiscoverRoute extends AutodiscoverRouteMongo {
    protected readonly easUrl = "https://mail.example.com/Microsoft-Server-ActiveSync";
    protected readonly mapiUrl = "https://mail.example.com/mapi/emsmdb";
    protected readonly nspiUrl = "https://mail.example.com/mapi/nspi";
}

Requires a @rapidmx/restapi-backed Mailbox model to resolve addresses against.

Status

Complete. This package was carved out of the former @rapidrest/mail monolith — see .claude/NOTES.md for the split's own rationale and history.

License

MPL v2.0 — see LICENSE.