Skip to content
This repository has been archived by the owner on Nov 17, 2021. It is now read-only.

Documentation: ID Header section is confusing #985

Closed
ThomasLandauer opened this issue Aug 9, 2017 · 2 comments
Closed

Documentation: ID Header section is confusing #985

ThomasLandauer opened this issue Aug 9, 2017 · 2 comments

Comments

@ThomasLandauer
Copy link
Contributor

First: Is this the right place to report errors in the docs https://swiftmailer.symfony.com/docs/introduction.html ? No repo to submit a PR?

It's about https://swiftmailer.symfony.com/docs/headers.html#id-headers

  • Minor typo: "Changing the value of an existing date header is done by calling its setId() method" => "of an existing ID header"
  • Major: IMO, The entire section is overly complicated. Most people probably just want to set the Message-ID header, nothing else. I mean: Who uses a custom ID header? What for?
    Also the text keeps switching between talking about the "official" Message-ID and those custom ID-headers. When following the examples, it can lead to this issue: addIdHeader() produces duplicate Message-ID header #984
    So I think the entire section should be re-written completely.
@Rotzbua
Copy link
Contributor

Rotzbua commented Aug 9, 2017

Documentation path to make a pr: https://github.com/swiftmailer/swiftmailer/tree/master/doc

@ThomasLandauer
Copy link
Contributor Author

I'm closing this, since Swift Mailer is going to be replaced by Symfony Mailer.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants