Zero icon indicating copy to clipboard operation
Zero copied to clipboard

Feat/mailto fixes

Open jlokos opened this issue 9 months ago • 2 comments

Description

This pull request enhances the email mailto: handling functionality by adding support for cc and bcc for mailto:

Type of Change

  • [x] 🐛 Bug fix (non-breaking change which fixes an issue)
  • [x] ✨ New feature (non-breaking change which adds functionality)
  • [ ] 💥 Breaking change (fix or feature with breaking changes)
  • [ ] 📝 Documentation update
  • [x] 🎨 UI/UX improvement
  • [ ] 🔒 Security enhancement
  • [ ] ⚡ Performance improvement

Areas Affected

  • [x] Email Integration (Gmail, IMAP, etc.)
  • [x] User Interface/Experience
  • [ ] Authentication/Authorization
  • [ ] Data Storage/Management
  • [x] API Endpoints
  • [ ] Documentation
  • [ ] Testing Infrastructure
  • [ ] Development Workflow
  • [ ] Deployment/Infrastructure

Testing Done

Describe the tests you've done:

  • [ ] Unit tests added/updated
  • [ ] Integration tests added/updated
  • [x] Manual testing performed
  • [ ] Cross-browser testing (if UI changes)
  • [ ] Mobile responsiveness verified (if UI changes)

Checklist

  • [x] I have read the CONTRIBUTING document
  • [x] My code follows the project's style guidelines
  • [x] I have performed a self-review of my code
  • [x] I have commented my code, particularly in complex areas
  • [ ] I have updated the documentation
  • [x] My changes generate no new warnings
  • [ ] I have added tests that prove my fix/feature works
  • [ ] All tests pass locally
  • [ ] Any dependent changes are merged and published

Screenshots/Recordings

https://github.com/user-attachments/assets/417bc07e-4bbf-4315-8c87-587f7b5547f5


By submitting this pull request, I confirm that my contribution is made under the terms of the project's license.

Summary by CodeRabbit

  • New Features

    • Added support for CC and BCC fields when composing and saving email drafts.
    • Compose email form now initializes CC and BCC fields from URL parameters if provided.
  • Enhancements

    • Improved draft creation reliability with automatic retries and better error handling.
    • Enhanced recipient normalization for To, CC, and BCC fields to ensure correct formatting.
    • Compose experience now uses a modal dialog with hotkey and navigation integration for smoother user interaction.
  • Bug Fixes

    • Draft loading errors are now handled gracefully with user notifications.

jlokos avatar May 01 '25 22:05 jlokos

@jlokos is attempting to deploy a commit to the Zero Team on Vercel.

A member of the Team first needs to authorize it.

vercel[bot] avatar May 01 '25 22:05 vercel[bot]

Walkthrough

This change set introduces support for CC and BCC fields throughout the mail compose, draft handling, and mailto flow. The compose page and CreateEmail component now accept and process initial CC and BCC values, and the mailto handler parses and propagates these fields when present. Draft types and interfaces are updated to include CC and BCC, and new utility functions are added for cleaning and formatting recipient addresses. The compose UI is refactored to use a modal dialog with improved draft loading, error handling, and hotkey integration.

Changes

File(s) Change Summary
apps/mail/app/(routes)/mail/compose/page.tsx Extended ComposePageProps to include optional cc and bcc in searchParams; passes these as props to CreateEmail; updates mailto redirect URL; minor import/order cleanup.
apps/mail/components/create/create-email.tsx Refactored to use modal dialog UI; added support for initial CC/BCC; improved draft loading with error handling; hotkey integration; cleaned up unused state and variables; processes and passes CC/BCC to composer.
apps/mail/app/api/mailto-handler.ts Enhanced mailto parsing to support CC/BCC; draft creation now handles these fields; added retry logic for draft creation; fallback redirect includes all mailto data if draft creation fails.
apps/mail/lib/driver/google.ts parseDraft now extracts and returns CC/BCC fields from draft headers; removed related TODO.
apps/mail/lib/driver/types.ts Added optional cc and bcc string array properties to ParsedDraft interface.
apps/mail/lib/email-utils.ts Added cleanEmailAddresses, formatRecipients, and formatMimeRecipients utility functions for address normalization and formatting.
apps/mail/store/draftStates.ts Extended DraftType interface to include optional cc and bcc string properties.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ComposePage
    participant CreateEmail
    participant DraftStore
    participant MailtoHandler

    User->>ComposePage: Navigates to /mail/compose?cc=...&bcc=...
    ComposePage->>CreateEmail: Passes initialCc, initialBcc, draftId
    CreateEmail->>DraftStore: Load draft (if draftId present)
    alt Draft load fails
        CreateEmail->>User: Show error toast
    else Draft loaded or composing new
        CreateEmail->>User: Show compose dialog with to/cc/bcc fields
    end
    User->>CreateEmail: Sends email (with to/cc/bcc)
sequenceDiagram
    participant ExternalApp
    participant MailtoHandler
    participant DraftStore
    participant ComposePage

    ExternalApp->>MailtoHandler: Opens mailto: link with to/cc/bcc/subject/body
    MailtoHandler->>DraftStore: Attempts to create draft with all fields
    alt Draft creation succeeds
        MailtoHandler->>ComposePage: Redirect to compose with draftId
    else Draft creation fails
        MailtoHandler->>ComposePage: Redirect to compose with mailto fields as query params
    end

Possibly related PRs

  • Mail-0/Zero#639: Disables all mailto processing logic in the /mail/compose/handle-mailto/route.ts route, directly affecting the same route that is enhanced in this PR.
  • Mail-0/Zero#574: Introduces the initial mailto protocol handler feature, which this PR extends by adding CC/BCC support and related compose flow changes.

Suggested reviewers

  • MrgSub
  • needleXO

Poem

In the warren where emails hop and play,
CC and BCC join the fray.
Compose now pops with modal delight,
Drafts catch errors and set things right.
With clean addresses and helpers anew,
This bunny’s mail is hopping through!
🐇✉️

✨ Finishing Touches
  • [ ] 📝 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.

❤️ Share
🪧 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>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar May 01 '25 22:05 coderabbitai[bot]

@coderabbitai review

jlokos avatar May 05 '25 03:05 jlokos

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai[bot] avatar May 05 '25 03:05 coderabbitai[bot]