Project future & Roadmap

[Webklex]

Hi everybody,
first of all I would like to thank you all for reporting issues, asking questions and creating new pull requests. You are amazing!

Given the recent increase in activity I feel like I should provide you with some information on whats going on here. Below you'll find the, in my opinion, currently biggest issues as well as things I would like to change in the future.

These are the issues I would like to tackle as soon as possible:

• Body detection problem, likely caused by some sort of boundary parsing issue
  • Mail content is parsed as file attachment #142
  • Empty body #138
  • Error regex to getBoundary() passing by getAttachment() #126
  • Problem parsing of Boundary #121
  • Missing email bodies (v2), with example to reproduce #111
• Move message reliably
  • Exception when move a message #131
  • Fail on move, only move half of messages #130
  • I use move() for move message to another folder, but not working. #123
  • move method is moving the wrong message #105
  • Move message fails silently #99
• Improve legacy support
  • Obvious bug in LegacyProtocol::headers method #125
  • LegacyProtocol connects multiple times due to logic error #124
• Fix cyrillic decoding issue
  • Support for cyrillic Windows-1251 #102

If you would like to help by taking a deep dive into one of the issues, please feel free to send me an email anytime if you have any questions.
If you already have a solution, you are welcome to submit a pull request :)

To further limit the amount of potential problems, I would like to:

• change the default config options.sequence from ST_MSGN to ST_UID to use uids instead of message numbers. Also uids are not unique either - I personally have less problems with them.
• change the versioning to semantic versioning as @itkfm correctly pointed out in Breaking changes should not be introduced in minor releases #120. Starting with v.3.0.0.
• make the documentation searchable and add ankers to all headlines (makes it easier to link to certain sections)

If you have any additional thoughts or if I'm missing anything, please comment below.

Thanks again and best regards,
Webklex