Accessibility

The Accessibility API evaluates HTML emails against WCAG standards, providing a clear pass/fail assessment to ensure compliance with accessibility guidelines.

Get Accessibility Tests

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'.

SecuritybasicAuth

Request

query Parameters

limit	integer Max count of items. Max: 1000. Default: 100
skip	integer Get the list of items starting at the nth element (paging). Default: 0

Responses

200

A 200 response

Response Schema: application/json

	object
	object
	Array of objects

401

A 401 response

get/v1/inspect/accessibility

Request samples

Response samples

application/json

{"meta": {"count": 9
},
"paging": {"first": "https://api.mailgun.net/v1/inspect/accessibility/tests?limit=100&skip=0",
"last": "https://api.mailgun.net/v1/inspect/accessibility/tests?limit=100&skip=0"
},
"items": [{"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"
}
]
}

Create Accessibility Test

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'.

SecuritybasicAuth

Request

Request Body schema: application/json
required

html required	string The HTML content to be tested. Can be a raw HTML string or base64 encoded.
encoded	boolean Indicates whether the html content is base64 encoded (true) or raw (false).

Responses

201

A 201 response

Response Schema: application/json

	object
	object

400

A 400 response

401

A 401 response

post/v1/inspect/accessibility

Request samples

application/json

{"html": "string"
}

Response samples

application/json

{"meta": {"created_at": "2025-05-28T05:30:00Z",
"status": "Processing"
},
"items": {"id": "677ea3cdf1051e25e7dbfe73",
"links": {"self": "https://api.mailgun.net/v1/inspect/accessibility/tests/677ea3cdf1051e25e7dbfe73"
}
}
}

Get Accessibility Test

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.

SecuritybasicAuth

Request

path Parameters

required

string

The unique identifier of the test.

Responses

200

A 200 response

Response Schema: application/json

	object
	Array of objects

401

A 401 response

404

A 404 response

get/v1/inspect/accessibility/{id}

Request samples

Response samples

application/json

{"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"
],
"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": "<a href=\"https://itr.links.codecademy.com/u/click?_t=13e4e7efd5b34d1d982e9fb34505f006&amp;_m=d49e0a49293847cb90a38fc966d6c628&amp;_e=8PR4PaAxdle-t4DWaNnHv_XcHKdsGWmibEMhJn2Ru0Vc4ot3FmxMJVzPN-4kC1AuC07RcQKADk0Qp_vkt-5spaVWYFvk2IkLL-eGhtmZ3v-H44j1FGVVebSQWu3DyovyMw-NBaHm8Df6sIqWaN4rOpr1uYN69MVJ2QiBEnBh2Kh4Mtc8LTa1Dq-lCP1hoK7DOcl1vGOiUyA2oo1ef43gKBoPOVrJ0loTHhQ2bvTy523hW8Z8J829NtKdgcIAdGQANUmH1OqXXVwZU3eQMfKDXJzHzOz_bCjH91SkuKYhmG_5UM8lsbHtvlEQSdv7Kkt1rsecakquNMtCQq5E9ioRx8Ku9gaYn5ZgI-v5-OvKB53rLv_LDnVowGIQopw4nxcd\" target=\"_blank\" style=\"outline: none; display: block; text-decoration: underline !important;\">",
"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": "<a href=\"https://itr.links.codecademy.com/u/click?_t=13e4e7efd5b34d1d982e9fb34505f006&amp;_m=d49e0a49293847cb90a38fc966d6c628&amp;_e=8PR4PaAxdle-t4DWaNnHv3_8_ILBeCvdyVFeRs3iXHpUr2MZ6Y0LBDzW2jsxCcVea_4e-IiWzWLZQ6G3c0nhvDpLDeVSrJzlcZ1IzZgRU31vwRAWT6064qAF-H4uIIPNP5IX2uIW3u4E0A3q1apBN_cjwrWKBaq3LX_Yph0XZYLhTkE42C2_SLJAL_Q8ofTWXCvuL9RD60qSb_7fpYbrzkmtGKwv5WXoXWBKPBKE6BJx6K2oYelNkcUBA9axDa1viaUQE93Ufw2WdY1P85vKDGc57WyZKg_fdz3dJy_dhXeV0qqrygY2LHoNzOXtsVe73Kwwgj3T0N7oWFLAawzkn9WTFefnSyEHhg7zK76A4MgeitybIeTgQBlXWOGprWUtjeAMLBpp-z9geXzciRyuGEYFqVb2NNa4YyGMP_tErsmernTIYbWMEWSB9VRN6k7b\" target=\"_blank\" style=\"outline: none; display: block; text-decoration: underline !important;\">",
"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": "<a href=\"https://itr.links.codecademy.com/u/click?_t=13e4e7efd5b34d1d982e9fb34505f006&amp;_m=d49e0a49293847cb90a38fc966d6c628&amp;_e=8PR4PaAxdle-t4DWaNnHv3_8_ILBeCvdyVFeRs3iXHpUr2MZ6Y0LBDzW2jsxCcVedwTM0j_e6NW3GDsBJNs0Sm2787dseb6OfhUK7VLbq8B2OQbn3gvPHXBBRKRaZAaZkNsBXRwCPYdvHSEzo_utuvFvO7FwFIGZ6M3rvZZe2HEd3d0Zl5QfCWL4nhBvg0FnGbWOeZhjDr2A-SWJJCUxvBKixrXGZoOf5nyr1AMnlRchMLmMWR-DPfvUjnfjSc8RvYzupE3ykTwQqTGtu0j6d_fR-Bvm-gETlGRhkI-MK8gV7Rxn5W2v4bgxAOz-ufh6lVdOYXWMWB9qiQ6rw24uUE2X1JRGiZUTGP6QV-mrluOz7740iUVGBJHR8xn8dWj-PXgYtTjG130i_77eRYO20RvbzrNFQNJXZLOG5fn64og3LsGPv81QcN06goMwgMcV0yRaf8ux4kxUpgSf5an3xg%3D%3D\" target=\"_blank\" style=\"outline: none; display: block; text-decoration: underline !important;\">",
"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": "<a href=\"https://itr.links.codecademy.com/u/click?_t=13e4e7efd5b34d1d982e9fb34505f006&amp;_m=d49e0a49293847cb90a38fc966d6c628&amp;_e=8PR4PaAxdle-t4DWaNnHv3_8_ILBeCvdyVFeRs3iXHpUr2MZ6Y0LBDzW2jsxCcVen7WisoSvKscLPyuQlBALkIZn1aFnMMYsYqlpq7kZFGVOnEFc0VzrwU_dAYPgW3e5GSXv3iZKoO5JW8PWDYeMhMuuXF2Gk0K02KFqsmg18hYzGf9TgJ1xSneoUcOL4QrO0uMW4HSAbNVpGhAXZUAJZcK0SsXZdLEzK-jGmHaEBgE4Zc2ZvELcsFDT2W3U4Fx8tvz_pXBn73zs_f1jKjUmG_TxCfDw4MIawyludAHlUJ_OGUuBrTgo633-FW7OxM9hVObn3l5X9DYTGFYJrzi8afzNNcBslkuQrTvFEj5EgwRNV6EZdsoXACh2RL4hVlCmh8MNXTzuCJl4LmML1YdeV9lGXSrKeOeU3vthtkZ23n2_bKa2A5YumcndSQneRXPe\" target=\"_blank\" style=\"outline: none; display: block; text-decoration: underline !important;\">",
"target": ["a:nth-child(4)"
],
"lineNumber": 75,
"absoluteIndex": 28
}
],
"pour": ["Robust"
],
"compliance": ["Best Practice"
]
},
{"rule": "Document Title",
"impact": "serious",
"description": "Ensures each HTML document contains a non-empty <title> element",
"standards": ["WCAG 2A"
],
"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
}
],
"pour": ["Operable"
],
"compliance": ["WCAG: 2.4.2 Page Titled"
]
}
],
"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"
],
"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
}
],
"pour": ["Perceivable"
],
"compliance": ["WCAG: 1.4.3 Contrast (Minimum)"
]
}
]
}
]
}

Delete Accessibility Test

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.

SecuritybasicAuth

Request

path Parameters

required

string

The unique identifier of the test.

Responses

200

A 200 response

Response Schema: application/json

message

required

string

401

A 401 response

404

A 404 response

delete/v1/inspect/accessibility/{id}

Request samples

Response samples

application/json

{"message": "Accessibility test with test id <id> has been successfully deleted."
}

Cookie Policy GDPR Email Compliance Acceptable Use Policy Terms of Service Privacy Policy

Accessibility

Get Accessibility Tests

query Parameters

Response Schema: application/json

Create Accessibility Test

Request Body schema: application/jsonrequired

Response Schema: application/json

Get Accessibility Test

path Parameters

Response Schema: application/json

Delete Accessibility Test

path Parameters

Response Schema: application/json

Request Body schema: application/json
required