|
|
I believe this bug can be fixed by https://github.com/Alinto/sogo/pull/375
The Bug
The _quoteSpecials: method in SoObjects/Mailer/SOGoDraftObject.m had three problems that caused addresses like "Max, Muster [ABC]" <Max.Muster@ab-cd.df> to "break into pieces":
-
Checked for special chars ANYWHERE in the string (including the <email> part). Since every email contains @ and ., the quoting logic was always triggered for any address with angle brackets — even when unnecessary.
-
Incorrect display name extraction: It scanned from the end for <, then used substringToIndex: i - 1 (assuming a space before <). This broke for addresses like Lastname, Firstname <user@ex.com> where there's no space or unexpected whitespace.
-
No detection of already-formatted names: It would double-quote an already-quoted "Doe, John" <user@ex.com> into ""Doe, John"" <user@ex.com>.
-
No RFC 2047 encoded-word awareness: Would corrupt already-encoded display names.
The Fix (4 methods)
Method What it does
_needsQuotingForPhrase: RFC 5322-compliant check — only inspects display name part for ,;:@.<>[]()\"
_alreadyProperlyFormatted: Detects already-quoted "..." or RFC 2047 =?…?= names — skips re-quoting
_quoteAndEscape: Properly escapes \ and " inside quoted strings per RFC 5322
_quoteSpecials: Full rewrite — splits display name from email, applies checks per component
Test Coverage — 18 tests
- The exact reported bug: Lastname, Firstname (INFO)[MoreINFO] <user@example.com> → correctly quoted
- Simple email, simple display name — unchanged
- Display names with: comma, parenthesis, brackets, colon, semicolon, @, ., backslash, double-quote — all correctly quoted
- Already-quoted / RFC 2047 encoded — passed through unmodified
- Nil/empty input — handled gracefully
- Array version _quoteSpecialsInArray: — works for batch recipient lists
- Whitespace trimming around display names
Files Changed
SoObjects/Mailer/SOGoDraftObject.m 89 insertions, 42 deletions — full rewrite of _quoteSpecials: + 3 new helpers
Tests/Unit/TestSOGoDraftObjectQuoteSpecials.m 429 lines — new test file
Tests/Unit/GNUmakefile 1 line — adds new test to build
docs/fix-email-header-serialization-bug.md 146 lines — root cause analysis doc // maybe exlude
Verdict
The fix is thorough and RFC 5322 compliant. The old code was checking for specials on the entire address string. The new approach cleanly separates display name from email, only quotes when needed, and avoids double-quoting. 18 tests cover corner cases. The "Max, Muster [ABC]" <Max.Muster@ab-cd.df> case from the description would be handled perfectly by this fix — the comma and brackets in the display name would be quoted via _quoteAndEscape:, emitting "Max, Muster [ABC]" <Max.Muster@ab-cd.df>.
Best, Tobias |
