sinch-mailgun-optimize

Mailgun Optimize (InboxReady)

Overview

Mailgun Optimize (by Sinch), formerly InboxReady, is a deliverability suite: inbox placement testing via seed lists, IP and domain blocklist monitoring, spam trap tracking, email health scoring, DMARC reporting, Google Postmaster Tools integration, and Microsoft SNDS data.

Agent Instructions

Before generating code, gather from the user (skip any item already specified in the prompt or context):

1. Region — US or EU? Region determines the base URL.
2. Language — any language, or curl. This API is REST-only; there is no SDK wrapper.
3. Before generating code, check for existing .env files or environment variables for MAILGUN_API_KEY.

Product gotchas to apply unconditionally:

• Domain registration uses a query param, not a JSON body — POST /v1/inboxready/domains?domain=example.com.
• For inbox placement, create a test via POST /v4/inbox/tests with html or template_name. The response includes a result_id — poll GET /v4/inbox/results/{result_id} for results.
• Use /v2/spamtraps (current). The /v1/spamtraps endpoint is deprecated.

Refer to the API Reference or OpenAPI Spec linked in Links for request/response schemas.

Security: See the Security section below for url fetching policy and credential handling.

Source of Truth — what to load, and what is authoritative

This skill has two kinds of content with UNEQUAL reliability. Follow this precedence:

1. Canonical docs at documentation.mailgun.com (AUTHORITATIVE). The .md doc links in this skill are the single source of truth for exact request/response schemas, field names and nesting, enum values, signature/auth schemes, and limits. Before writing code that constructs a payload, verifies a signature, or parses a callback/response, fetch the specific linked doc and confirm the exact shape there. Fetching first-party documentation.mailgun.com URLs is permitted by the Security/URL policy. Never invent, guess, or pattern-extrapolate a documentation URL — only fetch doc URLs written verbatim in this skill or reached by following a link on a page you already fetched; a trusted domain does not make a guessed path real.
2. Bundled references/*.md (NAVIGATIONAL SUMMARIES — not authoritative). They orient you and point at the right canonical doc; they may lag, omit fields, or simplify nesting. Use them to decide what to build and which doc to open. Do NOT transcribe a field name, nesting, encoding, or enum from a reference or from the SKILL.md overview into shipped code without confirming it in the tier-1 doc. If a detail appears only in a summary, treat it as unverified and say so.