From 3792be3150ded603a05baa8530cd650cf62b1861 Mon Sep 17 00:00:00 2001 From: IzikAJ Date: Thu, 29 Oct 2026 13:26:41 +0200 Subject: [PATCH 1/4] Rename Email API/SMTP to Email Live Sending in descriptions The product "Email API/SMTP" is now "Email Live Sending (API/SMTP)". Use the new name in the billing usage and inbound descriptions, and in the naming guide. Mentions of API and SMTP as send methods stay. Co-Authored-By: Claude Opus 5.5 --- CLAUDE.md | 2 +- specs/account-management.openapi.yml | 4 ++-- specs/inbound.openapi.yml | 8 ++++---- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 4c4c56a..c8140bf 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -264,7 +264,7 @@ tags: ## Product Names Follow official product naming: -- **Email API/SMTP** (can shorten to "Email API" or "API/SMTP") +- **Email Live Sending (API/SMTP)** (can shorten to "Live Sending") - **Email Sandbox** (can shorten to "Sandbox") - **Email Marketing** (can shorten to "Marketing") diff --git a/specs/account-management.openapi.yml b/specs/account-management.openapi.yml index ebf8299..d7f1d45 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 (API/SMTP), 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 (API/SMTP), and Email Marketing if available. content: application/json: schema: diff --git a/specs/inbound.openapi.yml b/specs/inbound.openapi.yml index 8d87139..c96c4e3 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. + Missing bodies or recipients are rejected by the Email API with `400`. properties: from: allOf: @@ -4364,8 +4364,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 (API/SMTP) is not + enabled for the organization (empty response body). content: application/json: schema: From fdf17a900072792c053cb5f2aeb50f6a27c67262 Mon Sep 17 00:00:00 2001 From: IzikAJ Date: Thu, 29 Oct 2026 13:30:06 +0200 Subject: [PATCH 2/4] Drop the (API/SMTP) suffix from Email Live Sending The product name is "Email Live Sending". The suffix only repeats the send methods, so remove it from the descriptions and the naming guide. Co-Authored-By: Claude Opus 5.5 --- CLAUDE.md | 2 +- specs/account-management.openapi.yml | 4 ++-- specs/inbound.openapi.yml | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index c8140bf..1f8d846 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -264,7 +264,7 @@ tags: ## Product Names Follow official product naming: -- **Email Live Sending (API/SMTP)** (can shorten to "Live Sending") +- **Email Live Sending** (can shorten to "Live Sending") - **Email Sandbox** (can shorten to "Sandbox") - **Email Marketing** (can shorten to "Marketing") diff --git a/specs/account-management.openapi.yml b/specs/account-management.openapi.yml index d7f1d45..3e456d3 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 Live Sending (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 Email Sandbox, Email Live Sending (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/inbound.openapi.yml b/specs/inbound.openapi.yml index c96c4e3..c9e9c2e 100644 --- a/specs/inbound.openapi.yml +++ b/specs/inbound.openapi.yml @@ -4364,8 +4364,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 Live Sending (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: From 7c67a3e4beb2a3a3a3084b50575f28d9a0605d8e Mon Sep 17 00:00:00 2001 From: IzikAJ Date: Fri, 30 Oct 2026 10:04:52 +0200 Subject: [PATCH 3/4] Rename the remaining Email API and Email Sending product mentions "Email API" in the inbound spec and "Email Sending" in the spec title and README name the product, so they become "Email Live Sending". The naming guide now lists the old names and keeps "API" and "SMTP" as send methods. Co-Authored-By: Claude Opus 5.5 --- CLAUDE.md | 7 +++++++ README.md | 24 ++++++++++++------------ specs/email-sending.openapi.yml | 2 +- specs/inbound.openapi.yml | 23 ++++++++++++----------- 4 files changed, 32 insertions(+), 24 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 1f8d846..c3be8c0 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -268,6 +268,13 @@ Follow official product naming: - **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..986268c 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` | +| Email Live Sending | `specs/email-sending.openapi.yml` | `https://mailtrap.io` | +| Email Live Sending (Bulk) | `specs/email-sending-bulk.openapi.yml` | `https://bulk.api.mailtrap.io` | +| Email 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/email-sending.openapi.yml b/specs/email-sending.openapi.yml index 500a2ce..0221662 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 c9e9c2e..dd886a8 100644 --- a/specs/inbound.openapi.yml +++ b/specs/inbound.openapi.yml @@ -3675,7 +3675,7 @@ components: 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 Live Sending API `{ email, name }` shape. - Missing bodies or recipients are rejected by the Email API with `400`. + 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" @@ -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 63657c58651f3b9a194c00feba652550448b7199 Mon Sep 17 00:00:00 2001 From: IzikAJ Date: Fri, 30 Oct 2026 11:08:51 +0200 Subject: [PATCH 4/4] Use the short Live Sending name in the README spec table The table uses the short form "Sandbox", so use "Live Sending" to keep one name set. Co-Authored-By: Claude Opus 5.5 --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 986268c..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 Live Sending | `specs/email-sending.openapi.yml` | `https://mailtrap.io` | -| Email Live Sending (Bulk) | `specs/email-sending-bulk.openapi.yml` | `https://bulk.api.mailtrap.io` | -| Email 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` | +| 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