Skip to content

Rename Email API/SMTP to Email Live Sending in descriptions - #64

Merged
izikaj merged 5 commits into
mainfrom
rename-email-api-smtp-to-live-sending
Nov 9, 2026
Merged

izikaj merged 5 commits into
mainfrom
rename-email-api-smtp-to-live-sending

Conversation

@izikaj

@izikaj izikaj commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Motivation

The product "Email API/SMTP" is now "Email Live Sending", with "Live Sending" as the short form. "Email API", "Email Sending" and "Sending" are older names of the same product. The API reference still uses these names on the billing usage page, on 21 inbound pages, and in the spec title. This PR changes the product name only. Mentions of API and SMTP as send methods stay.

Merge this PR when the app shows the new name, not before. The spec goes live on docs.mailtrap.io as soon as it merges, so the 403 text on the inbound pages would name a product that the app does not show yet. Merge it together with mailtrap/mailtrap-docs#11.

Changes

  • account-management.openapi.yml, "Get current billing cycle usage": the endpoint description and the 200 response description say "Email Live Sending" instead of "Email Sending (Email API/SMTP)". The 200 description also says "Email Sandbox" instead of "Sandbox".
  • inbound.openapi.yml: the shared Forbidden response says "Email Live Sending is not enabled". All 21 inbound operations use this response.
  • inbound.openapi.yml: the 10 "Email API" mentions (sent message UUIDs, category, custom variables, rejections) say "Email Live Sending". The reply and forward request schema says "the Email Live Sending API { email, name } shape".
  • email-sending.openapi.yml: the spec title is "Email Live Sending", the same set as the "Email Sandbox" titles. README.md: the three spec rows say "Live Sending", the same set as the "Sandbox" rows. File names and URLs stay.
  • CLAUDE.md: the naming guide uses "Email Live Sending", short form "Live Sending". It lists the old names, says not to mix the two name sets, and keeps "API" and "SMTP" as names of send methods.

How to test

  • The "Get current billing cycle usage" page shows the new name in the description and in the 200 response
  • The 403 response on an inbound page says "Email Live Sending is not enabled for the organization"
  • The inbound reply, forward and message schemas say "Email Live Sending" where they said "Email API"
  • spectral lint "specs/*.openapi.yml" reports no errors

🤖 Generated with Claude Code

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 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Oct 29, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Important

  • Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 87a0102e-fa38-49d2-b5a0-efbc3ada8a94

No actionable comments were generated in the recent review.

Walkthrough

The product naming guidance and OpenAPI descriptions replace older Email API/SMTP wording with Email Live Sending terminology. The account-management descriptions continue to list Email Marketing and retain the “if available” condition.

Changes: Product naming updates

Layer / File(s) Summary
Update product terminology
CLAUDE.md, specs/account-management.openapi.yml, specs/inbound.openapi.yml
The naming guidance and API descriptions use Email Live Sending terminology. The account-management descriptions retain Email Marketing and the “if available” condition. The inbound descriptions retain the documented 400 error for missing bodies or recipients.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested reviewers: mklocek, edwardhura

Merge Risk: Minimal · previous review fdf17

The terminology-only changes appear mergeable with normal checks.

Pre-merge checks: Passed 4
Check name Status Explanation
Title check Passed The title clearly and concisely describes the main change: renaming Email API/SMTP to Email Live Sending in descriptions.
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Description check Passed The description includes complete Motivation, Changes, and How to test sections. It clearly explains the product rename, affected files, merge dependency, and validation steps. The Images and GIFs sec…
Full details: Description check

Explanation

The description includes complete Motivation, Changes, and How to test sections. It clearly explains the product rename, affected files, merge dependency, and validation steps. The Images and GIFs section is absent, but it is not critical for this documentation-only change.

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Tip

🎯 Customize your risk assessments

Guide how CodeRabbit assesses merge risk and security architecture risk. Highlight sensitive changes and explain your security boundaries using Merge Risk Instructions and Security Risk Instructions in your review settings. Security architecture risk assessments require the Advanced plan or above.

✅ Automatic approvals, with your rules

Let CodeRabbit approve pull requests once required threads are resolved, pre-merge checks pass, and your risk limits are met. Enable Automatic approvals in review settings, with overrides for teams or file paths.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

CodeRabbit Verify

  • Run CodeRabbit Verify to test the changes in this pull request.
Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 297b94e3-938d-4752-91c0-a849fec4acab
Commits

Reviewing files that changed from the base of the PR and between 16d6f42 and fdf17a9.

Files selected for processing: 3
  • CLAUDE.md
  • specs/account-management.openapi.yml
  • specs/inbound.openapi.yml

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

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 <noreply@anthropic.com>

@IgorDobryn IgorDobryn left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, a few non-blocking comments.

Question: should the spec title follow? specs/email-sending.openapi.yml is still title: Email Sending, and the README rows still say "Email Sending" / "Email Sending (Bulk)" / "Email Sending (Transactional)". The billing usage page now treats "Email Sending (Email API/SMTP)" as the old product name, so the docs navigation would keep it. Is that for a separate PR, or does "Email Sending" stay as the section name?

Comment thread specs/inbound.openapi.yml Resolved
Comment thread CLAUDE.md Resolved
"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 <noreply@anthropic.com>
@izikaj

izikaj commented Oct 30, 2026

Copy link
Copy Markdown
Contributor Author

On the spec title question: "Email Sending" is an older name of the same product, so the email-sending.openapi.yml title and the three README rows now say "Email Live Sending". File names and URLs stay.

The table uses the short form "Sandbox", so use "Live Sending" to keep
one name set.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Comment thread specs/inbound.openapi.yml Resolved
@izikaj
izikaj merged commit a769359 into main Nov 9, 2026
9 checks passed
@izikaj
izikaj deleted the rename-email-api-smtp-to-live-sending branch November 9, 2026 12:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants