Allow user to customize the sender name for mails

[bmaster001]

Description

Fix for issue #994

Checklist

Please check off all the following items with an "x" in the boxes before requesting a review.

• I have performed a self-review of my code
• My code follows the code style of this project
• I have commented my code, particularly in hard-to-understand areas

Summary by CodeRabbit

• New Features
  • Introduced a new configuration option to customize the sender name for transactional emails.
• Improvements
  • Updated the default email sender name to be configurable through an environment variable, enhancing flexibility.

[vercel]

@BelOrta-TDP is attempting to deploy a commit to the rallly Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

Walkthrough

This update introduces a new configuration option, NOREPLY_EMAIL_NAME, allowing users to set a custom sender name for transactional emails in Rallly. If this option is not explicitly configured, the system now defaults to using a predefined environment variable. Should this variable be undefined, "Rallly" will be used as the sender name, ensuring a more personalized email interaction.

Changes

File Path	Change Summary
.../configuration-options.mdx	Added NOREPLY_EMAIL_NAME option for customizing transactional email sender names in Rallly.
.../src/utils/emails.ts	Updated email sender name logic to prioritize NOREPLY_EMAIL_NAME env variable, defaulting to "Rallly".

🐇✉️
In the land of code and byte,
Where emails fly by day and night,
A name now sails through digital sea,
"Rallly" whispers, or what you decree.
🌟📬

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 42a133e and cb3d709.

Files ignored due to path filters (1)

• turbo.json is excluded by: !**/*.json

Files selected for processing (2)

• apps/docs/self-hosting/configuration-options.mdx (1 hunks)
• apps/web/src/utils/emails.ts (1 hunks)

Additional comments: 1

apps/docs/self-hosting/configuration-options.mdx (1)

• 44-47: The documentation for NOREPLY_EMAIL_NAME is clear and accurately reflects the implementation. It specifies the default behavior when the variable is not set, which is consistent with the code changes in emails.ts.

[coderabbitai]

Ensure that the cast to string for process.env.NOREPLY_EMAIL_NAME is necessary. If process.env.NOREPLY_EMAIL_NAME is undefined or not set, the fallback value "Rallly" will be used, which is correct. However, consider checking for empty string values as well, as an empty string is truthy when cast to string, potentially leading to an unintended sender name.

- (process.env.NOREPLY_EMAIL_NAME as string) || "Rallly",
+ process.env.NOREPLY_EMAIL_NAME?.trim() || "Rallly",

---

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

	name:
	(process.env.NOREPLY_EMAIL_NAME as string) ||
	"Rallly",
	name:
	process.env.NOREPLY_EMAIL_NAME?.trim() || "Rallly",

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
app	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 17, 2024 5:09am
landing	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 17, 2024 5:09am

[lukevella]

Thanks for you contribution. Will be available in the next release 👌