diff --git a/CLAUDE.md b/CLAUDE.md index c3be8c0..4c4c56a 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -264,17 +264,10 @@ tags: ## Product Names Follow official product naming: -- **Email Live Sending** (can shorten to "Live Sending") +- **Email API/SMTP** (can shorten to "Email API" or "API/SMTP") - **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 86a6de8..e57046e 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` | -| 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` | +| 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` | ## Usage diff --git a/specs/account-management.openapi.yml b/specs/account-management.openapi.yml index e0083b7..51d2e71 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, and Email Marketing. + description: Get current billing cycle usage for Email Sandbox, Email Sending (Email 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 Email Sandbox, Email Live Sending, and Email Marketing if available. + description: Returns an object with current billing cycle usage for Sandbox, Email Sending (Email API/SMTP), and Email Marketing if available. content: application/json: schema: diff --git a/specs/email-sending.openapi.yml b/specs/email-sending.openapi.yml index 599895f..a22bd01 100644 --- a/specs/email-sending.openapi.yml +++ b/specs/email-sending.openapi.yml @@ -1,6 +1,6 @@ openapi: 3.1.0 info: - title: Email Live Sending + title: Email 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 dd886a8..8d87139 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 Live Sending API `{ email, name }` shape. - Email Live Sending rejects missing bodies or recipients with `400`. + Addresses use the Email Sending API `{ email, name }` shape. Missing + bodies or recipients are rejected by the Email API with `400`. properties: from: allOf: @@ -3712,7 +3712,7 @@ components: category: type: string maxLength: 255 - description: Email Live Sending category for the sent message. + description: Email API category for the sent message. example: "Support reply" attachments: type: array @@ -3732,7 +3732,7 @@ components: type: object additionalProperties: type: string - description: Email Live Sending custom variables for the sent message. + description: Email API custom variables for the sent message. example: ticket_id: "12345" @@ -3744,7 +3744,7 @@ components: message_ids: type: array description: | - UUIDs assigned by Email Live Sending to the sent message, one per + UUIDs assigned by the Email API 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 Live Sending message UUID. + the Email API message UUID. example: "1700000000000123" message_group_id: type: @@ -4054,8 +4054,7 @@ components: - "null" description: | Why the forward was rejected, e.g. `loop_prevention` or - `fetch_failed`, or the rejection reason returned by Email Live - Sending. + `fetch_failed`, or the rejection reason returned by the Email API. `null` when `status` is `forwarded`. example: null message_id: @@ -4063,7 +4062,7 @@ components: - string - "null" description: | - Email Live Sending UUID of the forwarded (sent) message. `null` when + Email API UUID of the forwarded (sent) message. `null` when `status` is `rejected`. example: "f47ac10b-58cc-4372-a567-0e02b2c3d479" @@ -4365,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 is not enabled for - the organization (empty response body). + (`Account access forbidden`), or Email API/SMTP is not enabled for the + organization (empty response body). content: application/json: schema: @@ -4449,8 +4448,8 @@ components: SendMessageAccepted: description: | - Message queued for delivery. Returns the UUID(s) that Email Live - Sending assigned to the sent message, one per recipient. + Message queued for delivery. Returns the UUID(s) the Email API + assigned to the sent message, one per recipient. content: application/json: schema: @@ -4463,7 +4462,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 Email Live Sending. + domain) and for validation errors rejected by the Email API. content: application/json: schema: @@ -4476,7 +4475,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 Email Live Sending + Mailtrap-hosted sending limit has been reached, or the Email API rejected the message. content: application/json: