{ "openapi": "3.1.0", "info": { "title": "Email Preview API", "description": "Mailgun Email Preview service with RESTful JSON HTTP API for providing email previews.", "version": "1.0.0" }, "servers": [ { "url": "https://api.mailgun.net", "description": "US Mailgun" }, { "url": "https://api.eu.mailgun.net", "description": "EU Mailgun" } ], "tags": [ { "name": "Email Preview", "description": "This API provides functionality to create and manage email preview tests, as well as create shareable links.", "x-displayName": "Email Preview" }, { "name": "Code Analysis", "description": "The Code Analysis API analyzes HTML email content to detect CSS features and provides comprehensive compatibility reports across major email clients, including support statistics, version-specific compatibility data, and detailed feature breakdowns to ensure optimal email rendering.", "x-displayName": "Code Analysis" }, { "name": "Link Validation", "description": "The Link Validation API processes a list of URLs to verify their HTTP status, monitor redirect chains with timing metrics, and provide detailed information on content length, content type, and SSL certificate status.", "x-displayName": "Link Validation" }, { "name": "Image Validation", "description": "The Image Validation API processes image URLs or uploads to provide comprehensive details such as dimensions, type, file size, and format, reports frame count, animation duration, color depth, and transparency for GIFs, and include image optimization capabilities.", "x-displayName": "Image Validation" }, { "name": "Accessibility", "description": "The Accessibility API evaluates HTML emails against WCAG standards, providing a clear pass/fail assessment to ensure compliance with accessibility guidelines.", "x-displayName": "Accessibility" }, { "name": "Spam Testing", "x-displayName": "Spam Testing" } ], "paths": { "/v1/preview/tests/clients": { "get": { "tags": [ "Email Preview" ], "summary": "List Clients", "description": "Returns a list of clients that can perform an email preview.", "operationId": "GET-v1-preview-tests-clients", "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-ClientsResponse" }, "examples": { "Example": { "value": { "clients": { "android10_gmailapp_pixel4_dm": { "id": "android10_gmailapp_pixel4_dm", "client": "Gmail App Pixel 4", "os": "Android 10 (Dark Mode)", "category": "Mobile", "browser": "", "rotate": false, "imageblocking": false, "free": false, "default": true, "extension": "" } } } } } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "500": { "description": "A 500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" } } } }, "default": { "description": "A default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-ErrorResponse" } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/preview/tests": { "get": { "tags": [ "Email Preview" ], "summary": "List Emailpreview Tests", "description": "Returns a list of email preview tests.

**WARNING:** _This endpoint is deprecated in favor of our [V2 endpoint](https://documentation.mailgun.com/docs/inspect/api-reference/openapi-final/tag/Email-Preview/#tag/Email-Preview/operation/GET-v2-preview-tests)._", "operationId": "GET-v1-preview-tests", "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-GetTestsResponse" }, "examples": { "Example": { "value": [ { "id": "", "date": 0, "type": "", "subject": "", "headers": { "": "" } } ] } } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "500": { "description": "A 500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" } } } }, "default": { "description": "A default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-ErrorResponse" } } } } }, "deprecated": true, "security": [ { "basicAuth": [] } ] }, "post": { "tags": [ "Email Preview" ], "summary": "Create Emailpreview Test", "description": "Creates a new email preview test.

**WARNING:** _This endpoint is deprecated in favor of our [V2 endpoint](https://documentation.mailgun.com/docs/inspect/api-reference/openapi-final/tag/Email-Preview/#tag/Email-Preview/operation/POST-v2-preview-tests)._", "operationId": "POST-v1-preview-tests", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-CreateTestRequest" }, "examples": { "Example": { "value": { "subject": "some subject", "url": "https://example.com", "content_checking": {} } } } } }, "required": true }, "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-CreateTestResponse" }, "examples": { "Example": { "value": { "id": "gmail" } } } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "500": { "description": "A 500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" } } } }, "default": { "description": "A default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-ErrorResponse" } } } } }, "deprecated": true, "security": [ { "basicAuth": [] } ] } }, "/v1/preview/tests/{test_id}/results": { "get": { "tags": [ "Email Preview" ], "summary": "Get Test Results", "description": "Returns the results for the specified email preview test.", "operationId": "GET-v1-preview-tests--test-id--results", "parameters": [ { "name": "test_id", "in": "path", "description": "Test to get results for", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-GetTestResultsResponse" }, "examples": { "Example": { "value": { "android10_gmailapp_pixel4_dm": { "id": "android10_gmailapp_pixel4_dm", "displayname": "Gmail App Pixel 4", "client": "Gmail App", "os": "Android 10 (Dark Mode)", "category": "Mobile", "browser": "", "screenshots": { "default": "https://images.emailonacid.com/123" }, "thumbnail": "https://images.emailonacid.com/1234", "fullthumbnail": "https://images.emailonacid.com/90479d4733fc5f409475644cb01384b0b21bc53f1c32e0ed609756dfb63d2f5%3A1741804257", "status": "Complete", "statusdetails": { "submitted": 1741804257, "completed": 1741804276, "bouncecode": "", "bouncemessage": "" } }, "android10_gmailapp_pixel4_lm": { "id": "android10_gmailapp_pixel4_lm", "displayname": "Gmail App Pixel 4", "client": "Gmail App", "os": "Android 10", "category": "Mobile", "browser": "", "screenshots": { "default": "https://images.emailonacid.com/YXB479d4733fc5f409475644cb01384b0b21bc53f1c32e0ed609756dfb63d2f5%3A1741804257" }, "thumbnail": "https://images.emailonacid.com/YXBpLzRRZVp3Z0479d4733fc5f409475644cb01384b0b21bc53f1c32e0ed609756dfb63d2f5%3A1741804257", "fullthumbnail": "https://images.emailonacid.com/YXBpLzRRZVp3ZzlBbmJydjVEZjBUOW9obUxpU1RUQmpe=d90479d4733fc5f409475644cb01384b0b21bc53f1c32e0ed609756dfb63d2f5%3A1741804257", "status": "Complete", "statusdetails": { "submitted": 1741804257, "completed": 1741804275, "bouncecode": "", "bouncemessage": "" } } } } } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "500": { "description": "A 500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" } } } }, "default": { "description": "A default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-ErrorResponse" } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/preview/tests/{test_id}": { "get": { "tags": [ "Email Preview" ], "summary": "Get Emailpreview Test Info", "description": "Returns test info.

**WARNING:** _This endpoint is deprecated in favor of our [V2 endpoint](https://documentation.mailgun.com/docs/inspect/api-reference/openapi-final/tag/Email-Preview/#tag/Email-Preview/operation/GET-v2-preview-tests--test-id-)._", "operationId": "GET-v1-preview-tests--test-id-", "parameters": [ { "name": "test_id", "in": "path", "description": "Test to get the content of", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-GetTestInfoResponse" } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "500": { "description": "A 500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" } } } }, "default": { "description": "A default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-ErrorResponse" } } } } }, "deprecated": true, "security": [ { "basicAuth": [] } ] }, "delete": { "tags": [ "Email Preview" ], "summary": "Delete Emailpreview Test", "description": "Deletes the specified test.

**WARNING:** _This endpoint is deprecated in favor of our [V2 endpoint](https://documentation.mailgun.com/docs/inspect/api-reference/openapi-final/tag/Email-Preview/#tag/Email-Preview/operation/DELETE-v2-preview-tests--test-id-)._", "operationId": "DELETE-v1-preview-tests--test-id-", "parameters": [ { "name": "test_id", "in": "path", "description": "Test to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-DeleteTestResponse" } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "500": { "description": "A 500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" } } } }, "default": { "description": "A default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-ErrorResponse" } } } } }, "deprecated": true, "security": [ { "basicAuth": [] } ] } }, "/v1/preview/tests/{test_id}/results/reprocess": { "put": { "tags": [ "Email Preview" ], "summary": "Reprocess Emailpreview Test", "description": "Reprocesses the test for the passed clients.", "operationId": "PUT-v1-preview-tests--test-id--results-reprocess", "parameters": [ { "name": "test_id", "in": "path", "description": "Test to reprocess", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-ReprocessTestResponse" }, "examples": { "Example": {} } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "500": { "description": "A 500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" } } } }, "default": { "description": "A default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-ErrorResponse" } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/preview/tests/{test_id}/content": { "get": { "tags": [ "Email Preview" ], "summary": "Get Test Content (empty)", "description": "Gets HTML content of the passed test.", "operationId": "GET-v1-preview-tests--test-id--content", "parameters": [ { "name": "test_id", "in": "path", "description": "Test to get the content of", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-TestContentResponse" } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "500": { "description": "A 500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" } } } }, "default": { "description": "A default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-ErrorResponse" } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/preview/tests/{test_id}/content/{content}": { "get": { "tags": [ "Email Preview" ], "summary": "Get Test Content", "description": "Gets HTML content of the passed test.", "operationId": "GET-v1-preview-tests--test-id--content--content-", "parameters": [ { "name": "test_id", "in": "path", "description": "Test to get the content of", "required": true, "schema": { "type": "string" } }, { "name": "content", "in": "path", "description": "Content to get: inlinecss or textonly", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-TestContentResponse" } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "500": { "description": "A 500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" } } } }, "default": { "description": "A default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-ErrorResponse" } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/preview/address": { "post": { "tags": [ "Email Preview" ], "summary": "Generate Preview Address", "description": "Returns or generates an account's email preview address.", "operationId": "POST-v1-preview-address", "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-address-PreviewAddressResponse" } } } }, "500": { "description": "A 500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/string" } } } }, "default": { "description": "A default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v2/preview/tests": { "get": { "tags": [ "Email Preview" ], "summary": "List/Search Tests V2", "description": "This call returns a list of Email Tests along with metadata about each test. Email Tests are stored for 90 days. When query parameters are provided, only the tests matching the specified criteria will be returned; otherwise, all available tests are returned. The response structure remains identical in both cases.", "operationId": "GET-v2-preview-tests", "parameters": [ { "name": "customer_id", "in": "query", "description": "Filter tests by the provided customer ID.", "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "The starting point of your test date range. Accepts formats like '2025-03-10 17:52:07', Unix timestamp, or 'yesterday'.", "schema": { "type": "string" } }, { "name": "to", "in": "query", "description": "The ending point of your test date range. Accepts formats like '2025-03-10 17:52:07', Unix timestamp, or 'yesterday'.", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "The \"subject\" field of returned tests must contain the exact string. This search is case-insensitive.", "schema": { "type": "string" } }, { "name": "headers", "in": "query", "description": "Enterprise users can use this field in a KV array of x-headers submitted with the test. This is an AND match, meaning all headers must be present to return.", "schema": { "type": "string" } }, { "name": "results", "in": "query", "description": "The number of results to return. Must be between 1 and 200. The default value is 50.", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page number. If you submit a number higher than the number of pages in the data, an empty array will be returned. The default value is 1.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-GetTestsResponse" }, "examples": { "Example": { "value": [ { "id": "DdbNga1MdL3N7sO19v5MAmpOKIqFrLg9cgpCIgS4othXJ", "date": 1739876826, "type": "email-test", "subject": "subject", "headers": {} }, { "id": "pDdLWjbj3ZbAnHkTbg3QG27mFyoc62OAH1WJXgmb0uNT4", "date": 1739874606, "type": "email-test", "subject": "", "headers": {} } ] } } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "500": { "description": "A 500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" } } } }, "default": { "description": "A default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-ErrorResponse" } } } } }, "security": [ { "basicAuth": [] } ] }, "post": { "tags": [ "Email Preview" ], "summary": "Create Email Preview Test V2", "description": "This call creates a new email test and submits it to our system for processing.
All requests must contain a subject property and one source property (either html or url). All other properties are optional. In the following table, each property and its default value is shown.
If content-checking variables (such as those for link validation, image validation, or accessibility) are set in the body of the request, the endpoint will run content-checking on the email content.
The response will include an id property that should be used to request the results or trigger further processes on the email content.
For enterprise customers, the response will also include the customer_id and reference_id that were submitted with the test.", "operationId": "POST-v2-preview-tests", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-CreateTestRequest" }, "examples": { "Example": { "value": { "subject": "Example subject", "html": "...", "transfer_encoding": "base64", "charset": "utf-8", "customer_id": "1", "clients": [ "client1", "client2" ], "content_checking": { "link_validation": true, "image_validation": true, "accessibility": true, "code_analysis": true } } } } } }, "required": true }, "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-CreateTestResponse" }, "examples": { "Example": { "value": { "id": "exampleTestID", "customer_id": "1", "warnings": [ { "name": "InvalidClient", "message": "A client ID you have requested (ipadpro_11_15, ipadpro_12_15, iphonese2_15, iphone11pro_15, iphone12promax_15, iphone13promax_15) could not be found. It may be that the code does not exist or that it is no longer supported." } ], "content_checking": { "link_validation": { "items": { "id": "67b469d74b911fa30a4d782e", "links": { "self": "/v1/inspect/links/67b469d74b911fa30a4d782e" } } }, "image_validation": { "items": { "id": "67b469d74b911fa30a4d782e", "links": { "self": "/v1/inspect/images/67b469d74b911fa30a4d782e" } } }, "accessibility": { "items": { "id": "67b469d74b911fa30a4d782e", "links": { "self": "/v1/inspect/accessibility/67b469d74b911fa30a4d782e" } } }, "code_analysis": { "items": { "id": "67b469d74b911fa30a4d782e", "links": { "self": "/v1/inspect/analyze/67b469d74b911fa30a4d782e" } } } } } } } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "500": { "description": "A 500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" } } } }, "default": { "description": "A default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-ErrorResponse" } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v2/preview/tests/{test_id}/results/{client_id}": { "get": { "tags": [ "Email Preview" ], "summary": "Get Test Results by client ID V2", "description": "This call returns detailed results for screenshots including their upload locations, send times, completion times, and information about bounces, if any. is a test ID returned from test creation or the get test list functions. The is required and restricts the returned data exclusively to the specified client. If the client is not present in the test or is invalid, an error will be returned.", "operationId": "GET-v2-preview-tests--test-id--results--client-id-", "parameters": [ { "name": "test_id", "in": "path", "description": "Test to get results for", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "path", "description": "Client to get results for", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-GetTestResultsResponse" }, "examples": { "Example": { "value": { "android10_gmailapp_pixel4_dm": { "id": "android10_gmailapp_pixel4_dm", "displayname": "Gmail App Pixel 4", "client": "Gmail App", "os": "Android 10 (Dark Mode)", "category": "Mobile", "browser": "", "screenshots": { "default": "https://images.emailonacid.com/123" }, "thumbnail": "https://images.emailonacid.com/1234", "fullthumbnail": "https://images.emailonacid.com/90479d4733fc5f409475644cb01384b0b21bc53f1c32e0ed609756dfb63d2f5%3A1741804257", "status": "Complete", "statusdetails": { "submitted": 1741804257, "completed": 1741804276, "bouncecode": "", "bouncemessage": "" } } } } } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "500": { "description": "A 500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" } } } }, "default": { "description": "A default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-ErrorResponse" } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v2/preview/tests/{test_id}": { "get": { "tags": [ "Email Preview" ], "summary": "Get Emailpreview Test Information V2", "description": "Retrieves detailed information about a specific test, including the subject, submission time (in UNIX timestamp format), processing statuses, and any content checking results. The response includes one to three properties containing arrays of clients: completed (clients that have successfully uploaded screenshots), processing (clients that are still being processed by our system), and bounced (clients that were bounced by the destination and cannot be retried). Additionally, the system will automatically requeue screenshots if they remain in processing for more than three minutes.", "operationId": "GET-v2-preview-tests--test-id-", "parameters": [ { "name": "test_id", "in": "path", "description": "The ID of the test to retrieve", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-GetTestInfoResponse" }, "examples": { "Example": { "value": { "subject": "Example Subject", "date": 1739876826, "completed": [ "client1" ], "processing": [ "client2" ], "bounced": [ "client3" ], "content_checking": { "link_validation": { "items": { "links": {} } }, "image_validation": { "items": { "id": "67b469d74b911fa30a4d782e", "links": { "self": "/v1/inspect/images/67b469d74b911fa30a4d782e" } } }, "accessibility": { "items": { "links": {} } }, "code_analysis": { "items": { "links": {} } } } } } } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "500": { "description": "A 500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" } } } }, "default": { "description": "A default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-ErrorResponse" } } } } }, "security": [ { "basicAuth": [] } ] }, "delete": { "tags": [ "Email Preview" ], "summary": "Delete Emailpreview Test V2", "description": "Deletes the specified test and its content checking. Once it is deleted, it cannot be recovered.", "operationId": "DELETE-v2-preview-tests--test-id-", "parameters": [ { "name": "test_id", "in": "path", "description": "Test to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-DeleteTestResponse" }, "examples": { "Example": { "value": { "success": true } } } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "500": { "description": "A 500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" } } } }, "default": { "description": "A default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-ErrorResponse" } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v2/preview/tests/{test_id}/exports/{job_id}": { "get": { "tags": [ "Email Preview" ], "summary": "Retrieve Export Job Details for Email Preview Test Screenshots", "description": "Retrieves the status and details of an export job created to collect screenshots for an Email Preview Test. Provide both the test ID and the job ID to fetch the export job information.", "operationId": "GET-v2-preview-tests--test-id--exports--job-id-", "parameters": [ { "name": "test_id", "in": "path", "description": "Unique identifier of the Email Preview Test", "required": true, "schema": { "type": "string" } }, { "name": "job_id", "in": "path", "description": "Unique identifier of the export job", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-queue_tracking-QueueTracking" }, "examples": { "Example": { "value": { "job_id": "67b469d74b911fa30a4d782e", "test_id": "98b469d74b956fa30a4d125f", "clients": [ "android11_gmailapp_pixel5_dm", "android12_gmailapp_pixel6_dm" ], "job_status": "Completed", "zip_url": "https://example.com/export.zip" } } } } } }, "500": { "description": "A 500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" } } } }, "default": { "description": "A default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v2/preview/tests/{test_id}/exports": { "get": { "tags": [ "Email Preview" ], "summary": "Retrieve Export Job Details for Email Preview Test Screenshots", "description": "Retrieves the status and details of an export job created to collect screenshots for an Email Preview Test. Provide the test ID to fetch the latest export job information.", "operationId": "GET-v2-preview-tests--test-id--exports", "parameters": [ { "name": "test_id", "in": "path", "description": "Unique identifier of the Email Preview Test", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-queue_tracking-QueueTracking" }, "examples": { "Example": { "value": { "job_id": "67b469d74b911fa30a4d782e", "test_id": "98b469d74b956fa30a4d125f", "clients": [ "android11_gmailapp_pixel5_dm", "android12_gmailapp_pixel6_dm" ], "job_status": "Completed", "zip_url": "https://example.com/export.zip" } } } } } }, "500": { "description": "A 500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" } } } }, "default": { "description": "A default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } } }, "security": [ { "basicAuth": [] } ] }, "post": { "tags": [ "Email Preview" ], "summary": "Create Export Job for Email Preview Test Screenshots", "description": "Initiates an export job that collects screenshots for a specified Email Preview Test. Provide the list of client IDs whose screenshots you want to export. The job status can be monitored using the job ID returned in the response.", "operationId": "POST-v2-preview-tests--test-id--exports", "parameters": [ { "name": "test_id", "in": "path", "description": "Unique identifier of the Email Preview Test to export screenshots for", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-CreateZipExport" }, "examples": { "Example": { "value": { "clients": [ "android11_gmailapp_pixel5_dm", "android12_gmailapp_pixel6_dm" ] } } } } }, "required": true }, "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-queue_tracking-QueueTracking" }, "examples": { "Example": { "value": { "job_id": "67b469d74b911fa30a4d782e", "test_id": "98b469d74b956fa30a4d125f", "clients": [ "android11_gmailapp_pixel5_dm", "android12_gmailapp_pixel6_dm" ], "job_status": "Processing" } } } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } }, "500": { "description": "A 500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" } } } }, "default": { "description": "A default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-ErrorResponse" } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v2/preview/address": { "post": { "tags": [ "Email Preview" ], "summary": "Generate Preview Address", "description": "Returns or generates an account's email preview address.", "operationId": "POST-v2-preview-address", "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-address-PreviewAddressResponse" } } } }, "500": { "description": "A 500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/string" } } } }, "default": { "description": "A default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/preview/sharing": { "post": { "tags": [ "Email Preview" ], "summary": "Create PreviewShare", "description": "Create a shareable link to an email preview test.", "operationId": "POST-v1-preview-sharing", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-api-CreatePreviewSharingRequest" }, "examples": { "Example": { "value": { "test_id": "some-id" } } } } }, "required": true }, "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "record created" } } } } } }, "500": { "description": "A 500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" } } } }, "default": { "description": "A default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/preview/sharing/{test_id}": { "get": { "tags": [ "Email Preview" ], "summary": "Get PreviewShare", "description": "Returns PreviewShare record by TID.", "operationId": "GET-v1-preview-sharing--test-id-", "parameters": [ { "name": "test_id", "in": "path", "description": "Test to get", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-sharing-PreviewSharingResponse" }, "examples": { "Example": { "value": { "test_id": "some-test-id", "url_uuid": "some-uuid", "url": "share.mailgun.com/email-previews/some-uuid", "enabled": true, "expires_at": "0001-01-01T00:00:00Z" } } } } } }, "500": { "description": "A 500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" } } } }, "default": { "description": "A default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } } }, "security": [ { "basicAuth": [] } ] }, "put": { "tags": [ "Email Preview" ], "summary": "Update PreviewShare", "description": "Updates PreviewShare record enabled field.", "operationId": "PUT-v1-preview-sharing--test-id-", "parameters": [ { "name": "test_id", "in": "path", "description": "Test to update", "required": true, "schema": { "type": "string" } }, { "name": "url_uuid", "in": "query", "description": "UUID to update", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "record updated" } } } } } }, "500": { "description": "A 500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" } } } }, "default": { "description": "A default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } } }, "security": [ { "basicAuth": [] } ] }, "delete": { "tags": [ "Email Preview" ], "summary": "Delete PreviewShare", "description": "Delete PreviewShare record by TID.", "operationId": "DELETE-v1-preview-sharing--test-id-", "parameters": [ { "name": "test_id", "in": "path", "description": "Test to delete", "required": true, "schema": { "type": "string" } }, { "name": "url_uuid", "in": "query", "description": "UUID to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "record deleted" } } } } } }, "500": { "description": "A 500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" } } } }, "default": { "description": "A default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/preview/sharing/{test_id}/rotate": { "post": { "tags": [ "Email Preview" ], "summary": "Rotate PreviewShare", "description": "Re-generates the uuid and share url, and resets the expiration.", "operationId": "POST-v1-preview-sharing--test-id--rotate", "parameters": [ { "name": "test_id", "in": "path", "description": "Test to rotate", "required": true, "schema": { "type": "string" } }, { "name": "url_uuid", "in": "query", "description": "UUID to rotate", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-sharing-PreviewSharingResponse" }, "examples": { "Example": { "value": { "test_id": "some-test-id", "url_uuid": "some-new-uuid", "url": "share.mailgun.com/email-previews/some-new-uuid", "enabled": true, "expires_at": "0001-01-01T00:00:00Z" } } } } } }, "500": { "description": "A 500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" } } } }, "default": { "description": "A default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/preview/sharing/public/{id}": { "get": { "tags": [ "Email Preview" ], "summary": "Returns PreviewShare record by UUID.", "operationId": "GET-v1-preview-sharing-public--id-", "parameters": [ { "name": "id", "in": "path", "description": "UUID to get", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-api-PreviewTestResultsResponse" }, "examples": { "Example": { "value": { "subject": "some test", "date": 1739876826, "results": [] } } } } } }, "500": { "description": "A 500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" } } } }, "default": { "description": "A default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericAPIError" } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/inspect/links/{id}": { "get": { "tags": [ "Link Validation" ], "summary": "Get Link Validation Results", "description": "Returns the results of a link validation test.", "operationId": "GET-v1-inspect-links--id-", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the validation test we want to check the results for", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-linkvalidation-GetLinkValidationJSONAPIResponse" }, "examples": { "Example": { "value": { "meta": { "status": "Completed" }, "items": { "id": "677eeda04fc661c900945dec", "results": [ { "url": "http://www.mailgun.com&utm_source=mailgun&utm_medium=email&utm_campaign=mailgun", "status": "Valid", "status_code": 200, "passes": [ { "id": "http_status_check", "rule": "Valid HTTP Response", "description": "Link returned a 2xx status", "details": [ { "status_code": 200 } ] }, { "id": "ssl_certificate_check", "rule": "SSL Certificate Valid", "description": "SSL certificate is valid and not expiring soon", "details": [ { "common_name": "*.mailgun.com", "expires_on": "2025-05-27T23:59:59Z" } ] }, { "id": "redirect_check", "rule": "Redirect Check", "description": "Redirect chain is within allowed limits and no loop detected", "details": [ { "final_url": "https://www.mailgun.com", "redirect_count": 0 } ] }, { "id": "response_time_check", "rule": "Fast Response Time", "description": "Link responded quickly", "details": [ { "time_elapsed": "209.914666ms" } ] } ], "failures": [ { "id": "http_status_check", "rule": "Broken Link", "description": "URL returned an error status", "impact": "critical", "recommendation": "Verify the destination URL is correct and accessible.", "details": [ { "status_code": 500, "url": "https://www.brokenlink.com" } ] }, { "id": "ssl_certificate_check", "rule": "Missing SSL Certificate", "description": "No SSL certificate was found for the link", "impact": "critical", "recommendation": "Ensure the server provides a valid SSL certificate.", "details": [ { "url": "https://www.nosslcert.com" } ] } ], "informational": [ { "id": "content_type_check", "rule": "Content Type", "description": "Detected MIME type", "details": [ { "content_type": "application/json" } ] }, { "id": "content_length_check", "rule": "Content Length", "description": "Size of the page in bytes", "details": [ { "content_length": "5682" } ] }, { "id": "ga_tags_check", "rule": "Google Analytics Tags Present", "description": "UTM parameters found in the URL", "details": [ { "tags": [ "utm_source", "utm_medium", "utm_campaign" ] } ] } ] } ] } } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } }, "404": { "description": "A 404 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "Test '677eeda04fc661c900945dec' not found" } } } } } } }, "security": [ { "basicAuth": [] } ] }, "post": { "tags": [ "Link Validation" ], "summary": "Reprocess Link Validation Test", "description": "Reprocess a link validation test.", "operationId": "POST-v1-inspect-links--id-", "parameters": [ { "name": "id", "in": "path", "description": "Link Validation Test ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-linkvalidation-CreateLinkValidationJSONAPIResponse" }, "examples": { "Example": { "value": { "meta": { "status": "Processing" }, "items": { "id": "67803c4b7061304b609e47d0", "links": { "self": "https://api.mailgun.com/v1/inspect/links/67803c4b7061304b609e47d0" } } } } } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "" } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } } }, "security": [ { "basicAuth": [] } ] }, "delete": { "tags": [ "Link Validation" ], "summary": "Delete Link Validation Test", "description": "Delete a specific link validation test by its unique test ID. This endpoint allows you to remove a link validation test from the system. If the test ID does not exist, the appropriate error message is returned.", "operationId": "DELETE-v1-inspect-links--id-", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the test.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "Test has been successfully deleted." } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } }, "404": { "description": "A 404 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "Test not found" } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/inspect/links": { "get": { "tags": [ "Link Validation" ], "summary": "List Link Validations", "description": "Retrieve a list of previous link validation tests based on various filters.", "operationId": "GET-v1-inspect-links", "parameters": [ { "name": "status", "in": "query", "description": "Filter by status of the link validation test", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Filter by ID", "schema": { "type": "string" } }, { "name": "url", "in": "query", "description": "Search by URL", "schema": { "type": "string" } }, { "name": "isExpiredSSL", "in": "query", "description": "Filter by tests that contain expired SSL certificates", "schema": { "type": "string" } }, { "name": "statusCode", "in": "query", "description": "Filter by tests with a particular status code", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-linkvalidation-GetLinkValidationTestsJSONAPIResponse" }, "examples": { "Example": { "value": { "meta": { "count": 1 }, "paging": { "previous": "https://api.mailgun.com/v1/inspect/links?page=eyJzIjowLCJiIjoiNjc4MDNlYzM3MDYxMzA0YjYwOWU0N2Q3IiwicCI6dHJ1ZX0", "first": "https://api.mailgun.com/v1/inspect/links?page=eyJzIjowLCJwIjpmYWxzZX0", "next": "https://api.mailgun.com/v1/inspect/links?page=eyJzIjowLCJiIjoiNjc4MDNlYzM3MDYxMzA0YjYwOWU0N2Q3IiwicCI6ZmFsc2V9", "last": "https://api.mailgun.com/v1/inspect/links?page=eyJzIjowLCJwIjp0cnVlfQ" }, "items": [ { "id": "67803ec37061304b609e47d7", "results": [ { "url": "http://www.mailgun.com&utm_source=mailgun&utm_medium=email&utm_campaign=mailgun", "status": "Valid", "status_code": 200, "passes": [ { "id": "http_status_check", "rule": "Valid HTTP Response", "description": "Link returned a 2xx status", "details": [ { "status_code": 200 } ] }, { "id": "ssl_certificate_check", "rule": "SSL Certificate Valid", "description": "SSL certificate is valid and not expiring soon", "details": [ { "common_name": "*.mailgun.com", "expires_on": "2025-05-27T23:59:59Z" } ] }, { "id": "redirect_check", "rule": "Redirect Check", "description": "Redirect chain is within allowed limits and no loop detected", "details": [ { "final_url": "https://www.mailgun.com", "redirect_count": 0 } ] }, { "id": "response_time_check", "rule": "Fast Response Time", "description": "Link responded quickly", "details": [ { "time_elapsed": "209.914666ms" } ] } ], "failures": [ { "id": "http_status_check", "rule": "Broken Link", "description": "URL returned an error status", "impact": "critical", "recommendation": "Verify the destination URL is correct and accessible.", "details": [ { "status_code": 500, "url": "https://www.brokenlink.com" } ] }, { "id": "ssl_certificate_check", "rule": "Missing SSL Certificate", "description": "No SSL certificate was found for the link", "impact": "critical", "recommendation": "Ensure the server provides a valid SSL certificate.", "details": [ { "url": "https://www.nosslcert.com" } ] } ], "informational": [ { "id": "content_type_check", "rule": "Content Type", "description": "Detected MIME type", "details": [ { "content_type": "application/json" } ] }, { "id": "content_length_check", "rule": "Content Length", "description": "Size of the page in bytes", "details": [ { "content_length": "5682" } ] }, { "id": "ga_tags_check", "rule": "Google Analytics Tags Present", "description": "UTM parameters found in the URL", "details": [ { "tags": [ "utm_source", "utm_medium", "utm_campaign" ] } ] } ] } ] } ] } } } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "No link validation tests found matching the criteria" } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } } }, "security": [ { "basicAuth": [] } ] }, "post": { "tags": [ "Link Validation" ], "summary": "Create a Link Validation Test", "description": "Create a link validation test.", "operationId": "POST-v1-inspect-links", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-linkvalidation-LinkValidationRequest" } } }, "required": true }, "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-linkvalidation-CreateLinkValidationJSONAPIResponse" }, "examples": { "Example": { "value": { "meta": { "status": "Processing" }, "items": { "id": "67803c4b7061304b609e47d0", "links": { "self": "https://api.mailgun.com/v1/inspect/links/67803c4b7061304b609e47d0" } } } } } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "" } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/inspect/links/html-validate": { "post": { "tags": [ "Link Validation" ], "summary": "Create a Link Validation Test from an html input", "description": "Create a link validation test from an HTML input.", "operationId": "POST-v1-inspect-links-html-validate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-htmlparser-types-HTMLEngineAPIRequest" } } }, "required": true }, "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-linkvalidation-CreateLinkValidationJSONAPIResponse" }, "examples": { "Example": { "value": { "meta": { "status": "Processing" }, "items": { "id": "67803c4b7061304b609e47d0", "links": { "self": "https://api.mailgun.com/v1/inspect/links/67803c4b7061304b609e47d0" } } } } } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "" } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/inspect/links/{id}/csv": { "post": { "tags": [ "Link Validation" ], "summary": "Validates link test results against the provided spreadsheet file", "description": "Compares link validation test results to the spreadsheet provided as a CSV, XLS or XLSX file.", "operationId": "POST-v1-inspect-links--id--csv", "parameters": [ { "name": "id", "in": "path", "description": "Link Validation Test ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/string" }, "examples": { "Example": { "value": "expected file upload with key 'csv'" } } } }, "required": true }, "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-linkvalidation-CSVLinkValidationJSONAPIResponse" }, "examples": { "Example": { "value": { "meta": { "status": "Complete" }, "items": { "errors": [ { "row": 4, "message": "final redirect mismatch: expected 'https://en.wikipedia.org/wiki', got 'https://en.wikipedia.org/wiki2'", "alert": { "severity": "Critical", "data": { "destination URL": "https://en.wikipedia.org/wiki", "row": "4", "spreadsheet URL": "https://en.wikipedia.org/wiki", "spreadsheet destination URL": "https://en.wikipedia.org/wiki2", "test URL": "https://en.wikipedia.org/wiki" } } } ] } } } } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "" } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/inspect/images/{id}": { "get": { "tags": [ "Image Validation" ], "summary": "Get Image Validation Results", "description": "Returns the results of an image validation test.", "operationId": "GET-v1-inspect-images--id-", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the validation test we want to check the results for", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-GetImageValidationTestJSONAPIResponse" }, "examples": { "Example": { "value": { "meta": { "status": "Completed" }, "items": { "id": "67a654ba0f53254b9fdca3e2", "images": [ { "url": "https://onlinegiftools.com/images/examples-onlinegiftools/halloween-five-loops.gif", "status": "Valid", "passes": [ { "id": "image_file_size_check", "rule": "File Size Acceptable", "description": "Image file size (2000 bytes) is within the acceptable limit", "details": [ { "file_size": 2000 } ] } ], "failures": [ { "id": "load_time_check", "rule": "Slow Load Time", "description": "Image load time is 6000 ms, which exceeds the threshold of 2000 ms", "impact": "moderate", "recommendation": "Optimize the image or server performance to reduce load time.", "details": [ { "load_time_ms": 6000 } ] } ], "informational": [ { "id": "image_format_check", "rule": "Image Format Detected", "description": "The detected format is JPEG", "details": [ { "format": "JPEG" } ] } ] } ] } } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } }, "404": { "description": "A 404 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "Test '67a654ba0f53254b9fdca3e2' not found" } } } } } } }, "security": [ { "basicAuth": [] } ] }, "delete": { "tags": [ "Image Validation" ], "summary": "Delete Image Validation Test", "description": "Delete a specific image validation test by its unique test ID. This endpoint allows you to remove an image validation test from the system. If the test ID does not exist, the appropriate error message is returned.", "operationId": "DELETE-v1-inspect-images--id-", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the test.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "Image validation test with test id has been successfully deleted." } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } }, "404": { "description": "A 404 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "errors": [ { "status": "404", "title": "NOT_FOUND", "detail": [ "Image validation test with test id not found" ] } ] } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/inspect/images": { "get": { "tags": [ "Image Validation" ], "summary": "Get Image Validation Tests", "description": "Retrieve a paginated list of all image validation tests that have been submitted. The response is paginated, with a limit of up to 1000 items per page. The total count of records will display in the meta object under the key, 'count'.", "operationId": "GET-v1-inspect-images", "parameters": [ { "name": "limit", "in": "query", "description": "Max count of items. Max: 1000. Default: 100", "schema": { "type": "integer" } }, { "name": "skip", "in": "query", "description": "Get the list of items starting at the nth element (paging). Default: 0", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-GetImageValidationTestsJSONAPIResponse" }, "examples": { "Example": { "value": { "meta": { "count": 17 }, "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": [ { "id": "67a654ba0f53254b9fdca3e2", "images": [ { "id": "67a62ccd8824a77a474bc307", "url": "https://onlinegiftools.com/images/examples-onlinegiftools/halloween-five-loops.gif", "status": "Valid" }, { "id": "67b625524b911fa30a4d784c", "url": "https://media.tacdn.com/media/attractions-splice-spp-720x480/06/df/2c/9c.jpg", "status": "Valid" } ] } ] } } } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "" } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } } }, "security": [ { "basicAuth": [] } ] }, "post": { "tags": [ "Image Validation" ], "summary": "Create an Image Validation Test", "description": "Create an image validation test.", "operationId": "POST-v1-inspect-images", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-ImageValidationLinkRequest" } } }, "required": true }, "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-CreateImageValidationJSONAPIResponse" }, "examples": { "Example": { "value": { "meta": { "status": "Processing" }, "items": { "id": "67a654ba0f53254b9fdca3e2", "links": { "self": "https://api.mailgun.com/v1/inspect/images/67a654ba0f53254b9fdca3e2" } } } } } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "" } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/inspect/images/html-validate": { "post": { "tags": [ "Image Validation" ], "summary": "Create an Image Validation Test by HTML", "description": "Create an image validation test with HTML", "operationId": "POST-v1-inspect-images-html-validate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-htmlparser-types-HTMLEngineAPIRequest" } } }, "required": true }, "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-CreateImageValidationJSONAPIResponse" }, "examples": { "Example": { "value": { "meta": { "status": "Complete" }, "items": { "id": "67b625524b911fa30a4d7858", "links": { "self": "https://api.mailgun.com/v1/inspect/images/67b625524b911fa30a4d7858" } } } } } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "" } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/inspect/images/upload": { "post": { "tags": [ "Image Validation" ], "summary": "Create an Image Validation Test by Image Upload", "description": "Create an image validation test by image upload", "operationId": "POST-v1-inspect-images-upload", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-ImageValidationUploadRequest" } } }, "required": true }, "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-GetImageUploadValidationResults" }, "examples": { "Example": { "value": { "meta": { "status": "Complete" }, "items": { "id": "67b629564b911fa30a4d7873", "images": [ { "id": "67b629564b911fa30a4d7872", "status": "Valid" } ] } } } } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "" } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/inspect/images/{id}/reprocess": { "post": { "tags": [ "Image Validation" ], "summary": "Reprocess Image Validation Test", "description": "Reprocess an image validation test.", "operationId": "POST-v1-inspect-images--id--reprocess", "parameters": [ { "name": "id", "in": "path", "description": "Test ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-CreateImageValidationJSONAPIResponse" }, "examples": { "Example": { "value": { "meta": { "status": "Processing" }, "items": { "id": "67a654ba0f53254b9fdca3e2", "links": { "self": "https://api.mailgun.com/v1/inspect/images/67a654ba0f53254b9fdca3e2" } } } } } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "" } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/inspect/images/{id}/optimize": { "post": { "tags": [ "Image Validation" ], "summary": "Optimize Images By Test ID", "description": "Optimizes images by test id", "operationId": "POST-v1-inspect-images--id--optimize", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the image validation test we want to optimize the images for.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-OptimizeImagesByTestJSONAPIResponse" }, "examples": { "Example": { "value": { "meta": { "status": "Completed" }, "items": [ { "id": "67b5fc304b911fa30a4d7834", "optimized_images": [ { "id": "67b5fc304b911fa30a4d7835", "original_image_id": "67a654ba0f53254b9fdca3e0", "image_url": "https://onlinegiftools.com/images/examples-onlinegiftools/halloween-five-loops.gif", "optimized_url": "https://storage.googleapis.com/mailforce-staging-mg-inspect/65a962eb2eab772ab72542ec/66c7bd142ac3f68383cea3e0/optimize/67b5fc304b911fa30a4d7835?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=sa-mg-inspect%40mailforce-staging.iam.gserviceaccount.com%2F20250219%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20250219T154345Z&X-Goog-Expires=604799&X-Goog-Signature=6d418ec5817f1b0e6f803356284af3c72bc2a39662bcde38b650666389b7122760b3a2d4f4e8884708edd37e69fd6c21fe3aae678558aa82e2bb98be951e4c5f7bfbb6b2c47f888f1921582e6095ba7fa5d1ccd2fd69df6a0f9842152ed22d1b85f1e865db83625f8a3d30c6a02e8c041a8a706e330d8218a40bbdbf841f79bf815261d15747a91b8d1e51de1f53d0f66b86150c92b7605396ca56bffb816ab7c4652cdecbf822bb967407a35abc19e28f2624004feb3f6e99b7f36b74c2cdea728fa50ec9bcecc6fe7d8fcb10b201f7d115dc6bacdc6ae5d4a475554a0717b3061d4a0150e97eb5fbc026924f6c76ac02e56721d7fb716ad00411df354ed13a&X-Goog-SignedHeaders=host", "optimized_file_size": "361.16KB", "optimized_mime_type": "image/gif", "status": "Complete" }, { "id": "67b5fc304b911fa30a4d7836", "original_image_id": "67a654ba0f53254b9fdca3e1", "image_url": "https://compote.slate.com/images/697b023b-64a5-49a0-8059-27b963453fb1.gif", "optimized_url": "https://storage.googleapis.com/mailforce-staging-mg-inspect/65a962eb2eab772ab72542ec/66c7bd142ac3f68383cea3e0/optimize/67b5fc304b911fa30a4d7836?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=sa-mg-inspect%40mailforce-staging.iam.gserviceaccount.com%2F20250219%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20250219T154345Z&X-Goog-Expires=604799&X-Goog-Signature=791cb1ea8f1efd0646dd2b57afab2221d2a07da15c50ccad19c446b9e018ca657e2454b23427343300d7ab9e0aad10dabc92476f10e5f4c2a186e59b2c9298c14ba9ae00a86a65f3c97bcc30548b51bee1fb47b9652763a77d273d3b59a077feb93c0c6857b38de8d1314ec9496ebe5b8437d7898c7305d3d95b4716f8e4750d97a7d7132be2a388c3cfd4099a2a432ef7758a3d4187bf8cd104732fde5e49b63dc3cf58586a7833a88b12a5f77b561f606823955d6cdfb14f6f49e975ad9ac6b0cd883b28797fd15bfd20e4fdc211cc94539c61554b66954bbc4d6e6dcfe60b5dbc3474bd7a02f1a526b09766111b14ee7c6292a2b3756ec0535d01a8109678&X-Goog-SignedHeaders=host", "optimized_file_size": "969.33KB", "optimized_mime_type": "image/gif", "status": "Complete" } ] } ] } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } }, "404": { "description": "A 404 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "Test '67a654ba0f53254b9fdca3e2' not found" } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/inspect/images/{id}/optimize/{image_id}": { "post": { "tags": [ "Image Validation" ], "summary": "Optimize Single Image By Test ID", "description": "Optimizes a single image by test id", "operationId": "POST-v1-inspect-images--id--optimize--image-id-", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the image validation test we want to optimize the images for.", "required": true, "schema": { "type": "string" } }, { "name": "image_id", "in": "path", "description": "The ID of the image we want to optimize", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-OptimizeImageByTestJSONAPIResponse" }, "examples": { "Example": { "value": { "meta": { "status": "Completed" }, "items": { "optimized_images": [ { "id": "67b5fc304b911fa30a4d7836", "original_image_id": "67b618d04b911fa30a4d783f", "image_url": "https://compote.slate.com/images/697b023b-64a5-49a0-8059-27b963453fb1.gif", "optimized_url": "https://storage.googleapis.com/mailforce-staging-mg-inspect/65a962eb2eab772ab72542ec/66c7bd142ac3f68383cea3e0/optimize/67b5fc304b911fa30a4d7836?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=sa-mg-inspect%40mailforce-staging.iam.gserviceaccount.com%2F20250219%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20250219T154345Z&X-Goog-Expires=604799&X-Goog-Signature=791cb1ea8f1efd0646dd2b57afab2221d2a07da15c50ccad19c446b9e018ca657e2454b23427343300d7ab9e0aad10dabc92476f10e5f4c2a186e59b2c9298c14ba9ae00a86a65f3c97bcc30548b51bee1fb47b9652763a77d273d3b59a077feb93c0c6857b38de8d1314ec9496ebe5b8437d7898c7305d3d95b4716f8e4750d97a7d7132be2a388c3cfd4099a2a432ef7758a3d4187bf8cd104732fde5e49b63dc3cf58586a7833a88b12a5f77b561f606823955d6cdfb14f6f49e975ad9ac6b0cd883b28797fd15bfd20e4fdc211cc94539c61554b66954bbc4d6e6dcfe60b5dbc3474bd7a02f1a526b09766111b14ee7c6292a2b3756ec0535d01a8109678&X-Goog-SignedHeaders=host", "optimized_file_size": "969.33KB", "optimized_mime_type": "image/gif", "status": "Complete" } ] } } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } }, "404": { "description": "A 404 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "Test '67a654ba0f53254b9fdca3e2' not found" } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/inspect/accessibility": { "get": { "tags": [ "Accessibility" ], "summary": "Get Accessibility Tests", "description": "Retrieve a paginated list of all accessibility tests that have been submitted. Each test includes details such as its status, the number of checks performed, and, of those checks, how many passes and failures there were. The response is paginated, with a limit of up to 1000 items per page. The total count of records will display in the meta object under the key, 'count'.", "operationId": "GET-v1-inspect-accessibility", "parameters": [ { "name": "limit", "in": "query", "description": "Max count of items. Max: 1000. Default: 100", "schema": { "type": "integer" } }, { "name": "skip", "in": "query", "description": "Get the list of items starting at the nth element (paging). Default: 0", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-accessibility-GetAccessibilityTestsJSONAPIResponse" }, "examples": { "Example": { "value": { "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": [ { "id": "675c62d60a1d3f3547e3c08c", "status": "Complete", "checks": 57, "passes": 39, "failures": 6, "needs_review": 2, "created_at": "2025-05-01T12:00:00Z", "updated_at": "2025-05-01T12:00:10Z" } ] } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } } }, "security": [ { "basicAuth": [] } ] }, "post": { "tags": [ "Accessibility" ], "summary": "Create Accessibility Test", "description": "This endpoint allows users to submit an accessibility test for processing. It accepts a set of HTML content, processes it for accessibility issues, and returns a unique job ID for tracking the status of the test. The status of the job will display in the meta object, with a status of 'Processing'.", "operationId": "POST-v1-inspect-accessibility", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/POST-v1-inspect-accessibility-application-json-RequestBody" } } }, "required": true }, "responses": { "201": { "description": "A 201 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-accessibility-CreateAccessibilityJSONAPIResponse" }, "examples": { "Example": { "value": { "meta": { "created_at": "2025-05-28T05:30:00Z", "status": "Processing" }, "items": { "id": "677ea3cdf1051e25e7dbfe73", "links": { "self": "https://api.mailgun.net/v1/inspect/accessibility/tests/677ea3cdf1051e25e7dbfe73" } } } } } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-accessibility-ErrorResponse" }, "examples": { "Example": { "value": { "errors": [ { "status": "400", "title": "BAD_REQUEST", "detail": [ "The html field cannot be empty" ] } ] } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/inspect/accessibility/{id}": { "get": { "tags": [ "Accessibility" ], "summary": "Get Accessibility Test", "description": "Retrieve the details of a specific accessibility test using the provided test ID. This endpoint returns comprehensive details about the test, including metadata and test results.", "operationId": "GET-v1-inspect-accessibility--id-", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the test.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-accessibility-GetAccessibilityTestJSONAPIResponse" }, "examples": { "Example": { "value": { "meta": { "created_at": "2025-05-28T05:30:00Z", "status": "Complete", "updated_at": "2025-05-28T05:30:10Z" }, "items": [ { "checks": 57, "passes": [ { "rule": "Area Alt", "description": "Ensures an element's role supports its ARIA attributes", "standards": [ "WCAG 2A" ], "pour": [ "Robust" ], "compliance": [ "WCAG: 4.1.2 Name, Role, Value" ] } ], "failures": [ { "rule": "Check Title Attributes", "impact": "serious", "description": "Ensures links have discernible text", "standards": [ "Best Practice" ], "pour": [ "Robust" ], "compliance": [ "Best Practice" ], "instances": [ { "correctAny": [ "Element does not have text that is visible to screen readers", "aria-label attribute does not exist or is empty", "aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty", "Element has no title attribute" ], "correctAll": [ "" ], "snippet": "", "target": [ "a:nth-child(1)" ], "lineNumber": 56, "absoluteIndex": 19 }, { "correctAny": [ "Element does not have text that is visible to screen readers", "aria-label attribute does not exist or is empty", "aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty", "Element has no title attribute" ], "correctAll": [ "" ], "snippet": "", "target": [ "a:nth-child(2)" ], "lineNumber": 58, "absoluteIndex": 23 }, { "correctAny": [ "Element does not have text that is visible to screen readers", "aria-label attribute does not exist or is empty", "aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty", "Element has no title attribute" ], "correctAll": [ "" ], "snippet": "", "target": [ "a:nth-child(3)" ], "lineNumber": 64, "absoluteIndex": 25 }, { "correctAny": [ "Element does not have text that is visible to screen readers", "aria-label attribute does not exist or is empty", "aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty", "Element has no title attribute" ], "correctAll": [ "" ], "snippet": "", "target": [ "a:nth-child(4)" ], "lineNumber": 75, "absoluteIndex": 28 } ] }, { "rule": "Document Title", "impact": "serious", "description": "Ensures each HTML document contains a non-empty element", "standards": [ "WCAG 2A" ], "pour": [ "Operable" ], "compliance": [ "WCAG: 2.4.2 Page Titled" ], "instances": [ { "correctAny": [ "Document does not have a non-empty <title> element" ], "correctAll": [ "" ], "snippet": "<html xmlns=\"http://www.w3.org/1999/xhtml\" xmlns:o=\"urn:schemas-microsoft-com:office:office\" xmlns:v=\"urn:schemas-microsoft-com:vml\">", "target": [ "html" ], "lineNumber": 2, "absoluteIndex": 1 } ] } ], "needs_review": [ { "rule": "Color Contrast", "impact": "serious", "description": "Ensures the contrast between foreground and background colors meets WCAG 2 AA minimum contrast ratio thresholds", "standards": [ "WCAG 2AA" ], "pour": [ "Perceivable" ], "compliance": [ "WCAG: 1.4.3 Contrast (Minimum)" ], "instances": [ { "correctAny": [ "Element's background color could not be determined due to a background gradient" ], "correctAll": [ "" ], "snippet": "<h2 class=\"mg-title\" style=\"color:rgb(17, 14, 176); font-size: 15px;\"> Mailgun Engineering Team </h2>", "target": [ "h2" ], "lineNumber": 15, "absoluteIndex": 2 } ] } ] } ] } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } }, "404": { "description": "A 404 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "errors": [ { "status": "404", "title": "NOT_FOUND", "detail": [ "Accessibility test with test id <id> not found" ] } ] } } } } } } }, "security": [ { "basicAuth": [] } ] }, "delete": { "tags": [ "Accessibility" ], "summary": "Delete Accessibility Test", "description": "Delete a specific accessibility test by its unique test ID. This endpoint allows you to remove an accessibility test from the system. If the test ID does not exist, the appropriate error message is returned.", "operationId": "DELETE-v1-inspect-accessibility--id-", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the test.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "Accessibility test with test id <id> has been successfully deleted." } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } }, "404": { "description": "A 404 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "errors": [ { "status": "404", "title": "NOT_FOUND", "detail": [ "Accessibility test with test id <id> not found" ] } ] } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/inspect/analyze/dictionary": { "get": { "tags": [ "Code Analysis" ], "summary": "Get Code Analysis Dictionary", "description": "Returns the lookup dictionary containing variants, clients, platforms, application types, support levels, and categories used in code analysis.", "operationId": "GET-v1-inspect-analyze-dictionary", "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-codeanalysis-Dictionary" }, "examples": { "Example": { "value": { "lookups": { "clients": { "apple": "Apple Mail", "gmail": "Gmail", "outlook": "Outlook" }, "platforms": { "macos": "macOS", "outlook-com": "Outlook.com", "webmail": "Webmail", "windows": "Windows" }, "application_type": { "macos": "desktop", "outlook-com": "web", "webmail": "web", "windows": "desktop" }, "support_levels": { "a": "Partially supported", "n": "Not supported", "u": "Support unknown", "y": "Supported" }, "categories": { "css": "CSS", "html": "HTML" }, "variants": { "mtx_gmail_webmail_2023-01": { "client": "gmail", "platform": "webmail", "version": "2023-01" }, "mtx_outlook_outlook-com_2024-01": { "client": "outlook", "platform": "outlook-com", "version": "2024-01" }, "mtx_outlook_windows_2016": { "client": "outlook", "platform": "windows", "version": "2016" } } } } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } }, "500": { "description": "A 500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "failed to generate dictionary" } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/inspect/analyze": { "get": { "tags": [ "Code Analysis" ], "summary": "List Code Analysis Jobs", "description": "Returns a paginated list of all code analysis jobs under the account, showing only the latest version of each test. Uses skip/limit pagination and supports filtering by status.", "operationId": "GET-v1-inspect-analyze", "parameters": [ { "name": "status", "in": "query", "description": "Filter jobs by status (Processing, Completed, Failed)", "schema": { "type": "string", "enum": [ "Processing", "Completed", "Failed" ], "x-enumDescriptions": { "Processing": "Filter by jobs that are currently processing", "Completed": "Filter by jobs that have completed", "Failed": "Filter by jobs that have failed" } } }, { "name": "limit", "in": "query", "description": "Limits the number of items returned in a request", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-codeanalysis-CodeAnalysisListResponse" }, "examples": { "Example": { "value": { "meta": { "count": 25, "first": "https://api.mailgun.com/v1/inspect/analyze?skip=0&limit=10", "last": "https://api.mailgun.com/v1/inspect/analyze?skip=240&limit=10", "next": "https://api.mailgun.com/v1/inspect/analyze?skip=20&limit=10", "previous": "https://api.mailgun.com/v1/inspect/analyze?skip=0&limit=10" }, "items": [ { "test_id": "67a654ba0f53254b9fdca3e2", "status": "Completed", "version": 1, "created_at": "2024-01-15T10:30:45Z", "links": { "self": "https://api.mailgun.com/v1/inspect/analyze/67a654ba0f53254b9fdca3e2" } }, { "test_id": "67a654ba0f53254b9fdca3e4", "status": "Processing", "version": 2, "created_at": "2024-01-15T14:22:30Z", "links": { "self": "https://api.mailgun.com/v1/inspect/analyze/67a654ba0f53254b9fdca3e4" } } ] } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } }, "404": { "description": "A 404 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "No code analysis jobs found matching the criteria" } } } } } } }, "security": [ { "basicAuth": [] } ] }, "post": { "tags": [ "Code Analysis" ], "summary": "Create a Code Analysis Test", "description": "Create a code analysis test to analyze HTML content for email client feature compatibility.", "operationId": "POST-v1-inspect-analyze", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-htmlparser-types-HTMLEngineAPIRequest" } } }, "required": true }, "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-codeanalysis-TestCreationResponse" }, "examples": { "Example": { "value": { "meta": { "status": "Processing", "version": 1 }, "items": { "id": "67a654ba0f53254b9fdca3e2", "links": { "self": "https://api.mailgun.com/v1/inspect/analyze/67a654ba0f53254b9fdca3e2" } } } } } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "You must provide either HTML content, MIME content, or a URL source" } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/inspect/analyze/{test_id}": { "get": { "tags": [ "Code Analysis" ], "summary": "Get Code Analysis Results", "description": "Returns the latest version of code analysis test results for a given test ID.", "operationId": "GET-v1-inspect-analyze--test-id-", "parameters": [ { "name": "test_id", "in": "path", "description": "The ID of the code analysis test we want to check the results for", "required": true, "schema": { "type": "string" } }, { "name": "slug", "in": "query", "description": "Filter results by feature slug", "schema": { "type": "string" } }, { "name": "support_type", "in": "query", "description": "Filter results by support type (y=supported, a=partial, n=not supported, u=unknown)", "schema": { "type": "string", "enum": [ "y", "a", "n", "u" ], "x-enumDescriptions": { "y": "Filter by supported clients", "a": "Filter by partially supported clients", "n": "Filter by not supported clients", "u": "Filter by unknown clients" } } }, { "name": "application_type", "in": "query", "description": "Filter results by application type (web, mobile, desktop). Only variants belonging to the specified application type will be included in the response.", "schema": { "type": "string", "enum": [ "web", "mobile", "desktop" ], "x-enumDescriptions": { "web": "Filter by web-based email clients", "mobile": "Filter by mobile email clients", "desktop": "Filter by desktop email clients" } } }, { "name": "group_by", "in": "query", "description": "Group variants by their implementation notes. When set to 'notes', variants within each support level are grouped by their note content. The response structure changes: instead of VariantReference arrays, each support level (y/a/n/u) contains GroupedVariantsByNote objects with 'note' field and 'variants' array. A 'grouped_by' field is added to meta.", "schema": { "type": "string", "enum": [ "notes" ], "x-enumDescriptions": { "notes": "Group variants by their implementation notes" } } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-codeanalysis-TestResultResponse" }, "examples": { "Normal Response": { "value": { "meta": { "application_support": { "mobile": { "partial_support": 5 }, "web": { "supported": 20 } }, "count": 1, "inbox_provider_support": { "gmail": { "supported": 10, "unsupported": 2 }, "outlook": { "partial_support": 4, "supported": 8 } }, "market_support": { "partial_support": 15, "supported": 75, "unknown": 2, "unsupported": 8 }, "status": "Completed", "version": 1 }, "items": { "id": "67a654ba0f53254b9fdca3e2", "version": 1, "features": [ { "slug": "css-padding", "name": "CSS Padding", "description": "CSS padding property for spacing inside elements", "category": "css", "notes_lookup": { "1": "Partial. Only supported on table cells.", "2": "Buggy. Vertical padding will be the same for all cells of a same row, adopting the biggest value." }, "instances": [ { "id": "inst_1", "line": 15, "column": 8 } ], "support": { "y": [ { "id": "mtx_gmail_webmail_2023-01" } ], "a": [ { "id": "mtx_outlook_windows_2016", "notes": [ "1" ] }, { "id": "mtx_outlook_outlook-com_2024-01", "notes": [ "2" ] } ] } } ] } } }, "Grouped by Notes Response": { "value": { "meta": { "application_support": { "mobile": { "partial_support": 5 }, "web": { "supported": 20 } }, "count": 1, "grouped_by": "notes", "inbox_provider_support": { "gmail": { "supported": 10, "unsupported": 2 }, "outlook": { "partial_support": 4, "supported": 8 } }, "market_support": { "partial_support": 15, "supported": 75, "unknown": 2, "unsupported": 8 }, "status": "Completed", "version": 1 }, "items": { "id": "67a654ba0f53254b9fdca3e2", "version": 1, "features": [ { "slug": "css-padding", "name": "CSS Padding", "description": "CSS padding property for spacing inside elements", "category": "css", "notes_lookup": { "1": "Partial. Only supported on table cells.", "2": "Buggy. Vertical padding will be the same for all cells of a same row, adopting the biggest value." }, "instances": [ { "id": "inst_1", "line": 15, "column": 8 } ], "support": { "y": [ { "variants": [ "mtx_gmail_webmail_2023-01" ] } ], "a": [ { "note": "1", "variants": [ "mtx_outlook_windows_2016" ] }, { "note": "2", "variants": [ "mtx_outlook_outlook-com_2024-01" ] } ] } } ] } } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } }, "404": { "description": "A 404 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "Test '67a654ba0f53254b9fdca3e2' not found" } } } } } } }, "security": [ { "basicAuth": [] } ] }, "post": { "tags": [ "Code Analysis" ], "summary": "Create New Code Analysis Version", "description": "Creates a new version of an existing code analysis test with incremented version number.", "operationId": "POST-v1-inspect-analyze--test-id-", "parameters": [ { "name": "test_id", "in": "path", "description": "The ID of the existing code analysis test", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-htmlparser-types-HTMLEngineAPIRequest" } } }, "required": true }, "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-codeanalysis-TestCreationResponse" }, "examples": { "Example": { "value": { "meta": { "status": "Processing", "version": 4 }, "items": { "id": "67a654ba0f53254b9fdca3e2", "links": { "self": "https://api.mailgun.com/v1/inspect/analyze/67a654ba0f53254b9fdca3e2" } } } } } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "You must provide either HTML content, MIME content, or a URL source" } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } }, "404": { "description": "A 404 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "Test not found" } } } } } } }, "security": [ { "basicAuth": [] } ] }, "delete": { "tags": [ "Code Analysis" ], "summary": "Delete Code Analysis Test", "description": "Deletes all versions of a code analysis test by test ID.", "operationId": "DELETE-v1-inspect-analyze--test-id-", "parameters": [ { "name": "test_id", "in": "path", "description": "The ID of the code analysis test to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "Test <id> has been successfully deleted." } } } } } }, "204": { "description": "A 204 response" }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } }, "404": { "description": "A 404 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-NotFoundError" }, "examples": { "Example": { "value": { "Description": "test not found" } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/inspect/analyze/{test_id}/versions/{version_id}": { "get": { "tags": [ "Code Analysis" ], "summary": "Get Code Analysis Results by Version", "description": "Returns code analysis test results for a specific test ID and version.", "operationId": "GET-v1-inspect-analyze--test-id--versions--version-id-", "parameters": [ { "name": "test_id", "in": "path", "description": "The ID of the code analysis test", "required": true, "schema": { "type": "string" } }, { "name": "version_id", "in": "path", "description": "The version number of the test results", "required": true, "schema": { "type": "string" } }, { "name": "slug", "in": "query", "description": "Filter results by feature slug", "schema": { "type": "string" } }, { "name": "support_type", "in": "query", "description": "Filter results by support type (y=supported, a=partial, n=not supported, u=unknown)", "schema": { "type": "string" } }, { "name": "application_type", "in": "query", "description": "Filter results by application type (web, mobile, desktop). Only variants belonging to the specified application type will be included in the response.", "schema": { "type": "string", "enum": [ "web", "mobile", "desktop" ], "x-enumDescriptions": { "web": "Filter by web-based email clients", "mobile": "Filter by mobile email clients", "desktop": "Filter by desktop email clients" } } }, { "name": "group_by", "in": "query", "description": "Group variants by their implementation notes. When set to 'notes', variants within each support level are grouped by their note content. The response structure changes: instead of VariantReference arrays, each support level (y/a/n/u) contains GroupedVariantsByNote objects with 'note' field and 'variants' array. A 'grouped_by' field is added to meta.", "schema": { "type": "string", "enum": [ "notes" ], "x-enumDescriptions": { "notes": "Group variants by their implementation notes" } } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-codeanalysis-TestResultResponse" }, "examples": { "Normal Response": { "value": { "meta": { "application_support": { "web": { "supported": 25 } }, "count": 1, "inbox_provider_support": { "gmail": { "supported": 12, "unsupported": 1 } }, "market_support": { "partial_support": 10, "supported": 80, "unknown": 5, "unsupported": 5 }, "status": "Completed", "version": 2 }, "items": { "id": "67a654ba0f53254b9fdca3e2", "version": 2, "features": [ { "slug": "flexbox", "name": "CSS Flexbox", "description": "Flexible box layout for responsive design", "category": "css", "instances": [ { "id": "inst_2", "line": 20, "column": 5 } ], "support": { "y": [ { "id": "mtx_outlook_desktop_2021" } ] } } ] } } }, "Grouped by Notes Response": { "value": { "meta": { "application_support": { "web": { "supported": 25 } }, "count": 1, "grouped_by": "notes", "inbox_provider_support": { "gmail": { "supported": 12, "unsupported": 1 } }, "market_support": { "partial_support": 10, "supported": 80, "unknown": 5, "unsupported": 5 }, "status": "Completed", "version": 2 }, "items": { "id": "67a654ba0f53254b9fdca3e2", "version": 2, "features": [ { "slug": "flexbox", "name": "CSS Flexbox", "description": "Flexible box layout for responsive design", "category": "css", "instances": [ { "id": "inst_2", "line": 20, "column": 5 } ], "support": { "y": [ { "variants": [ "mtx_outlook_desktop_2021" ] } ] } } ] } } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } }, "404": { "description": "A 404 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "Test result not found" } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/inspect/analyze/{test_id}/versions": { "get": { "tags": [ "Code Analysis" ], "summary": "Get All Code Analysis Versions", "description": "Returns all versions available for a given test ID.", "operationId": "GET-v1-inspect-analyze--test-id--versions", "parameters": [ { "name": "test_id", "in": "path", "description": "The ID of the code analysis test", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-codeanalysis-VersionListResponse" }, "examples": { "Example": { "value": { "meta": { "count": 3 }, "items": { "versions": [ { "id": "67a654ba0f53254b9fdca3e2", "version": 1, "links": { "self": "https://api.mailgun.com/v1/inspect/analyze/67a654ba0f53254b9fdca3e2/versions/1" } }, { "id": "67a654ba0f53254b9fdca3e2", "version": 2, "links": { "self": "https://api.mailgun.com/v1/inspect/analyze/67a654ba0f53254b9fdca3e2/versions/2" } }, { "id": "67a654ba0f53254b9fdca3e2", "version": 3, "links": { "self": "https://api.mailgun.com/v1/inspect/analyze/67a654ba0f53254b9fdca3e2/versions/3" } } ] } } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } }, "404": { "description": "A 404 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "Test not found" } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/inspect/analyze/{test_id}/resolve/{id}": { "post": { "tags": [ "Code Analysis" ], "summary": "Update Resolved Status", "description": "Updates the resolved status of a specific instance within a feature in the latest version of a test.", "operationId": "POST-v1-inspect-analyze--test-id--resolve--id-", "parameters": [ { "name": "test_id", "in": "path", "description": "The ID of the code analysis test", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The ID of the instance to update (found in features[].instances[].id)", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-codeanalysis-ResolveRequest" } } }, "required": true }, "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-codeanalysis-TestResultResponse" }, "examples": { "Example": { "value": { "meta": { "application_support": { "web": { "supported": 30 } }, "count": 1, "inbox_provider_support": { "gmail": { "supported": 15, "unsupported": 1 } }, "market_support": { "partial_support": 10, "supported": 85, "unknown": 2, "unsupported": 3 }, "status": "Completed", "version": 1 }, "items": { "id": "67a654ba0f53254b9fdca3e2", "version": 1, "features": [ { "slug": "css-grid", "name": "CSS Grid Layout", "description": "CSS Grid Layout is a two-dimensional grid-based layout system", "category": "css", "instances": [ { "id": "inst_3", "line": 15, "column": 8, "resolved": true } ], "support": { "y": [ { "id": "mtx_gmail_webmail_2023-01" } ] } } ] } } } } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "id must be a valid ObjectID" } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } }, "404": { "description": "A 404 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "no matched result found with the given test ID and result ID" } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/inspect/spam": { "get": { "tags": [ "Spam Testing" ], "summary": "List Spam Tests (V1)", "description": "Returns a paginated list of all spam tests for the account, ordered by created_at desc. Supports filtering by status and region.", "operationId": "GET-v1-inspect-spam", "parameters": [ { "name": "status", "in": "query", "description": "Filter by spam test lifecycle status", "schema": { "type": "string", "enum": [ "pending", "processing", "completed", "failed" ], "x-enumDescriptions": { "pending": "Test created.", "processing": "Test accepted; seeds still delivering", "completed": "Results fully mapped and persisted", "failed": "Unrecoverable error during test execution" } } }, { "name": "region", "in": "query", "description": "Filter by sending region", "schema": { "type": "string", "enum": [ "us1", "eu1" ], "x-enumDescriptions": { "us1": "United States region", "eu1": "European Union region" } } }, { "name": "sort_by", "in": "query", "description": "Field to sort by", "schema": { "type": "string", "enum": [ "created_at", "updated_at" ], "x-enumDescriptions": { "created_at": "Sort by creation time (default)", "updated_at": "Sort by last update time" } } }, { "name": "sort_order", "in": "query", "description": "Sort direction", "schema": { "type": "string", "enum": [ "desc", "asc" ], "x-enumDescriptions": { "desc": "Descending (default)", "asc": "Ascending" } } }, { "name": "limit", "in": "query", "description": "Limits the number of items returned in a request", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-spam-SpamTestListResponse" }, "examples": { "Example": { "value": { "meta": {}, "items": [ { "id": "67a654ba0f53254b9fdca3e2", "status": "completed", "subject": "Welcome to Mailgun", "region": "us1", "results": { "b2c": { "passed": 2, "failed": 1, "results": [ { "esp": "Gmail", "display_name": "Gmail", "status": "pass", "placement": "inbox", "folder": "Primary" }, { "esp": "Yahoo", "display_name": "Yahoo", "status": "pass", "placement": "inbox" }, { "esp": "AOL", "display_name": "AOL", "status": "fail", "placement": "spam" } ] }, "b2b": { "passed": 3, "failed": 2, "pending": 1, "results": [ { "esp": "Google Workspace", "display_name": "Google Workspace", "status": "pass", "placement": "inbox" }, { "esp": "Outlook", "display_name": "Outlook", "status": "fail", "placement": "spam", "folder": "Junk" }, { "esp": "Outlook", "display_name": "Hotmail", "status": "fail", "placement": "spam", "folder": "Junk" }, { "esp": "O365", "display_name": "O365", "status": "pending", "placement": "pending" }, { "esp": "Proofpoint", "display_name": "Proofpoint", "status": "pass", "placement": "inbox" }, { "esp": "Mimecast", "display_name": "Mimecast", "status": "pass", "placement": "inbox" } ] } }, "created_at": "2026-03-11T10:00:00Z", "updated_at": "2026-03-11T10:01:30Z" }, { "id": "67a654ba0f53254b9fdca3e2", "status": "processing", "subject": "Welcome to Mailgun", "region": "us1", "created_at": "2026-03-11T10:00:00Z", "updated_at": "2026-03-11T10:00:05Z" } ], "links": {} } } } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "invalid value for 'status': must be one of [pending processing completed failed]" } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } } }, "security": [ { "basicAuth": [] } ] }, "post": { "tags": [ "Spam Testing" ], "summary": "Create Spam Test (V1)", "description": "Initiates an inbox placement test with subject and HTML provided directly in the request body. Returns immediately with status=processing; poll GET using the Retry-After interval.", "operationId": "POST-v1-inspect-spam", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-spam-CreateSpamTestV1Request" } } }, "required": true }, "responses": { "201": { "description": "A 201 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-spam-SpamTestItemResponse" }, "examples": { "Example": { "value": { "meta": {}, "item": { "id": "67a654ba0f53254b9fdca3e2", "status": "processing", "subject": "Welcome to Mailgun", "region": "us1", "created_at": "2026-03-11T10:00:00Z", "updated_at": "2026-03-11T10:00:05Z" }, "links": {} } } } } } }, "400": { "description": "A 400 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "subject is required" } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/inspect/spam/{spam_test_id}": { "get": { "tags": [ "Spam Testing" ], "summary": "Get Spam Test (V1)", "description": "Returns the current state of a spam test. A Retry-After: 10 header is set when the test is still processing.", "operationId": "GET-v1-inspect-spam--spam-test-id-", "parameters": [ { "name": "spam_test_id", "in": "path", "description": "ID of the spam test", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-spam-SpamTestItemResponse" }, "examples": { "Example": { "value": { "meta": {}, "item": { "id": "67a654ba0f53254b9fdca3e2", "status": "completed", "subject": "Welcome to Mailgun", "region": "us1", "results": { "b2c": { "passed": 2, "failed": 1, "results": [ { "esp": "Gmail", "display_name": "Gmail", "status": "pass", "placement": "inbox", "folder": "Primary" }, { "esp": "Yahoo", "display_name": "Yahoo", "status": "pass", "placement": "inbox" }, { "esp": "AOL", "display_name": "AOL", "status": "fail", "placement": "spam" } ] }, "b2b": { "passed": 3, "failed": 2, "pending": 1, "results": [ { "esp": "Google Workspace", "display_name": "Google Workspace", "status": "pass", "placement": "inbox" }, { "esp": "Outlook", "display_name": "Outlook", "status": "fail", "placement": "spam", "folder": "Junk" }, { "esp": "Outlook", "display_name": "Hotmail", "status": "fail", "placement": "spam", "folder": "Junk" }, { "esp": "O365", "display_name": "O365", "status": "pending", "placement": "pending" }, { "esp": "Proofpoint", "display_name": "Proofpoint", "status": "pass", "placement": "inbox" }, { "esp": "Mimecast", "display_name": "Mimecast", "status": "pass", "placement": "inbox" } ] } }, "created_at": "2026-03-11T10:00:00Z", "updated_at": "2026-03-11T10:01:30Z" }, "links": {} } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } }, "404": { "description": "A 404 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "spam test '67a654ba0f53254b9fdca3e2' not found" } } } } } } }, "security": [ { "basicAuth": [] } ] }, "delete": { "tags": [ "Spam Testing" ], "summary": "Delete Spam Test (V1)", "description": "Permanently deletes the spam test and its results.", "operationId": "DELETE-v1-inspect-spam--spam-test-id-", "parameters": [ { "name": "spam_test_id", "in": "path", "description": "ID of the spam test to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "Spam test '67a654ba0f53254b9fdca3e2' deleted successfully" } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } }, "404": { "description": "A 404 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "spam test '67a654ba0f53254b9fdca3e2' not found" } } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/v1/inspect/spam/providers": { "get": { "tags": [ "Spam Testing" ], "summary": "List Supported ESP Providers", "description": "Returns the static list of ESPs supported by spam testing, grouped by category (B2C / B2B).", "operationId": "GET-v1-inspect-spam-providers", "responses": { "200": { "description": "A 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-spam-ProviderListResponse" }, "examples": { "Example": { "value": { "meta": {}, "items": [ { "domain": "gmail.com", "display_name": "Gmail", "category": "b2c" }, { "domain": "yahoo.com", "display_name": "Yahoo", "category": "b2c" }, { "domain": "aol.com", "display_name": "AOL", "category": "b2c" }, { "domain": "Google Workspace", "display_name": "Google Workspace", "category": "b2b" }, { "domain": "outlook.com", "display_name": "Outlook", "category": "b2b" }, { "domain": "hotmail.com", "display_name": "Hotmail", "category": "b2b" }, { "domain": "o365.mailgun.email", "display_name": "O365", "category": "b2b" }, { "domain": "Proofpoint", "display_name": "Proofpoint", "category": "b2b" }, { "domain": "Mimecast", "display_name": "Mimecast", "category": "b2b" } ], "links": {} } } } } } }, "401": { "description": "A 401 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse" }, "examples": { "Example": { "value": { "message": "unauthorized" } } } } } } }, "security": [ { "basicAuth": [] } ] } } }, "components": { "schemas": { "github.com-mailgun-emailpreview-clients-preview-ClientInfo": { "type": "object", "properties": { "id": { "type": "string" }, "client": { "type": "string" }, "os": { "type": "string" }, "category": { "type": "string" }, "browser": { "type": "string" }, "rotate": { "type": "boolean" }, "image_blocking": { "type": "boolean" }, "free": { "type": "boolean" }, "default": { "type": "boolean" }, "ext": { "type": "string" } }, "required": [ "id", "client", "os", "category" ] }, "github.com-mailgun-emailpreview-clients-preview-ClientsResponse": { "type": "object", "properties": { "clients": { "type": "object", "additionalProperties": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-ClientInfo" }, { "type": "null" } ] } } }, "required": [ "clients" ] }, "github.com-mailgun-scaffold-httpapi-GenericAPIError": { "type": "object", "properties": { "Reason": { "type": "string" } }, "required": [ "Reason" ] }, "github.com-mailgun-emailpreview-clients-preview-Error": { "type": "object", "properties": { "name": { "type": "string" }, "message": { "type": "string" } } }, "github.com-mailgun-emailpreview-clients-preview-ErrorResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-Error" } } }, "github.com-mailgun-scaffold-httpapi-GenericResponse": { "type": "object", "properties": { "message": { "type": "string", "description": "Response message" } }, "required": [ "message" ] }, "github.com-mailgun-emailpreview-clients-preview-Warning": { "type": "object", "properties": { "name": { "type": "string" }, "message": { "type": "string" } } }, "github.com-mailgun-emailpreview-clients-inspect-Links": { "type": "object", "properties": { "self": { "type": "string" } } }, "github.com-mailgun-emailpreview-clients-inspect-Item": { "type": "object", "properties": { "id": { "type": "string" }, "links": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-inspect-Links" } } }, "github.com-mailgun-emailpreview-clients-inspect-ErrorDetail": { "type": "object", "properties": { "status": { "type": "string" }, "title": { "type": "string" }, "detail": { "type": "string" } } }, "github.com-mailgun-emailpreview-clients-inspect-InspectDtoRepsponse": { "type": "object", "properties": { "items": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-inspect-Item" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-inspect-ErrorDetail" } } } }, "github.com-mailgun-emailpreview-clients-inspect-CodeAnalysisItem": { "type": "object", "properties": { "id": { "type": "string" }, "links": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-inspect-Links" } }, "required": [ "id", "links" ] }, "github.com-mailgun-emailpreview-clients-inspect-CodeAnalysisResponse": { "type": "object", "properties": { "meta": { "type": [ "object", "null" ], "additionalProperties": { "type": "object" } }, "items": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-inspect-CodeAnalysisItem" } }, "required": [ "items" ] }, "github.com-mailgun-emailpreview-clients-preview-ContentCheckingResult": { "type": "object", "properties": { "link_validation": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-inspect-InspectDtoRepsponse" }, { "type": "null" } ] }, "image_validation": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-inspect-InspectDtoRepsponse" }, { "type": "null" } ] }, "accessibility": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-inspect-InspectDtoRepsponse" }, { "type": "null" } ] }, "code_analysis": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-inspect-CodeAnalysisResponse" }, { "type": "null" } ] } } }, "github.com-mailgun-emailpreview-clients-preview-CreateTestResponse": { "type": "object", "properties": { "id": { "type": "string" }, "reference_id": { "type": "string" }, "customer_id": { "type": "string" }, "spam": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "address_list": { "type": "array", "items": { "type": "string" } } } }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-Warning" } }, "content_checking": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-ContentCheckingResult" }, { "type": "null" } ] } } }, "github.com-mailgun-emailpreview-clients-preview-TestRequestContentChecking": { "type": "object", "properties": { "link_validation": { "type": "boolean", "description": "Enable comprehensive link analysis" }, "image_validation": { "type": "boolean", "description": "Enable comprehensive image analysis" }, "accessibility": { "type": "boolean", "description": "Enable comprehensive accessibility analysis" }, "code_analysis": { "type": "boolean", "description": "Enable comprehensive code analysis of the email content to detect HTML and CSS features and provides a compatibility report across major email clients." } } }, "github.com-mailgun-emailpreview-clients-preview-CreateTestRequest": { "type": "object", "properties": { "subject": { "type": "string" }, "html": { "type": "string" }, "mime": { "type": "string" }, "url": { "type": "string" }, "transfer_encoding": { "type": "string" }, "charset": { "type": "string" }, "reference_id": { "type": "string" }, "customer_id": { "type": "string" }, "clients": { "type": "array", "items": { "type": "string" } }, "image_blocking": { "type": "boolean" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "spam": { "type": [ "object", "null" ], "properties": { "test_method": { "type": "string" }, "from_address": { "type": "string" }, "key": { "type": "string" }, "smtp_info": { "type": [ "object", "null" ], "properties": { "host": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "secure": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "string" } } } } }, "content_checking": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-TestRequestContentChecking" }, "user_id": { "type": "string" }, "folder_id": { "type": "string" }, "project_name": { "type": "string" } }, "required": [ "subject" ] }, "github.com-mailgun-emailpreview-clients-preview-GetTestsResponse": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "subject": { "type": "string" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "github.com-mailgun-emailpreview-clients-preview-TestResult": { "type": "object", "properties": { "id": { "type": "string" }, "display_name": { "type": "string" }, "client": { "type": "string" }, "os": { "type": "string" }, "category": { "type": "string" }, "browser": { "type": "string" }, "screenshots": { "type": "object", "additionalProperties": { "type": "string" } }, "thumbnail": { "type": "string" }, "full_thumbnail": { "type": "string" }, "status": { "type": "string" }, "status_details": { "type": [ "object", "null" ], "properties": { "submitted": { "type": "integer", "format": "int32" }, "completed": { "type": "integer", "format": "int32" }, "bounce_code": { "type": "string" }, "bounce_message": { "type": "string" } } } } }, "github.com-mailgun-emailpreview-clients-preview-GetTestResultsResponse": { "type": "object", "additionalProperties": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-TestResult" }, { "type": "null" } ] } }, "github.com-mailgun-emailpreview-clients-preview-DeleteTestResponse": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] }, "github.com-mailgun-emailpreview-clients-preview-ReprocessInfo": { "type": "object", "properties": { "success": { "type": "boolean" }, "remaining_reprocesses": { "type": "integer", "format": "int32" }, "regional": { "type": "boolean" }, "screenshot": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "sent": { "type": "integer", "format": "int32" }, "completed": { "type": "integer", "format": "int32" } } } }, "required": [ "regional" ] }, "github.com-mailgun-emailpreview-clients-preview-ReprocessTestResponse": { "type": "object", "additionalProperties": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-ReprocessInfo" }, { "type": "null" } ] } }, "github.com-mailgun-emailpreview-clients-preview-TestContentResponse": { "type": "object", "properties": { "content": { "type": "string" } }, "required": [ "content" ] }, "github.com-mailgun-emailpreview-clients-preview-GetTestInfoResponse": { "type": "object", "properties": { "subject": { "type": "string" }, "date": { "type": "integer", "format": "int32" }, "completed": { "type": "array", "items": { "type": "string" } }, "processing": { "type": "array", "items": { "type": "string" } }, "bounced": { "type": "array", "items": { "type": "string" } }, "content_checking": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-ContentCheckingResult" }, { "type": "null" } ] } }, "required": [ "subject", "date" ] }, "string": { "type": "string" }, "github.com-mailgun-emailpreview-address-PreviewAddressResponse": { "type": "object", "properties": { "preview_address": { "type": "string" } }, "required": [ "preview_address" ] }, "github.com-mailgun-emailpreview-queue_tracking-APIError": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "github.com-mailgun-emailpreview-queue_tracking-QueueTracking": { "type": "object", "properties": { "job_id": { "type": "string" }, "test_id": { "type": "string" }, "clients": { "type": "array", "items": { "type": "string" } }, "job_status": { "type": "string" }, "zip_url": { "type": "string" }, "failed_clients": { "type": "array", "items": { "type": "string" } }, "error": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-queue_tracking-APIError" }, { "type": "null" } ] } }, "required": [ "job_id", "test_id", "clients", "job_status" ] }, "github.com-mailgun-emailpreview-clients-preview-CreateZipExport": { "type": "object", "properties": { "clients": { "type": "array", "items": { "type": "string" } }, "test_id": { "type": "string" } }, "required": [ "clients", "test_id" ] }, "github.com-mailgun-emailpreview-api-CreatePreviewSharingRequest": { "type": "object", "properties": { "test_id": { "type": "string" } }, "required": [ "test_id" ] }, "github.com-mailgun-emailpreview-sharing-PreviewSharingResponse": { "type": "object", "properties": { "test_id": { "type": "string" }, "url_uuid": { "type": "string" }, "url": { "type": "string" }, "enabled": { "type": "boolean" }, "expires_at": { "type": "string", "format": "date-time" } }, "required": [ "test_id", "url_uuid", "url", "enabled", "expires_at" ] }, "github.com-mailgun-emailpreview-api-PreviewTestResultsResponse": { "type": "object", "properties": { "subject": { "type": "string" }, "date": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-emailpreview-clients-preview-TestResult" } } }, "required": [ "subject", "date", "results" ] }, "github.com-mailgun-inspect-internal-linkvalidation-SelfLink": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "github.com-mailgun-inspect-internal-linkvalidation-RuleEvaluation": { "type": "object", "properties": { "id": { "type": "string" }, "rule": { "type": "string" }, "description": { "type": "string" }, "impact": { "type": "string" }, "recommendation": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } } }, "required": [ "id", "rule", "description", "details" ] }, "github.com-mailgun-inspect-internal-linkvalidation-LinkValidationResult": { "type": "object", "properties": { "url": { "type": "string" }, "status": { "type": "string" }, "status_code": { "type": "integer", "format": "int32" }, "line": { "type": "integer", "format": "int32" }, "column": { "type": "integer", "format": "int32" }, "selector": { "type": "string" }, "absolute_index": { "type": "integer", "format": "int32" }, "passes": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-linkvalidation-RuleEvaluation" } }, "failures": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-linkvalidation-RuleEvaluation" } }, "informational": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-linkvalidation-RuleEvaluation" } } }, "required": [ "url", "status" ] }, "github.com-mailgun-inspect-internal-linkvalidation-LinkValidation": { "type": "object", "properties": { "id": { "type": "string" }, "links": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-linkvalidation-SelfLink" }, { "type": "null" } ] }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-linkvalidation-LinkValidationResult" } } }, "required": [ "id" ] }, "github.com-mailgun-inspect-internal-linkvalidation-GetLinkValidationJSONAPIResponse": { "type": "object", "properties": { "meta": { "type": [ "object", "null" ], "additionalProperties": { "type": "object" } }, "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-linkvalidation-LinkValidation" } } }, "github.com-mailgun-inspect-internal-linkvalidation-CreateResource": { "type": "object", "properties": { "id": { "type": "string" }, "links": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-linkvalidation-SelfLink" }, { "type": "null" } ] } }, "required": [ "id" ] }, "github.com-mailgun-inspect-internal-linkvalidation-CreateLinkValidationJSONAPIResponse": { "type": "object", "properties": { "meta": { "type": [ "object", "null" ], "additionalProperties": { "type": "object" } }, "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-linkvalidation-CreateResource" } } }, "github.com-mailgun-inspect-internal-linkvalidation-Link": { "type": "object", "properties": { "url": { "type": "string" }, "line": { "type": "integer", "format": "int32" }, "column": { "type": "integer", "format": "int32" }, "selector": { "type": "string" }, "absolute_index": { "type": "integer", "format": "int32" } }, "required": [ "url" ] }, "github.com-mailgun-inspect-internal-linkvalidation-LinkValidationRequest": { "type": "object", "properties": { "links": { "type": "array", "items": { "type": "string" } }, "linksWithPositions": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-linkvalidation-Link" } }, "userAgent": { "type": [ "string", "null" ] } }, "required": [ "userAgent" ] }, "github.com-mailgun-htmlparser-types-HTMLEngineAPIRequest": { "type": "object", "properties": { "html": { "type": "string" }, "url": { "type": "string" }, "mime": { "type": "string" }, "transfer_encoding": { "type": "string" }, "charset": { "type": "string" } } }, "github.com-mailgun-inspect-internal-linkvalidation-Alert": { "type": "object", "properties": { "severity": { "type": "string" }, "data": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "severity" ] }, "github.com-mailgun-inspect-internal-linkvalidation-CSVValidationError": { "type": "object", "properties": { "row": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "alert": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-linkvalidation-Alert" }, { "type": "null" } ] } }, "required": [ "row", "message" ] }, "github.com-mailgun-inspect-internal-linkvalidation-CSVValidationResponse": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-linkvalidation-CSVValidationError" } } }, "required": [ "valid" ] }, "github.com-mailgun-inspect-internal-linkvalidation-CSVLinkValidationJSONAPIResponse": { "type": "object", "properties": { "meta": { "type": [ "object", "null" ], "additionalProperties": { "type": "object" } }, "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-linkvalidation-CSVValidationResponse" } } }, "github.com-mailgun-scaffold-httpapi-paging-PagingResponse": { "type": "object", "properties": { "previous": { "type": "string", "description": "Previous page URL" }, "first": { "type": "string", "description": "First page URL" }, "next": { "type": "string", "description": "Next page URL" }, "last": { "type": "string", "description": "Last page URL" } }, "required": [ "previous", "first", "next", "last" ] }, "github.com-mailgun-inspect-internal-linkvalidation-GetLinkValidationTestsJSONAPIResponse": { "type": "object", "properties": { "meta": { "type": [ "object", "null" ], "additionalProperties": { "type": "object" } }, "paging": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-paging-PagingResponse" }, { "type": "null" } ] }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-linkvalidation-LinkValidation" } } } }, "github.com-mailgun-inspect-internal-imagevalidation-RuleEvaluation": { "type": "object", "properties": { "id": { "type": "string" }, "rule": { "type": "string" }, "description": { "type": "string" }, "impact": { "type": "string" }, "recommendation": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } } }, "required": [ "id", "rule", "description", "details" ] }, "github.com-mailgun-inspect-internal-imagevalidation-ImageValidationResult": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" }, "line": { "type": "integer", "format": "int32" }, "column": { "type": "integer", "format": "int32" }, "selector": { "type": "string" }, "absolute_index": { "type": "integer", "format": "int32" }, "passes": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-RuleEvaluation" } }, "failures": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-RuleEvaluation" } }, "informational": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-RuleEvaluation" } } }, "required": [ "id", "status" ] }, "github.com-mailgun-inspect-internal-imagevalidation-OptimizedImageStatus": { "type": "string", "enum": [ "Complete", "Error", "Processing" ], "description": "Status of the optimized image processing", "x-enumDescriptions": { "Complete": "Image optimization has completed successfully", "Error": "Image optimization failed with an error", "Processing": "Image optimization is currently in progress" } }, "github.com-mailgun-inspect-internal-imagevalidation-OptimizedImage": { "type": "object", "properties": { "id": { "type": "string" }, "original_image_id": { "type": "string" }, "image_url": { "type": "string" }, "optimized_url": { "type": "string" }, "optimized_file_size": { "type": "string" }, "optimized_format": { "type": "string" }, "optimized_mime_type": { "type": "string" }, "load_time_ms": { "type": [ "integer", "null" ], "format": "int64" }, "status": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-OptimizedImageStatus" } ], "description": "Status of the optimized image processing" }, "error_message": { "type": "string" } }, "required": [ "id", "original_image_id", "image_url", "status" ] }, "github.com-mailgun-inspect-internal-imagevalidation-ImageOptimization": { "type": "object", "properties": { "id": { "type": "string" }, "error_message": { "type": "string" }, "optimized_images": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-OptimizedImage" }, { "type": "null" } ] } } }, "required": [ "id" ] }, "github.com-mailgun-inspect-internal-imagevalidation-FrameDetails": { "type": "object", "properties": { "frame_id": { "type": "integer", "format": "int32" }, "frame_url": { "type": "string" } }, "required": [ "frame_id", "frame_url" ] }, "github.com-mailgun-inspect-internal-imagevalidation-GifFrameDetails": { "type": "object", "properties": { "id": { "type": "string" }, "original_image_id": { "type": "string" }, "frame_details": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-FrameDetails" } } }, "required": [ "id", "original_image_id", "frame_details" ] }, "github.com-mailgun-inspect-internal-imagevalidation-ReorderedGiF": { "type": "object", "properties": { "id": { "type": "string" }, "original_image_id": { "type": "string" }, "frame_id": { "type": "integer", "format": "int32" }, "url": { "type": "string" } }, "required": [ "id", "original_image_id", "frame_id", "url" ] }, "github.com-mailgun-inspect-internal-imagevalidation-GifProcessingJob": { "type": "object", "properties": { "id": { "type": "string" }, "gif_frames": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-GifFrameDetails" }, { "type": "null" } ] } }, "reordered_gif": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-ReorderedGiF" }, { "type": "null" } ] } }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "created_at" ] }, "github.com-mailgun-inspect-internal-imagevalidation-ImageValidation": { "type": "object", "properties": { "id": { "type": "string" }, "total_load_time_ms": { "type": [ "integer", "null" ], "format": "int64" }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-ImageValidationResult" } }, "image_optimization": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-ImageOptimization" }, { "type": "null" } ] }, "gif_processing_job": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-GifProcessingJob" }, { "type": "null" } ] } }, "required": [ "id" ] }, "github.com-mailgun-inspect-internal-imagevalidation-GetImageValidationTestJSONAPIResponse": { "type": "object", "properties": { "meta": { "type": [ "object", "null" ], "additionalProperties": { "type": "object" } }, "items": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-ImageValidation" }, { "type": "null" } ] } } }, "github.com-mailgun-inspect-internal-imagevalidation-GetImageValidationTestsJSONAPIResponse": { "type": "object", "properties": { "meta": { "type": [ "object", "null" ], "additionalProperties": { "type": "object" } }, "paging": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-paging-PagingResponse" }, { "type": "null" } ] }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-ImageValidation" } } } }, "github.com-mailgun-inspect-internal-imagevalidation-SelfLink": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "github.com-mailgun-inspect-internal-imagevalidation-CreateResource": { "type": "object", "properties": { "id": { "type": "string" }, "links": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-SelfLink" }, { "type": "null" } ] } }, "required": [ "id" ] }, "github.com-mailgun-inspect-internal-imagevalidation-CreateImageValidationJSONAPIResponse": { "type": "object", "properties": { "meta": { "type": [ "object", "null" ], "additionalProperties": { "type": "object" } }, "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-CreateResource" } } }, "github.com-mailgun-inspect-internal-imagevalidation-ImageValidationLinkRequest": { "type": "object", "properties": { "links": { "type": "array", "items": { "type": "string" } } } }, "github.com-mailgun-inspect-internal-imagevalidation-GetImageUploadValidationResults": { "type": "object", "properties": { "meta": { "type": [ "object", "null" ], "additionalProperties": { "type": "object" } }, "items": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-ImageValidation" }, { "type": "null" } ] } } }, "github.com-mailgun-inspect-internal-imagevalidation-ImageValidationUploadRequest": { "type": "object", "properties": { "image": { "type": "string", "format": "binary" } } }, "github.com-mailgun-inspect-internal-imagevalidation-OptimizeImagesByTestJSONAPIResponse": { "type": "object", "properties": { "meta": { "type": [ "object", "null" ], "additionalProperties": { "type": "object" } }, "paging": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-paging-PagingResponse" }, { "type": "null" } ] }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-ImageOptimization" } } } }, "github.com-mailgun-inspect-internal-imagevalidation-OptimizeImageByTestJSONAPIResponse": { "type": "object", "properties": { "meta": { "type": [ "object", "null" ], "additionalProperties": { "type": "object" } }, "paging": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-paging-PagingResponse" }, { "type": "null" } ] }, "items": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-imagevalidation-ImageOptimization" }, { "type": "null" } ] } } }, "github.com-mailgun-inspect-internal-accessibility-SelfLink": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "github.com-mailgun-inspect-internal-accessibility-CreateAccessibilityResource": { "type": "object", "properties": { "id": { "type": "string" }, "links": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-accessibility-SelfLink" }, { "type": "null" } ] } }, "required": [ "id" ] }, "github.com-mailgun-inspect-internal-accessibility-CreateAccessibilityJSONAPIResponse": { "type": "object", "properties": { "meta": { "type": [ "object", "null" ], "additionalProperties": { "type": "object" } }, "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-accessibility-CreateAccessibilityResource" } } }, "github.com-mailgun-inspect-internal-accessibility-ErrorDetail": { "type": "object", "properties": { "status": { "type": "string" }, "title": { "type": "string" }, "detail": { "type": "array", "items": { "type": "string" } } }, "required": [ "status", "title", "detail" ] }, "github.com-mailgun-inspect-internal-accessibility-ErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-accessibility-ErrorDetail" } } }, "required": [ "errors" ] }, "github.com-mailgun-inspect-internal-accessibility-AccessibilityRequest": { "type": "object", "properties": { "html": { "type": "string" }, "encoded": { "type": "boolean" } }, "required": [ "html", "encoded" ] }, "POST-v1-inspect-accessibility-application-json-RequestBody": { "type": "object", "properties": { "html": { "type": "string", "description": "The HTML content to be tested. Can be a raw HTML string or base64 encoded." }, "encoded": { "type": "boolean", "description": "Indicates whether the html content is base64 encoded (true) or raw (false)." } }, "required": [ "html" ] }, "github.com-mailgun-inspect-internal-accessibility-AccessibilityNodeResponse": { "type": "object", "properties": { "correctAny": { "type": "array", "items": { "type": "string" } }, "correctAll": { "type": "array", "items": { "type": "string" } }, "snippet": { "type": "string" }, "target": { "type": "array", "items": { "type": "string" } }, "lineNumber": { "type": "integer", "format": "int32" }, "absoluteIndex": { "type": "integer", "format": "int32" } }, "required": [ "correctAny", "correctAll", "snippet", "target", "lineNumber", "absoluteIndex" ] }, "github.com-mailgun-inspect-internal-accessibility-AccessibilityCheckResponse": { "type": "object", "properties": { "rule": { "type": "string" }, "impact": { "type": "string" }, "description": { "type": "string" }, "standards": { "type": "array", "items": { "type": "string" } }, "pour": { "type": "array", "items": { "type": "string" } }, "compliance": { "type": "array", "items": { "type": "string" } }, "instances": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-accessibility-AccessibilityNodeResponse" } } }, "required": [ "rule", "description", "standards", "pour", "compliance" ] }, "github.com-mailgun-inspect-internal-accessibility-AccessibilityResponse": { "type": "object", "properties": { "checks": { "type": "integer", "format": "int32" }, "passes": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-accessibility-AccessibilityCheckResponse" } }, "failures": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-accessibility-AccessibilityCheckResponse" } }, "needs_review": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-accessibility-AccessibilityCheckResponse" } } }, "required": [ "checks", "passes", "failures", "needs_review" ] }, "github.com-mailgun-inspect-internal-accessibility-GetAccessibilityTestJSONAPIResponse": { "type": "object", "properties": { "meta": { "type": [ "object", "null" ], "additionalProperties": { "type": "object" } }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-accessibility-AccessibilityResponse" } } } }, "github.com-mailgun-inspect-internal-accessibility-GetAccessibilityTestsResource": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "checks": { "type": "integer", "format": "int32" }, "passes": { "type": "integer", "format": "int32" }, "failures": { "type": "integer", "format": "int32" }, "needs_review": { "type": "integer", "format": "int32" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "status", "checks", "passes", "failures", "needs_review", "created_at", "updated_at" ] }, "github.com-mailgun-inspect-internal-accessibility-GetAccessibilityTestsJSONAPIResponse": { "type": "object", "properties": { "meta": { "type": [ "object", "null" ], "additionalProperties": { "type": "object" } }, "paging": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-paging-PagingResponse" }, { "type": "null" } ] }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-accessibility-GetAccessibilityTestsResource" } } } }, "github.com-mailgun-inspect-internal-codeanalysis-Variant": { "type": "object", "properties": { "client": { "type": "string", "description": "The email client code (such as gmail or outlook or apple)" }, "platform": { "type": "string", "description": "The platform code (such as webmail or windows or macos)" }, "version": { "type": "string", "description": "The version identifier for this client/platform combination" } }, "required": [ "client", "platform", "version" ] }, "github.com-mailgun-inspect-internal-codeanalysis-Lookups": { "type": "object", "properties": { "clients": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Maps client codes to human-readable client names" }, "platforms": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Maps platform codes to human-readable platform names" }, "application_type": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Maps platform codes to their application type (web" }, "support_levels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Maps support level codes to human-readable descriptions" }, "categories": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Maps category codes to human-readable category names" }, "variants": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-codeanalysis-Variant" }, "description": "Maps variant IDs to their client/platform/version details" } }, "required": [ "clients", "platforms", "application_type", "support_levels", "categories", "variants" ] }, "github.com-mailgun-inspect-internal-codeanalysis-Dictionary": { "type": "object", "properties": { "lookups": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-codeanalysis-Lookups" } ], "description": "Collection of lookup tables" } }, "required": [ "lookups" ] }, "github.com-mailgun-inspect-internal-codeanalysis-Links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL to access this resource" } }, "required": [ "self" ] }, "github.com-mailgun-inspect-internal-codeanalysis-CodeAnalysisListItem": { "type": "object", "properties": { "test_id": { "type": "string", "description": "Unique identifier for the code analysis test" }, "status": { "type": "string", "description": "Current processing status of the test" }, "version": { "type": "integer", "format": "int32", "description": "Latest version number of this test" }, "created_at": { "type": "string", "format": "date-time", "description": "Timestamp when the test was created" }, "links": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-codeanalysis-Links" } ], "description": "Hypermedia links for accessing test resources" } }, "required": [ "test_id", "status", "version", "created_at", "links" ] }, "github.com-mailgun-inspect-internal-codeanalysis-CodeAnalysisListResponse": { "type": "object", "properties": { "meta": { "type": [ "object", "null" ], "additionalProperties": { "type": "object" }, "description": "Metadata including pagination links and result counts" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-codeanalysis-CodeAnalysisListItem" }, "description": "List of code analysis tests" } }, "required": [ "items" ] }, "github.com-mailgun-inspect-internal-codeanalysis-TestCreationItem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the created test" }, "links": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-codeanalysis-Links" } ], "description": "Hypermedia links for accessing test resources" } }, "required": [ "id", "links" ] }, "github.com-mailgun-inspect-internal-codeanalysis-TestCreationResponse": { "type": "object", "properties": { "meta": { "type": [ "object", "null" ], "additionalProperties": { "type": "object" }, "description": "Metadata about the test creation including status and version" }, "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-codeanalysis-TestCreationItem" } ], "description": "Details of the created test including ID and links" } }, "required": [ "items" ] }, "github.com-mailgun-inspect-internal-codeanalysis-Instance": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this instance of the feature in the HTML" }, "line": { "type": "integer", "format": "int32", "description": "Line number where the feature was found in the HTML source" }, "column": { "type": "integer", "format": "int32", "description": "Column number where the feature was found in the HTML source" }, "resolved": { "type": [ "boolean", "null" ], "description": "Whether this specific instance has been resolved" } }, "required": [ "id", "line", "column" ] }, "github.com-mailgun-inspect-internal-codeanalysis-VariantReference": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the email client variant (references dictionary variants)" }, "notes": { "type": "array", "items": { "type": "string" }, "description": "Additional implementation notes or caveats for this client" } }, "required": [ "id" ] }, "github.com-mailgun-inspect-internal-codeanalysis-Support": { "type": "object", "properties": { "y": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-codeanalysis-VariantReference" }, "description": "Email clients that fully support this feature" }, "a": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-codeanalysis-VariantReference" }, "description": "Email clients that partially support this feature" }, "n": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-codeanalysis-VariantReference" }, "description": "Email clients that do not support this feature" }, "u": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-codeanalysis-VariantReference" }, "description": "Email clients with unknown support for this feature" } } }, "github.com-mailgun-inspect-internal-codeanalysis-MatchedResult": { "type": "object", "properties": { "slug": { "type": "string", "description": "URL-friendly identifier for this feature" }, "name": { "type": "string", "description": "Name of the email feature" }, "description": { "type": [ "string", "null" ], "description": "Detailed information about what this email feature does" }, "category": { "type": "string", "description": "Machine-readable category code that groups related features" }, "notes_lookup": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Maps note reference IDs to their corresponding implementation notes" }, "instances": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-codeanalysis-Instance" } }, "support": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-codeanalysis-Support" } }, "required": [ "instances", "support" ] }, "github.com-mailgun-inspect-internal-codeanalysis-TestResultItem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the test" }, "version": { "type": "integer", "format": "int32", "description": "Version number of this test result" }, "features": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-codeanalysis-MatchedResult" }, "description": "List of email features detected in the analyzed HTML" } }, "required": [ "id", "version", "features" ] }, "github.com-mailgun-inspect-internal-codeanalysis-TestResultResponse": { "type": "object", "properties": { "meta": { "type": [ "object", "null" ], "additionalProperties": { "type": "object" }, "description": "Metadata including status and counts and support statistics" }, "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-codeanalysis-TestResultItem" } ], "description": "Test results including detected features and their support data" } }, "required": [ "items" ] }, "github.com-mailgun-inspect-internal-codeanalysis-VersionInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the test" }, "version": { "type": "integer", "format": "int32", "description": "Version number of the test result" }, "links": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-codeanalysis-Links" } ], "description": "Hypermedia links for accessing version-specific resources" } }, "required": [ "id", "version", "links" ] }, "github.com-mailgun-inspect-internal-codeanalysis-VersionListItem": { "type": "object", "properties": { "versions": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-codeanalysis-VersionInfo" } } }, "required": [ "versions" ] }, "github.com-mailgun-inspect-internal-codeanalysis-VersionListResponse": { "type": "object", "properties": { "meta": { "type": [ "object", "null" ], "additionalProperties": { "type": "object" }, "description": "Metadata about the version list including count" }, "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-codeanalysis-VersionListItem" } ], "description": "List of available versions for the test" } }, "required": [ "items" ] }, "github.com-mailgun-inspect-internal-codeanalysis-ResolveRequest": { "type": "object", "properties": { "resolved": { "type": "boolean", "description": "Boolean flag indicating whether the issue has been resolved" } }, "required": [ "resolved" ] }, "github.com-mailgun-scaffold-httpapi-NotFoundError": { "type": "object", "properties": { "Description": { "type": "string" } }, "required": [ "Description" ] }, "github.com-mailgun-inspect-internal-spam-ResponseMeta": { "type": "object", "properties": { "request_id": { "type": "string" }, "timestamp": { "type": "string" }, "count": { "type": [ "integer", "null" ], "format": "int32" } }, "required": [ "request_id", "timestamp" ] }, "github.com-mailgun-inspect-internal-spam-ESPResult": { "type": "object", "properties": { "esp": { "type": "string" }, "display_name": { "type": "string" }, "status": { "type": "string" }, "placement": { "type": "string" }, "folder": { "type": "string" } }, "required": [ "esp", "display_name", "status", "placement" ] }, "github.com-mailgun-inspect-internal-spam-ESPCategoryResults": { "type": "object", "properties": { "passed": { "type": "integer", "format": "int32" }, "failed": { "type": "integer", "format": "int32" }, "pending": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-spam-ESPResult" } } }, "required": [ "passed", "failed", "pending", "results" ] }, "github.com-mailgun-inspect-internal-spam-SpamTestResults": { "type": "object", "properties": { "b2c": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-spam-ESPCategoryResults" }, "b2b": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-spam-ESPCategoryResults" } }, "required": [ "b2c", "b2b" ] }, "github.com-mailgun-inspect-internal-spam-SpamTestResource": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "subject": { "type": "string" }, "sending_ip": { "type": [ "string", "null" ] }, "region": { "type": "string" }, "results": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-spam-SpamTestResults" }, { "type": "null" } ] }, "failure_reason": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "status", "subject", "region", "created_at", "updated_at" ] }, "github.com-mailgun-inspect-internal-spam-ResponseLinks": { "type": "object", "properties": { "self": { "type": "string" } }, "required": [ "self" ] }, "github.com-mailgun-inspect-internal-spam-SpamTestItemResponse": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-spam-ResponseMeta" }, "item": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-spam-SpamTestResource" }, "links": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-spam-ResponseLinks" } }, "required": [ "meta", "item", "links" ] }, "github.com-mailgun-inspect-internal-spam-CreateSpamTestV1Request": { "type": "object", "properties": { "subject": { "type": "string" }, "html": { "type": "string" }, "from_name": { "type": [ "string", "null" ] }, "sending_ip": { "type": [ "string", "null" ] }, "region": { "type": [ "string", "null" ] } }, "required": [ "subject", "html" ] }, "github.com-mailgun-inspect-internal-spam-SpamTestListResponse": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-spam-ResponseMeta" }, "paging": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-paging-PagingResponse" }, { "type": "null" } ] }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-spam-SpamTestResource" } }, "links": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-spam-ResponseLinks" } }, "required": [ "meta", "items", "links" ] }, "github.com-mailgun-inspect-internal-spam-ProviderInfo": { "type": "object", "properties": { "domain": { "type": "string" }, "display_name": { "type": "string" }, "category": { "type": "string" } }, "required": [ "domain", "display_name", "category" ] }, "github.com-mailgun-inspect-internal-spam-ProviderListResponse": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-spam-ResponseMeta" }, "paging": { "anyOf": [ { "$ref": "#/components/schemas/github.com-mailgun-scaffold-httpapi-paging-PagingResponse" }, { "type": "null" } ] }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-spam-ProviderInfo" } }, "links": { "$ref": "#/components/schemas/github.com-mailgun-inspect-internal-spam-ResponseLinks" } }, "required": [ "meta", "items", "links" ] } }, "securitySchemes": { "basicAuth": { "type": "http", "description": "HTTP Basic auth using api:YOUR_API_KEY. See [documentation](https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/)", "scheme": "basic" } } }, "x-tagGroups": [ { "name": "Mailgun Inspect", "tags": [ "Link Validation", "Image Validation", "Accessibility", "Code Analysis", "Email Preview" ] } ] }