Docs: align README and template_variables description with runtime rules

[mklocek]

Motivation

I forgot to update it in #82.

Changes

• Docs: align README and template_variables description with runtime rules

Summary by CodeRabbit

• Documentation
  • Added template-based email sending examples and documentation for send-email and send-sandbox-email tools, showcasing usage with template_uuid and template_variables
  • Updated parameter requirements for improved flexibility in email field handling

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2da8263c-cad0-45b9-aef3-a6230dded9b6

📥 Commits

Reviewing files that changed from the base of the PR and between 1352bd7 and 7cfc875.

📒 Files selected for processing (1)

• README.md

---

📝 Walkthrough

Walkthrough

README documentation expanded to support template-based email sending across two tools (send-email and send-sandbox-email), adding parameter flexibility and clarifying mutually exclusive inline versus template modes with updated usage examples.

Changes

Template-Based Email Sending Documentation

Layer / File(s)	Summary
Usage Example README.md	Added new concrete usage bullet demonstrating how to send an email using a Mailtrap template via template_uuid with template_variables.
send-email Tool Documentation README.md	Reworked documentation to explain two mutually exclusive modes: inline mode with subject + text/html and optional category, versus template-based mode with template_uuid and template_variables where subject/text/html/category must be omitted. Made to optional when cc/bcc is provided and category no longer required.
send-sandbox-email Tool Documentation README.md	Reworked documentation to mirror send-email changes, supporting both inline and template-based modes with template_uuid/template_variables. Relaxed prior required fields (to, subject, text/html) to conditional requirements based on the selected mode.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

• mailtrap/mailtrap-mcp#82: Implements the template-based sending and relaxed parameter requirements documented in this README update.

Suggested reviewers

• IgorDobryn
• piobeny
• VladimirTaytor

Poem

🐰 A template journey hops into view,
Inline or templated—now we can choose!
No required to, just cc and bcc,
Parameters flexing so wild and so free!
The sandbox and sender in sync, what a treat! 📧✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately and concisely summarizes the main change: aligning README documentation and template_variables description with runtime rules.
Description check	✅ Passed	The description covers the motivation and changes, but lacks the 'How to test' and 'Images and GIFs' sections specified in the repository template.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch README-fix

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}