docs(mailing): Body is the HTML part, and the new TextBody alternative - #239
Open
marcelo-maciel wants to merge 1 commit into
Open
docs(mailing): Body is the HTML part, and the new TextBody alternative#239marcelo-maciel wants to merge 1 commit into
marcelo-maciel wants to merge 1 commit into
Conversation
MailRequest.Body always lands in the HTML part, which the page stated only in passing and the SendGrid line got wrong (it no longer sends Body as both parts). Records the new optional TextBody, and warns about the two ways bare text in Body bites: an action link that is never auto-linked, and interpolated values parsed as markup. Adds the changelog entry for the fix.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs for dotnet-starter-kit#1351 (Golden Rule #10).
Building blocks → Mailing. The page mentioned only in passing that the body is treated as HTML, and the SendGrid sentence is now wrong — that provider no longer receives
Bodyas both the plain-text and the HTML content. Updated theMailRequestsignature with the new optionaltextBody, spelled out thatBodyis the HTML part andTextBodythetext/plainalternative, and added a caution covering the two ways bare text inBodybites: an action link that never becomes clickable (auto-linking istext/plainbehaviour), and interpolated values parsed as markup. The consume example now passestextBody.Changelog. Entry for the fix, including the note that no deployment action is required —
TextBodyis optional and appended last, so existing callers keep compiling.Verified:
npm run buildclean (92 pages indexed).Holds until #1351 lands, same as #232.
Note for whoever merges: this PR and #232 both insert a new section at the head of
changelog/index.mdx, so the second one to land will conflict there. Happy to rebase whichever comes second — no need to hold either on the other's account.