Mailgun Inspect for VS Code

Preview your HTML emails across 100+ email clients and run content analysis directly from VS Code, powered by the Mailgun Inspect API.

Features

Multi-client previews — render your HTML against 100+ desktop, web, and mobile email clients.
Content checks — automatic link validation, image validation, accessibility checks, and HTML/CSS code analysis.
Spam testing — view inbox placement results alongside your previews.
In-editor workflow — generate previews from the editor title bar of any .html file.

Requirements

A Mailgun account with API access. Generate an API key from your Mailgun control panel.
VS Code 1.85 or newer.

Getting Started

Install Mailgun Inspect from the VS Code Marketplace.
Open the command palette and run Mailgun Inspect: Set API Key to securely store your credentials.
Select your Region (US or EU) in Mailgun Inspect: Open Settings.
Open an HTML email file and click the eye icon in the editor title bar — or run Mailgun Inspect: Generate Preview.
The first time you generate a preview, you'll be prompted to pick which email clients to render against. Your selection is saved as the default; change it any time with Mailgun Inspect: Select Clients.

Commands

Command	Description
`Mailgun Inspect: Generate Preview`	Render the active HTML file across your selected clients.
`Mailgun Inspect: Select Clients`	Choose which email clients to use by default.
`Mailgun Inspect: Set API Key`	Securely store your Mailgun API key.
`Mailgun Inspect: Open Settings`	Jump to the extension's settings.

Settings

Setting	Default	Description
`mailgunInspect.region`	`US`	Mailgun API region (`US` or `EU`).
`mailgunInspect.defaultClients`	`[]`	Email client IDs to use by default.
`mailgunInspect.pollIntervalMs`	`5000`	How often to poll for preview results, in milliseconds.
`mailgunInspect.contentChecking.linkValidation`	`true`	Run link validation when generating previews.
`mailgunInspect.contentChecking.imageValidation`	`true`	Run image validation when generating previews.
`mailgunInspect.contentChecking.accessibility`	`true`	Run accessibility checks when generating previews.
`mailgunInspect.contentChecking.codeAnalysis`	`true`	Run HTML/CSS compatibility analysis when generating previews.
`mailgunInspect.contentChecking.spamTesting`	`true`	Show the Spam Testing tab for inbox placement testing.

Some content checks require an entitled Mailgun plan. If a check is not available on your account, the corresponding tab will indicate that the feature is not enabled.

Privacy

The extension sends the HTML of the active editor to the Mailgun Inspect API for rendering and analysis. No content leaves your machine until you explicitly trigger a preview.

Use of Sinch Services

This extension provides developers with a way to interact with Sinch APIs and services from supported developer tools or environments. Use of Sinch services requires a valid Sinch account and is subject to the applicable Sinch Terms of Service available at: Explore Terms of Service - Sinch

This extension may be used in conjunction with third-party developer tools, IDEs, platforms, or environments that are not operated or controlled by Sinch. Such third-party tools or platforms are subject to their own terms and policies. The extension is provided on an "as-is" basis, and Sinch is not responsible for the operation, availability, performance, or security of any third-party tools or platforms.

Support

For Mailgun account or API questions, contact Mailgun support through your account.

Telemetry

Sinch's Conversation API VS Code Extension may collect limited telemetry data to help us understand usage and improve the extension's experience. The extension does not collect any personal data or any message content. Telemetry collection follows the user's global telemetry setting in Visual Studio Code and will be disabled if telemetry is turned off in VS Code settings.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.