Added types to mail error helper function

[EvanHahn]

no ref

This is a types-only change that should have no user impact.

[nx-cloud]

🤖 Nx Cloud AI Fix

Ensure the fix-ci command is configured to always run in your CI pipeline to get automatic fixes in future runs. For more information, please see https://nx.dev/ci/features/self-healing-ci

---

View your CI Pipeline Execution ↗ for commit aad09e3

Command	Status	Duration	Result
nx run ghost:test:ci:integration	✅ Succeeded	2m 43s	View ↗
nx run ghost:test:integration	✅ Succeeded	2m 39s	View ↗
nx run ghost:test:legacy	✅ Succeeded	2m 58s	View ↗
nx run ghost:test:e2e	✅ Succeeded	2m 18s	View ↗
nx run-many --target=build --projects=tag:publi...	✅ Succeeded	<1s	View ↗
nx run-many -t lint -p ghost	✅ Succeeded	35s	View ↗
nx run-many -t test:unit -p ghost	✅ Succeeded	24s	View ↗
nx run @tryghost/admin:build	✅ Succeeded	6s	View ↗
Additional runs (2)	✅ Succeeded	...	View ↗

💡 Verify your cache is correct by running tasks in a sandbox. Read docs ↗

---

☁️ Nx Cloud last updated this comment at 2026-07-05 23:10:32 UTC

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 0f9592c1-a4f4-4a54-b8a3-2d6bbd80b31d

📥 Commits

Reviewing files that changed from the base of the PR and between 46304d6 and aad09e3.

📒 Files selected for processing (1)

• ghost/core/core/server/services/mail/ghost-mailer.js

---

Walkthrough

This change adds a JSDoc comment block to the createMailError helper function in ghost-mailer.js, documenting the shape of its optional options parameter (message, err, ignoreDefaultMessage) and its errors.EmailError return type. No functional code was modified.

Changes

File	Summary
ghost/core/core/server/services/mail/ghost-mailer.js	Added JSDoc documentation for createMailError helper, describing parameters and return type.

Sequence Diagram(s)

No sequence diagram generated, as this change is documentation-only with no functional or behavioral flow changes.

Estimated code review effort: Low

Related issues: None specified

Related PRs: None specified

Suggested labels: documentation

Suggested reviewers: None specified

Poem

A rabbit hopped through code so neat,
Found a function bare, without a treat,
So it dressed it up in JSDoc lace,
Params and returns now in their place,
Documentation done—a tidy feat! 🐰📝

🚥 Pre-merge checks | ✅ 4

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title matches the main change: adding type documentation to the mail error helper.
Description check	✅ Passed	The description is related to the change and correctly frames it as a types-only update.
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.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch createMailError-types

---

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.}