Viewing docs for Mailgun v3.7.1
published on Monday, Mar 30, 2026 by Pulumi
published on Monday, Mar 30, 2026 by Pulumi
Mailgun Provider
I want to use the Pulumi Mailgun package (mailgun) in my project.
## Provider details
- Package: mailgun
- Version: v3.7.1
- Publisher: Pulumi
- Source: pulumi
- Repository: https://github.com/pulumi/pulumi-mailgun
## Documentation
The Pulumi Cloud Registry API serves canonical, up-to-date docs for this package — including private packages and every published version. Send the "Accept: text/markdown" header for clean readable content, or "application/json" for structured data.
Start at the navigation tree, which cross-links to the readme, installation guide, and per-resource docs URL template:
- https://api.pulumi.com/api/registry/packages/pulumi/pulumi/mailgun/versions/latest/nav
Returns a summary by default. The full tree can be hundreds of kB for large providers, so prefer targeted search: append "?q=<query>&depth=full" to filter by resource/function title or token (for example "?q=bucket&depth=full"). Only request the full nav without a query if you actually need to enumerate every resource.
Other endpoints:
- Overview and getting started: https://api.pulumi.com/api/registry/packages/pulumi/pulumi/mailgun/versions/latest/readme
- Installation and configuration: https://api.pulumi.com/api/registry/packages/pulumi/pulumi/mailgun/versions/latest/installation
- Per-resource/function docs: https://api.pulumi.com/api/registry/packages/pulumi/pulumi/mailgun/versions/latest/docs/{token}?lang={lang}
Replace {token} with the percent-encoded token from the nav response (for example aws:s3/bucket:Bucket).
Replace {lang} with typescript, python, go, csharp, java, or yaml.
Fetch the installation endpoint above for the correct setup steps — install instructions vary between native providers, bridged Terraform providers, and component packages.
Help me get started using this provider. Show me a complete Pulumi program that provisions a common resource, including all necessary configuration and imports.
Viewing docs for Mailgun v3.7.1
published on Monday, Mar 30, 2026 by Pulumi
published on Monday, Mar 30, 2026 by Pulumi
Installation
The Mailgun provider is available as a package in all Pulumi languages:
- JavaScript/TypeScript:
@pulumi/mailgun - Python:
pulumi-mailgun - Go:
github.com/pulumi/pulumi-mailgun/sdk/v3/go/mailgun - .NET:
Pulumi.Mailgun - Java:
com.pulumi/mailgun
Overview
The Mailgun provider is used to interact with the resources supported by Mailgun. The provider needs to be configured with the proper credentials before it can be used.
Use the navigation to the left to read about the available resources.
Example Usage
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: nodejs
config:
mailgun:apiKey:
value: 'TODO: "${var.mailgun_api_key}"'
import * as pulumi from "@pulumi/pulumi";
import * as mailgun from "@pulumi/mailgun";
// Create a new domain
const _default = new mailgun.Domain("default", {});
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: python
config:
mailgun:apiKey:
value: 'TODO: "${var.mailgun_api_key}"'
import pulumi
import pulumi_mailgun as mailgun
# Create a new domain
default = mailgun.Domain("default")
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: dotnet
config:
mailgun:apiKey:
value: 'TODO: "${var.mailgun_api_key}"'
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mailgun = Pulumi.Mailgun;
return await Deployment.RunAsync(() =>
{
// Create a new domain
var @default = new Mailgun.Domain("default");
});
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: go
config:
mailgun:apiKey:
value: 'TODO: "${var.mailgun_api_key}"'
package main
import (
"github.com/pulumi/pulumi-mailgun/sdk/v3/go/mailgun"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Create a new domain
_, err := mailgun.NewDomain(ctx, "default", nil)
if err != nil {
return err
}
return nil
})
}
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: yaml
config:
mailgun:apiKey:
value: 'TODO: "${var.mailgun_api_key}"'
resources:
# Create a new domain
default:
type: mailgun:Domain
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: java
config:
mailgun:apiKey:
value: 'TODO: "${var.mailgun_api_key}"'
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mailgun.Domain;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
// Create a new domain
var default_ = new Domain("default");
}
}
Configuration Reference
The following configuration inputs are supported:
apiKey- (Required) Mailgun API key
Viewing docs for Mailgun v3.7.1
published on Monday, Mar 30, 2026 by Pulumi
published on Monday, Mar 30, 2026 by Pulumi
