MT-22401: Add Email Campaigns API - #72
Merged
Merged
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughAdds an account-scoped Email Campaign API client with request DTOs, CRUD, lifecycle operations, scheduling, statistics, client registration, tests, a PHP example, and README links. ChangesEmail Campaigns
Estimated code review effort: 3 (Moderate) | ~20 minutes Mergeability Score: ⚪ Minimal · up to The PR adds the Email Campaigns API and related typed models and documentation; no actionable merge-blocking risk remains beyond normal checks and review. Sequence Diagram(s)sequenceDiagram
participant Application
participant MailtrapGeneralClient
participant EmailCampaign
participant MailtrapAPI
Application->>MailtrapGeneralClient: emailCampaigns(accountId)
MailtrapGeneralClient-->>Application: EmailCampaign client
Application->>EmailCampaign: createEmailCampaign(request DTO)
EmailCampaign->>MailtrapAPI: POST /api/email_campaigns
MailtrapAPI-->>EmailCampaign: campaign response
EmailCampaign-->>Application: handled response
Application->>EmailCampaign: scheduleEmailCampaign(id, datetime)
EmailCampaign->>MailtrapAPI: POST /api/email_campaigns/{id}/schedule
MailtrapAPI-->>EmailCampaign: scheduled campaign response
EmailCampaign-->>Application: handled response
Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches 💡 1📝 Generate docstrings 💡
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. Comment |
Rabsztok
marked this pull request as ready for review
July 30, 2026 12:03
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@examples/email-campaigns/all.php`:
- Around line 58-71: Update the example flow around createEmailCampaign and all
dependent operations to extract and reuse the created campaign ID from response
data instead of hard-coded 4567. Check the create response for failure and stop
before update, lifecycle, stats, or delete actions when creation does not
succeed; preserve the existing operation order and output behavior for
successful creation.
- Around line 173-181: Update the campaign lifecycle sequence around
resetEmailCampaign so resetEmailCampaign is called while the campaign remains
scheduled. Move the reset demonstration immediately after scheduling, then
schedule the campaign again before the cancellation, start, and termination
steps, or use a separate campaign identifier for the later sequence.
- Line 60: Update the email campaign configuration around mailsendDomainId and
the related contact list/segment IDs to remove account-scoped hardcoded
fallbacks. Require the corresponding environment or configuration values, or
mark each fallback explicitly as a placeholder that must be replaced before use.
- Around line 16-18: Cast the $_ENV['MAILTRAP_ACCOUNT_ID'] value to an integer
when assigning $accountId, then pass that integer unchanged to
MailtrapGeneralClient::emailCampaigns().
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: b23572ec-0178-4077-92d2-77e45f57fc88
📒 Files selected for processing (13)
CHANGELOG.mdREADME.mdexamples/README.mdexamples/email-campaigns/all.phpsrc/Api/General/EmailCampaign.phpsrc/DTO/Request/EmailCampaign/CreateEmailCampaign.phpsrc/DTO/Request/EmailCampaign/EmailCampaignInterface.phpsrc/DTO/Request/EmailCampaign/ReplyTo.phpsrc/DTO/Request/EmailCampaign/TemplateAttributes.phpsrc/DTO/Request/EmailCampaign/UpdateEmailCampaign.phpsrc/MailtrapGeneralClient.phptests/Api/General/EmailCampaignTest.phptests/MailtrapGeneralClientTest.php
Contributor
Author
|
Addressed all 4 CodeRabbit findings in d7105c4:
Also derived the stats date window at runtime ( Verified: full phpunit suite (418 tests) green, psalm clean. |
Rabsztok
marked this pull request as draft
July 31, 2026 11:56
Rabsztok
force-pushed
the
MT-22401-php-email-campaigns
branch
2 times, most recently
from
August 7, 2026 06:23
9dd3c92 to
2c88691
Compare
Rabsztok
marked this pull request as ready for review
August 7, 2026 07:24
|
Note GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer. |
IgorDobryn
approved these changes
Aug 7, 2026
Decisions:
- Request bodies are flat JSON — no ['email_campaign' => ...] wrapper; domain_id is an integer sending domain ID
- Single-campaign and stats responses documented/tested as {data: ...} envelopes; delete returns 204 with no body
- Typed TemplateAttributes (subject/body_html/body_text/merge_tags, no template id) and ReplyTo DTOs replace raw arrays
- contact_list_ids/contact_segment_ids kept behind the !== null filter so [] still clears the audience
- Five lifecycle endpoints (start/schedule/cancel/terminate/reset); schedule accepts string or DateTimeInterface; stats gains optional start_date/end_date
Decisions: - Reuse the created campaign ID across all dependent example steps; exit early when creation fails - Reorder lifecycle to schedule -> reset -> schedule again -> cancel -> start -> terminate so every action runs from a valid state - Require MAILTRAP_DOMAIN_ID (no arbitrary fallback) and mark contact list/segment IDs as placeholders - Cast MAILTRAP_ACCOUNT_ID to int (strict_types + int param) - Derive stats date window at runtime instead of fixed dates
Rabsztok
force-pushed
the
MT-22401-php-email-campaigns
branch
from
August 10, 2026 07:27
2c88691 to
2d58775
Compare
VladimirTaytor
approved these changes
Aug 10, 2026
Decisions:
- "/api/accounts/{account_id}/email_campaigns" does not exist, so there is no
need to contrast the real path against it
- Keep the positive fact that the account comes from the API token; it explains
why the path takes no account id
Decisions:
- "/api/accounts/{account_id}/email_campaigns" does not exist, so comments and
tests should not contrast the real path against it
- The positive path assertions already cover what these comments described
Decisions: - The backend allows deleting only a campaign in the draft state (EmailCampaign#validate_soft_delete), not merely a non-sending one - Examples deleted a campaign after start/terminate, which would 422; a started campaign can never return to draft, so they now delete a fresh draft
Open
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
MT-22401
Port the Email Campaigns public API (MT-21113) to the PHP SDK.
Changes
emailCampaigns()to the General client with the full contract: list (per_page/search/token), get, create, update, delete (204), the five lifecycle actions (start,schedule,cancel,terminate,reset), and stats with an optional date rangedomainId(a Sending Domains endpoint id), newTemplateAttributes(subject/bodyHtml/bodyText/mergeTags) andReplyToDTOs, audience id arrays (empty array clears the audience),rapid/gradualdelivery modes, 10-value state constantsexamples/email-campaigns/all.php+ README/CHANGELOG entriesHow to test
examples/email-campaigns/all.phpwith a real API token and a verified sending domain — create a draft, update design/audience, schedule + cancel, fetch stats, deletedatapayload and a lifecycle 422 surfaces the API error messageSummary by CodeRabbit