Mailgun

https://documentation.mailgun.com/docs/mailgun/
Admin
Mailgun is a powerful email API platform that enables developers to send, receive, and track email...
Tokens:142,910
Snippets:1,196
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install Mailgun Go SDK with go get

Source: https://documentation.mailgun.com/docs/mailgun/sdk/go_sdk

Install the Mailgun Go SDK v5 using the go get command. Ensure you include the /v5 suffix in the import path when using Go modules.

```bash
$ go get github.com/mailgun/mailgun-go/v5
```

--------------------------------

### Get Accessibility Tests - Response Example

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/inspect/accessibility

Example JSON response for the GET /v1/inspect/accessibility endpoint. It shows the meta object with a count, paging links for pagination, and an items array containing test details.

```json
{
  "meta": {
    "count": 9
  },
  "paging": {
    "first": "https://api.mailgun.net/v1/inspect/accessibility/tests?limit=100&skip=0",
    "last": "https://api.mailgun.net/v1/inspect/accessibility/tests?limit=100&skip=0"
  },
  "items": [
    { … }
  ]
}
```

--------------------------------

### Example 200 response JSON

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/users/get-v5-users-me

Example 200 response body for the GET /v5/users/me endpoint. Shows the structure of user details including id, email, preferences, and authentication fields.

```json
{
  "id": "123",
  "name": "John Doe",
  "activated": true,
  "is_disabled": false,
  "email": "johndoe@example.com",
  "email_details": {
    "address": "johndoe@example.com",
    "is_valid": true,
    "parts": { … }
  },
  "role": "basic",
  "account_id": "567",
  "opened_ip": "67.111.60.111",
  "is_master": true,
  "metadata": {},
  "tfa_enabled": true,
  "tfa_active": true,
  "tfa_created_at": "2022-12-20T16:52:01.892000",
  "password_updated_at": "2022-12-20T16:52:01.892000",
  "preferences": {
    "programming_language": "curl",
    "time_format": "%m/%d/%y %I:%M %p",
    "time_zone": "US/Eastern"
  },
  "auth": {
    "method": "sinch",
    "prior_details": {},
    "prior_method": ""
  },
  "github_user_id": null,
  "salesforce_user_id": null,
  "migration_status": "done"
}
```

--------------------------------

### Example response for GET /v5/users

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/users/get-v5-users

Shows a sample 200 response body containing a list of users and the total count. The 'total' field indicates the total number of users matching the query.

```json
{
  "users": [
    { … }
  ],
  "total": 1
}
```

--------------------------------

### Install Composer

Source: https://documentation.mailgun.com/docs/mailgun/sdk/php_sdk

Command to install Composer, the PHP package manager, if not already installed.

```bash
curl -sS https://getcomposer.org/installer | php
```

--------------------------------

### 200 Response body for GET /v3/ip_warmups

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ip-address-warmup

Example 200 response body for the GET /v3/ip_warmups request. Contains an `items` array of warmup statuses and a `paging` object with URLs for the first and next pages.

```json
{
  "items": [
    { … },
    { … }
  ],
  "paging": {
    "first": "first",
    "next": "next"
  }
}
```

--------------------------------

### Clone and install Mailgun Python SDK locally

Source: https://documentation.mailgun.com/docs/mailgun/sdk/python_sdk

Clone the repository and install it locally with pip.

```bash
git clone https://github.com/mailgun/mailgun-python
cd mailgun-python
```

```bash
pip install .
```

--------------------------------

### Get templates - 200 response body

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-templates

Example JSON response for a successful request. Shows the structure with items and paging information.

```json
{
  "items": [
    { … },
    { … }
  ],
  "paging": {
    "previous": "https://api.mailgun.net/v3/{domain}/templates?page=previous&p=template.0&limit=10",
    "first": "https://api.mailgun.net/v3/{domain}/templates?limit=10",
    "next": "https://api.mailgun.net/v3/{domain}/templates?page=next&p=template.2&limit=10",
    "last": "https://api.mailgun.net/v3/{domain}/templates?page=last&limit=10"
  }
}
```

--------------------------------

### Get List Health Preview Job - Response Example

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/validate/list-health-preview

Example JSON response for a successful list health preview job retrieval. The 'id' field matches the requested list ID, and 'status' indicates the preview is complete. The 'summary' object contains result and risk details.

```json
{
  "id": "SampleList",
  "valid": true,
  "status": "preview_complete",
  "quantity": 1,
  "created_at": 1234567890,
  "summary": {
    "result": { … },
    "risk": { … }
  }
}
```

--------------------------------

### Install Mailgun Python SDK with pip

Source: https://documentation.mailgun.com/docs/mailgun/sdk/python_sdk

Install the Mailgun SDK for Python using pip.

```bash
pip install mailgun
```

--------------------------------

### Install Mailgun Python SDK with conda and make

Source: https://documentation.mailgun.com/docs/mailgun/sdk/python_sdk

Install locally using conda and make on Unix platforms.

```bash
make install
```

--------------------------------

### Install mailgun.js

Source: https://documentation.mailgun.com/docs/mailgun/sdk/nodejs_sdk

Install the mailgun.js package using npm. Requires node.js >= 18.x.

```bash
npm install mailgun.js
```

--------------------------------

### Install mailgun-ruby via RubyGems

Source: https://documentation.mailgun.com/docs/mailgun/sdk/ruby_sdk

Install the Mailgun Ruby gem using the gem install command.

```bash
gem install mailgun-ruby
```

--------------------------------

### Install Mailgun PHP SDK via Composer (local)

Source: https://documentation.mailgun.com/docs/mailgun/sdk/php_sdk

Composer command to install the Mailgun PHP SDK using a local Composer installation (php composer.phar).

```bash
php composer.phar require mailgun/mailgun-php symfony/http-client nyholm/psr7
```

--------------------------------

### Set up basic development environment with conda

Source: https://documentation.mailgun.com/docs/mailgun/sdk/python_sdk

Create a basic environment with a minimum number of dependencies.

```bash
make dev
conda activate mailgun
```

--------------------------------

### Set up full development environment with conda

Source: https://documentation.mailgun.com/docs/mailgun/sdk/python_sdk

Create a full development environment.

```bash
make dev-full
conda activate mailgun-dev
```

--------------------------------

### Get domains - 200 response

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domains

Example JSON response for a successful GET /v4/domains request. It includes a total_count and an items array containing domain objects.

```json
{
  "total_count": 1,
  "items": [
    { … }
  ]
}
```

--------------------------------

### Example response for get members by page

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-lists-list_address-members-pages

This is an example JSON response from the Mailgun API when retrieving members by page. It includes pagination links and an array of member items.

```json
{
  "paging": {
    "first": "https://url_to_first_page",
    "last": "https://url_to_last_page",
    "next": "https://url_to_next_page",
    "previous": "https://url_to_previous_page"
  },
  "items": [
    { … },
    { … }
  ]
}
```

--------------------------------

### GET /v1/inboxready/domains - 200 response

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/inboxready/domains

Example 200 response body for the GET request, showing the items array and paging object with previous, first, next, and last links.

```json
{
  "items": [
    { … }
  ],
  "paging": {
    "previous": "https://....",
    "first": "https://....",
    "next": "https://....",
    "last": "https://...."
  }
}
```

--------------------------------

### Send an email with Mailgun Go SDK

Source: https://documentation.mailgun.com/docs/mailgun/sdk/go_sdk

Complete Go example that sends an email using the Mailgun SDK. It creates a Mailgun client with your private API key, builds a message with sender, subject, body, and recipient, and sends it with a 10-second timeout. The example includes commented lines for EU domain endpoint configuration and notes where to find your domain and API key.

```go
package main

import (
	"context"
	"fmt"
	"log"
	"time"

	"github.com/mailgun/mailgun-go/v5"
)

// Your available domain names can be found here:
// (https://app.mailgun.com/mg/sending/domains)
var yourDomain = "your-domain-name" // e.g. mg.yourcompany.com

// You can find the Private API Key in your Account Menu, under "Account Settings":
// (https://app.mailgun.com/settings/api_security)
var privateAPIKey = "your-private-key"

func main() {
	// Create an instance of the Mailgun Client
	mg := mailgun.NewMailgun(privateAPIKey)
	
	// When you have an EU domain, you must specify the endpoint:
	// mg.SetAPIBase(mailgun.APIBaseEU)

	sender := "sender@mg.yourcompany.com"
	subject := "Fancy subject!"
	body := "Hello from Mailgun Go!"
	recipient := "recipient@example.com"

	// The message object allows you to add attachments and Bcc recipients
	message := mg.NewMessage(yourDomain, sender, subject, body, recipient)

	ctx, cancel := context.WithTimeout(context.Background(), time.Second*10)
	defer cancel()

	// Send the message with a 10-second timeout
	resp, err := mg.Send(ctx, message)
	if err != nil {
		log.Fatal(err)
	}

	fmt.Printf("ID: %s Resp: %s\n", resp.ID, resp.Message)
}
```

--------------------------------

### Get GPT Domain - 200 Response

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/inboxready/google-postmaster-tools

Example 200 response body for the Get GPT Domain request. Shows the domain field and an array of data objects (reputationanalytics_github.com-mailgun-reputationanalytics-models-domain-Domain).

```json
{
  "domain": "test.com",
  "data": [
    { … }
  ]
}
```

--------------------------------

### Send First Email with cURL

Source: https://documentation.mailgun.com/docs/mailgun/quickstart

Sends your first email using the sandbox domain. Replace YOUR_API_KEY and YOUR_SANDBOX_DOMAIN with your credentials. The response will be 200 ok with a message like "Queued. Thank you.".

```bash
curl --user 'api:YOUR_API_KEY' \
  https://api.mailgun.net/v3/YOUR_SANDBOX_DOMAIN/messages \
  -F from='Test <postmaster@YOUR_SANDBOX_DOMAIN>' \
  -F to='your-email@example.com' \
  -F subject='Hello!' \
  -F text='Test message'
```

--------------------------------

### Email Health Score Response Example

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/inboxready/email-health-score

Example JSON response from the GET /v1/maverick-score/total endpoint. It shows the score, rates (bounce_rate, complaint_rate, trap_rate, full_mailbox_rate, bad_failure_rate), and counters (delivered).

```json
{
  "score": 37,
  "rates": {
    "bounce_rate": 9,
    "complaint_rate": 19,
    "trap_rate": 3,
    "full_mailbox_rate": 3,
    "bad_failure_rate": 29
  },
  "counters": {
    "delivered": 100500
  }
}
```

--------------------------------

### Get SNDS Address Info - response example

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/inboxready/microsoft-snds

Example JSON response for the SNDS address info request. It contains a summary array with fields like block_text, complaint_rate, and total count.

```json
{
  "summary": [
    { … }
  ],
  "total": 1
}
```

--------------------------------

### Sample response for listing all mailboxes

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/mailboxes

Example JSON response returned when listing all mailboxes. Shows total_count and items array with mailbox details.

```json
{
  "total_count": 2,
  "items": [
    {
      "size_bytes": 0,
      "created_at": "Tue, 27 Sep 2011 20:24:22 GMT",
      "mailbox": "postmaster@samples.mailgun.org"
    },
    {
      "size_bytes": 0,
      "created_at": "Thu, 06 Oct 2011 10:22:36 GMT",
      "mailbox": "user@samples.mailgun.org"
    }
  ]
}
```

--------------------------------

### POST /v3/ip_warmups/{addr}

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ip-address-warmup

Starts a warmup process for a specific IP address.

```APIDOC
## [POST] /v3/ip_warmups/{addr}

### Description
Starts a warmup process for a specific IP address.

### Method
POST

### Endpoint
/v3/ip_warmups/{addr}

### Parameters
#### Path Parameters
- **addr** (string) - Required - The IP address to start warmup for.

### Request Example
```
curl -i -X POST \
  -u '<username>:<password>' \
  'https://api.mailgun.net/v3/ip_warmups/{addr}'
```

### Response
#### Success Response (200)
- **message** (string) - Response message

#### Response Example
```json
{
  "message": "string"
}
```
```

--------------------------------

### Get domain webhooks response

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-webhooks

Example JSON response from the GET /v3/domains/{domain}/webhooks endpoint. Shows the structure with webhooks keyed by event type (accepted, delivered, opened, clicked, unsubscribed, complained, temporary_fail, permanent_fail).

```json
{
  "webhooks": {
    "accepted": { … },
    "delivered": { … },
    "opened": { … },
    "clicked": { … },
    "unsubscribed": { … },
    "complained": { … },
    "temporary_fail": { … },
    "permanent_fail": { … }
  }
}
```

--------------------------------

### POST /v3/{domain_name}/whitelists/import

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/allowlist

Import a CSV file containing a list of addresses and/or domains to add to the allowlist. The CSV file must be 25MB or under and must contain the following column headers: address, domain. For each row provide either an address or a domain, but not both - choose one, keep the other blank.

```APIDOC
## [POST] /v3/{domain_name}/whitelists/import

### Description
Import a CSV file containing a list of addresses and/or domains to add to the allowlist. The CSV file must be 25MB or under and must contain the following column headers: address, domain. For each row provide either an address or a domain, but not both - choose one, keep the other blank.

### Method
POST

### Endpoint
/v3/{domain_name}/whitelists/import

### Parameters
#### Path Parameters
- **domain_name** (string) - Required - Domain to update allowlist for

#### Headers
- **Content-Type** (string) - Required - Content-Type must be `multipart/form-data`

#### Request Body
- **file** (string) - Required - CSV file

### Request Example
```
curl -i -X POST \
  -u '<username>:<password>' \
  'https://api.mailgun.net/v3/{domain_name}/whitelists/import' \
  -H 'Content-Type: multipart/form-data' \
  -F file=string
```

### Response
#### Success Response (202)
- **message** (string) - Response message

#### Response Example
```json
{
  "message": "file uploaded successfully for processing. standby..."
}
```

### Error Handling
- **400** - Bad Request
- **500** - Internal Server Error
```

--------------------------------

### List alert events response

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/inboxready/alerts

Example JSON response from the GET /v1/alerts/events endpoint, showing the events array with sample values.

```json
{
  "events": [
    "ip_listed",
    "ip_delisted"
  ]
}
```

--------------------------------

### Send email with Mailgun PHP SDK

Source: https://documentation.mailgun.com/docs/mailgun/sdk/php_sdk

PHP example showing how to instantiate the Mailgun SDK with API credentials (US or EU server) and send a message using the messages()->send() method.

```php
// First, instantiate the SDK with your API credentials
$mg = Mailgun::create('MAILGUN_API_KEY'); // For US servers
$mg = Mailgun::create('MAILGUN_API_KEY', 'https://api.eu.mailgun.net'); // For EU servers

// Now, compose and send your message.
// $mg->messages()->send($domain, $params);
$mg->messages()->send('example.com', [
  'from'    => 'bob@example.com',
  'to'      => 'sally@example.com',
  'subject' => 'The PHP SDK is awesome!',
  'text'    => 'It is so simple to send a message.'
]);
```

--------------------------------

### Get a single forward rule by ID - response body

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/forwards

Example JSON response body for a successful GET request to retrieve a forward rule. It includes the rule's ID, account ID, domain information, match pattern, forward configuration, and timestamps.

```json
{
  "id": "60d9431e582ecdc84b886284",
  "account_id": "646634cc58ea2b8fe43e0000",
  "domain_name": "my-domain.com",
  "domain_id": "642134nn58ea2b8fe43e0000",
  "match": "wild*card@example.com",
  "forward": {
    "urls": [ … ],
    "recipients": [ … ],
    "store": "https://my-store-url.com/store"
  },
  "created_at": "Mon, 28 Jun 2021 03:33:50 UTC",
  "updated_at": "Mon, 28 Jun 2021 03:33:50 UTC"
}
```

--------------------------------

### 200 response body for /v3/stats/total

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/stats

Example 200 response body for the /v3/stats/total endpoint. Shows the response structure with description, start, end, resolution, and stats array.

```json
{
  "description": "Optional Description",
  "start": "Tue, 14 Feb 2012 00:00:00 UTC",
  "end": "Fri, 01 Apr 2012 00:00:00 UTC",
  "resolution": "month",
  "stats": [
    { … }
  ]
}
```

--------------------------------

### Sample response for creating a new mailbox

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/mailboxes

Example JSON response returned when creating a new mailbox.

```json
{
  "message": "Created 1 mailboxes"
}
```

--------------------------------

### List logs - 200 response

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/logs

Example JSON response from the Logs API. It includes the start and end dates, an items array, pagination tokens, and an aggregates object.

```json
{
  "start": "Mon, 08 Jul 2024 00:00:00 -0000",
  "end": "Fri, 12 Jul 2024 00:00:00 -0000",
  "items": [
    { … }
  ],
  "pagination": {
    "previous": "cjsijbijewbu78t678tVTYUYU76754fyuiksi23h75",
    "next": "cjsijbijewbu78t678tVTYUYU76754fyuiksin98hh",
    "first": "cjsijbijewbu78t678tVTYUYU76754fyuiksin865g",
    "last": "875bunjnWkmis75bjklnsdk0s7jksnjknlknc64aTR",
    "total": 100
  },
  "aggregates": {}
}
```

--------------------------------

### Create an account-level template via API

Source: https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/send-templates

Creates a template at the account level using the v4 endpoint. The template content is passed as a form field with the template HTML, and the name and description are provided as form fields.

```bash
curl -X POST -s --user 'api:YOUR_API_KEY' \

    https://api.mailgun.net/v4/templates \

    --form-string template='<div class="entry"> <h1>{{title}}</h1> <div class="body"> {{body}} </div> </div>' \

    -F name='template.test' \

    -F description='Sample template'
```

--------------------------------

### Create Template with All Handlebars Helpers

Source: https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/send-templates

Use this cURL command to create a Mailgun template that demonstrates all supported Handlebars helpers. The template includes conditional logic, loops, and localization. Replace YOUR_API_KEY and YOUR_DOMAIN_NAME with your actual credentials.

```bash
curl -X POST -s --user 'api:YOUR_API_KEY' \
    https://api.mailgun.net/v3/YOUR_DOMAIN_NAME/templates \
    -F name='comprehensive.test' \
    -F description='Complete test template with all Handlebars helpers' \
    --form-string template='<!DOCTYPE html>
<html>
<head>
  <style>
    body { font-family: Arial, sans-serif; }
    .warning { color: red; }
    .premium { background-color: #f0f8ff; padding: 10px; }
  </style>
</head>
<body>
  <h1>Order Confirmation</h1>
  
  {{#with customer}}
  <p>Hello {{firstName}} {{lastName}},</p>
  <p>Email: {{email}}</p>
  {{/with}}
  
  {{#equal accountType "premium"}}
  <div class="premium">
    <p>🎉 Premium Member Perk: You have earned 2x points on this order!</p>
  </div>
  {{/equal}}
  
  {{#equal accountType "basic"}}
  <p>Upgrade to Premium for exclusive benefits and rewards!</p>
  {{/equal}}
  
  {{#unless paymentReceived}}
  <div class="warning">
    <p>⚠️ WARNING: Payment pending. Your order will ship once payment is confirmed.</p>
  </div>
  {{/unless}}
  
  {{#if paymentReceived}}
  <p>✓ Payment confirmed! Your order is being processed.</p>
  {{/if}}
  
  <h2>Order Items:</h2>
  <ul>
  {{#each items}}
    <li>{{this.name}} - Quantity: {{this.quantity}} - ${{this.price}}</li>
  {{/each}}
  </ul>
  
  {{#if spanish}}
  <p>Gracias por su compra!</p>
  {{else if french}}
  <p>Merci pour votre achat!</p>
  {{else}}
  <p>Thank you for your purchase!</p>
  {{/if}}
  
</body>
</html>' 
```

--------------------------------

### Get Monitored Domains - 200 response

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/inboxready/domain-blocklist-monitoring

Example JSON response for a successful request. The response contains an array of domain objects, each with properties like domain, account_id, updated_at, state, and listed.

```json
{
  "domains": [
    { … },
    { … }
  ]
}
```

--------------------------------

### Get account-level templates - 200 response

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-templates

Example JSON response for a successful request to list account-level templates. It contains an items array and paging object with links to previous, first, next, and last pages.

```json
{
  "items": [
    { … },
    { … }
  ],
  "paging": {
    "previous": "https://api.mailgun.net/v4/templates?page=previous&p=template.0&limit=10",
    "first": "https://api.mailgun.net/v4/templates?limit=10",
    "next": "https://api.mailgun.net/v4/templates?page=next&p=template.2&limit=10",
    "last": "https://api.mailgun.net/v4/templates?page=last&limit=10"
  }
}
```

--------------------------------

### GET /v3/ip_warmups - List IP warmup statuses

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ip-address-warmup

Retrieves a list of in-flight IP warmup statuses for dedicated IP addresses owned by the account. The response includes pagination URLs for navigating through the results. The `page` and `limit` query parameters are optional; `limit` defaults to 10 if not specified.

```bash
curl -i -X GET \
  -u '<username>:<password>' \
  'https://api.mailgun.net/v3/ip_warmups?page=string&limit=string'
```

--------------------------------

### Enable a subaccount with curl

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/subaccounts/post-v5-accounts-subaccounts-subaccount_id-enable

Use this curl command to enable a subaccount. Replace <username> and <password> with your API credentials and {subaccount_id} with the subaccount's ID. The response includes the subaccount details with status 'open'.

```bash
curl -i -X POST \
  -u '<username>:<password>' \
  'https://api.mailgun.net/v5/accounts/subaccounts/{subaccount_id}/enable'
```

--------------------------------

### GET /v1/monitoring/domains

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/inboxready/domain-blocklist-monitoring

Gets all domains that are being monitored for blocklisting.

```APIDOC
## [GET] /v1/monitoring/domains

### Description
Gets all domains that are being monitored for blocklisting.

### Method
GET

### Endpoint
/v1/monitoring/domains

### Parameters
#### Query Parameters
- **include_subaccounts** (boolean) - Optional - Include subaccounts. Default: false.

### Request Example
```
curl -i -X GET \
  -u '<username>:<password>' \
  'https://api.mailgun.net/v1/monitoring/domains?include_subaccounts=false'
```

### Response
#### Success Response (200)
- **domains** (Array of objects) - Required - List of monitored domains.
  - **domain** (string) - Required - The domain name.
  - **account_id** (string) - Required - Mailgun account ID.
  - **updated_at** (string, date-time) - Required - Last update timestamp.
  - **state** (string) - Required - Current state of the domain.
  - **listed** (Array of objects) - Required - List of blocklist entries.

#### Response Example
```
{
  "domains": [
    { ... },
    { ... }
  ]
}
```

```

--------------------------------

### GET /v1/preview/tests/clients

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/inspect/email-preview

Returns a list of clients that can perform an email preview.

```APIDOC
## [GET] /v1/preview/tests/clients

### Description
Returns a list of clients that can perform an email preview.

### Method
GET

### Endpoint
/v1/preview/tests/clients

### Authentication
basicAuth

### Request Example
curl -i -X GET \
  -u '<username>:<password>' \
  https://api.mailgun.net/v1/preview/tests/clients

### Response
#### Success Response (200)
- **clients** (object) - Required - A map of client identifiers to client details.

#### Response Example
{
  "clients": {
    "android10_gmailapp_pixel4_dm": { ... }
  }
}
```
Tokens:
Raw