From d66eeaac60a416553fedd0f1cac4b347743941f9 Mon Sep 17 00:00:00 2001 From: IzikAJ Date: Mon, 9 Nov 2026 17:23:39 +0200 Subject: [PATCH 1/3] Apply the Email Live Sending rename again This reverts the rollback in #67 and restores the rename from the original PR (merge commit a769359). Co-Authored-By: Claude Opus 5.5 --- CLAUDE.md | 9 ++++++++- README.md | 24 +++++++++++------------ specs/account-management.openapi.yml | 4 ++-- specs/email-sending.openapi.yml | 2 +- specs/inbound.openapi.yml | 29 ++++++++++++++-------------- 5 files changed, 38 insertions(+), 30 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 4c4c56a..c3be8c0 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -264,10 +264,17 @@ tags: ## Product Names Follow official product naming: -- **Email API/SMTP** (can shorten to "Email API" or "API/SMTP") +- **Email Live Sending** (can shorten to "Live Sending") - **Email Sandbox** (can shorten to "Sandbox") - **Email Marketing** (can shorten to "Marketing") +Use one set in a sentence: "Email Live Sending, Email Sandbox, Email Marketing" or "Live Sending, +Sandbox, Marketing". Do not mix them. + +"Email API/SMTP", "API/SMTP", "Email API", "Email Sending" and "Sending" are old names of Email Live +Sending. Replace them where they name the product. Keep "API" and "SMTP" where they name a send +method or protocol, for example "send with the API or SMTP", "SMTP credentials" or "API token". + ## Validation Workflow When creating or editing OpenAPI specs: diff --git a/README.md b/README.md index e57046e..86a6de8 100644 --- a/README.md +++ b/README.md @@ -8,18 +8,18 @@ This repository contains the OpenAPI specification files for various Mailtrap se The specifications are located in the `specs/` directory: -| Spec | File | Base URL | -| ----------------------------- | ----------------------------------------------- | --------------------------------- | -| Account Management | `specs/account-management.openapi.yml` | `https://mailtrap.io` | -| Contacts | `specs/contacts.openapi.yml` | `https://mailtrap.io` | -| Email Campaigns | `specs/email-campaigns.openapi.yml` | `https://mailtrap.io` | -| Email Sending | `specs/email-sending.openapi.yml` | `https://mailtrap.io` | -| Email Sending (Bulk) | `specs/email-sending-bulk.openapi.yml` | `https://bulk.api.mailtrap.io` | -| Email Sending (Transactional) | `specs/email-sending-transactional.openapi.yml` | `https://send.api.mailtrap.io` | -| Sandbox (send & batch) | `specs/sandbox-sending.openapi.yml` | `https://sandbox.api.mailtrap.io` | -| Sandbox | `specs/sandbox.openapi.yml` | `https://mailtrap.io` | -| Templates | `specs/templates.openapi.yml` | `https://mailtrap.io` | -| Inbound | `specs/inbound.openapi.yml` | `https://mailtrap.io` | +| Spec | File | Base URL | +| ---------------------------- | ----------------------------------------------- | --------------------------------- | +| Account Management | `specs/account-management.openapi.yml` | `https://mailtrap.io` | +| Contacts | `specs/contacts.openapi.yml` | `https://mailtrap.io` | +| Email Campaigns | `specs/email-campaigns.openapi.yml` | `https://mailtrap.io` | +| Live Sending | `specs/email-sending.openapi.yml` | `https://mailtrap.io` | +| Live Sending (Bulk) | `specs/email-sending-bulk.openapi.yml` | `https://bulk.api.mailtrap.io` | +| Live Sending (Transactional) | `specs/email-sending-transactional.openapi.yml` | `https://send.api.mailtrap.io` | +| Sandbox (send & batch) | `specs/sandbox-sending.openapi.yml` | `https://sandbox.api.mailtrap.io` | +| Sandbox | `specs/sandbox.openapi.yml` | `https://mailtrap.io` | +| Templates | `specs/templates.openapi.yml` | `https://mailtrap.io` | +| Inbound | `specs/inbound.openapi.yml` | `https://mailtrap.io` | ## Usage diff --git a/specs/account-management.openapi.yml b/specs/account-management.openapi.yml index 51d2e71..e0083b7 100644 --- a/specs/account-management.openapi.yml +++ b/specs/account-management.openapi.yml @@ -1662,7 +1662,7 @@ paths: get: operationId: getAccountBillingUsage summary: Get current billing cycle usage - description: Get current billing cycle usage for Email Sandbox, Email Sending (Email API/SMTP), and Email Marketing. + description: Get current billing cycle usage for Email Sandbox, Email Live Sending, and Email Marketing. tags: - Billing x-codeSamples: @@ -1766,7 +1766,7 @@ paths: } responses: '200': - description: Returns an object with current billing cycle usage for Sandbox, Email Sending (Email API/SMTP), and Email Marketing if available. + description: Returns an object with current billing cycle usage for Email Sandbox, Email Live Sending, and Email Marketing if available. content: application/json: schema: diff --git a/specs/email-sending.openapi.yml b/specs/email-sending.openapi.yml index a22bd01..599895f 100644 --- a/specs/email-sending.openapi.yml +++ b/specs/email-sending.openapi.yml @@ -1,6 +1,6 @@ openapi: 3.1.0 info: - title: Email Sending + title: Email Live Sending version: 2.0.0 description: | Manage domains, suppressions, tracking opt-outs, and email sending logs for your Mailtrap account. diff --git a/specs/inbound.openapi.yml b/specs/inbound.openapi.yml index 8d87139..dd886a8 100644 --- a/specs/inbound.openapi.yml +++ b/specs/inbound.openapi.yml @@ -3674,8 +3674,8 @@ components: `reply_all` must carry a body (`text` and/or `html`); `forward` may omit it, since the original message is quoted automatically. `forward` has no default recipient, so supply at least one in `to`, `cc`, or `bcc`. - Addresses use the Email Sending API `{ email, name }` shape. Missing - bodies or recipients are rejected by the Email API with `400`. + Addresses use the Email Live Sending API `{ email, name }` shape. + Email Live Sending rejects missing bodies or recipients with `400`. properties: from: allOf: @@ -3712,7 +3712,7 @@ components: category: type: string maxLength: 255 - description: Email API category for the sent message. + description: Email Live Sending category for the sent message. example: "Support reply" attachments: type: array @@ -3732,7 +3732,7 @@ components: type: object additionalProperties: type: string - description: Email API custom variables for the sent message. + description: Email Live Sending custom variables for the sent message. example: ticket_id: "12345" @@ -3744,7 +3744,7 @@ components: message_ids: type: array description: | - UUIDs assigned by the Email API to the sent message, one per + UUIDs assigned by Email Live Sending to the sent message, one per recipient. These are the sent message's UUIDs — not the inbound message ID acted on, nor an RFC `Message-ID` header value. items: @@ -3882,7 +3882,7 @@ components: type: string description: | For inbound messages, the Mailtrap object ID. For sent messages, - the Email API message UUID. + the Email Live Sending message UUID. example: "1700000000000123" message_group_id: type: @@ -4054,7 +4054,8 @@ components: - "null" description: | Why the forward was rejected, e.g. `loop_prevention` or - `fetch_failed`, or the rejection reason returned by the Email API. + `fetch_failed`, or the rejection reason returned by Email Live + Sending. `null` when `status` is `forwarded`. example: null message_id: @@ -4062,7 +4063,7 @@ components: - string - "null" description: | - Email API UUID of the forwarded (sent) message. `null` when + Email Live Sending UUID of the forwarded (sent) message. `null` when `status` is `rejected`. example: "f47ac10b-58cc-4372-a567-0e02b2c3d479" @@ -4364,8 +4365,8 @@ components: description: | Forbidden. The token lacks the permission required for this operation (`Access forbidden`), has no access to the account - (`Account access forbidden`), or Email API/SMTP is not enabled for the - organization (empty response body). + (`Account access forbidden`), or Email Live Sending is not enabled for + the organization (empty response body). content: application/json: schema: @@ -4448,8 +4449,8 @@ components: SendMessageAccepted: description: | - Message queued for delivery. Returns the UUID(s) the Email API - assigned to the sent message, one per recipient. + Message queued for delivery. Returns the UUID(s) that Email Live + Sending assigned to the sent message, one per recipient. content: application/json: schema: @@ -4462,7 +4463,7 @@ components: description: | The message could not be sent. Returned for an invalid sender (for example a `from` on a Mailtrap-hosted inbox, or one outside the inbox's - domain) and for validation errors rejected by the Email API. + domain) and for validation errors rejected by Email Live Sending. content: application/json: schema: @@ -4475,7 +4476,7 @@ components: description: | The token lacks admin access (on the inbox for a Mailtrap-hosted inbox, or on the inbox's sending domain for a custom-domain inbox), the - Mailtrap-hosted sending limit has been reached, or the Email API + Mailtrap-hosted sending limit has been reached, or Email Live Sending rejected the message. content: application/json: From 1f74dc4dd1a1c7b93f05250421d3e8dc0e06df13 Mon Sep 17 00:00:00 2001 From: IzikAJ Date: Tue, 10 Nov 2026 11:39:51 +0200 Subject: [PATCH 2/3] Rename the remaining Email API/SMTP mentions The Stats tag in email-sending.openapi.yml and getMarketingStats in email-campaigns.openapi.yml named the product with the old name. Co-Authored-By: Claude Opus 5.5 --- specs/email-campaigns.openapi.yml | 2 +- specs/email-sending.openapi.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specs/email-campaigns.openapi.yml b/specs/email-campaigns.openapi.yml index 64b619e..33b4955 100644 --- a/specs/email-campaigns.openapi.yml +++ b/specs/email-campaigns.openapi.yml @@ -1859,7 +1859,7 @@ paths: Returns aggregated performance metrics for the account's Email Marketing traffic, campaigns and automations together: counts and rates for deliveries, bounces, opens, clicks, spam complaints, and unsubscriptions over a date range. The numbers match Email Marketing > Stats - Overview in the app for the same filters. Email API/SMTP traffic is not included; + Overview in the app for the same filters. Email Live Sending traffic is not included; `GET /api/stats` reports it. Open, click, spam, and unsubscription rates are shares of `delivery_count`, unlike diff --git a/specs/email-sending.openapi.yml b/specs/email-sending.openapi.yml index 599895f..bbbad2c 100644 --- a/specs/email-sending.openapi.yml +++ b/specs/email-sending.openapi.yml @@ -48,7 +48,7 @@ tags: x-page-title: Stats x-page-description: Email sending stats description: |- - Email API/SMTP aggregated stats, the same you see in your Stats dashboard. Campaign and + Email Live Sending aggregated stats, the same you see in your Stats dashboard. Campaign and automation traffic is not included; it is reported by `GET /api/marketing/stats`. - name: email-logs From ff1721e4fbc5626d3bf92f3c2c1aa4460f479e97 Mon Sep 17 00:00:00 2001 From: IzikAJ Date: Tue, 10 Nov 2026 13:24:48 +0200 Subject: [PATCH 3/3] Rename the Stats page description to Email Live Sending GitBook shows x-page-description as the page subtitle, directly above the renamed tag description. Co-Authored-By: Claude Opus 5.5 --- specs/email-sending.openapi.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specs/email-sending.openapi.yml b/specs/email-sending.openapi.yml index bbbad2c..50cc099 100644 --- a/specs/email-sending.openapi.yml +++ b/specs/email-sending.openapi.yml @@ -46,7 +46,7 @@ tags: - name: stats x-page-title: Stats - x-page-description: Email sending stats + x-page-description: Email Live Sending stats description: |- Email Live Sending aggregated stats, the same you see in your Stats dashboard. Campaign and automation traffic is not included; it is reported by `GET /api/marketing/stats`.