Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More examples would help new users understand how to use this library #1

Open
dmjones opened this issue Sep 20, 2018 · 1 comment
Open
Assignees
Labels
help wanted Extra attention is needed stalled until release This issue won't be fixed until there is a release version of this package

Comments

@dmjones
Copy link

dmjones commented Sep 20, 2018

Great job on getting IMAP support into Flutter, much appreciated.

However, as a relative newcomer to the IMAP protocol, I'm finding it quite challenging to know how to use your library to perform common tasks. I also find the ImapResponse class quite difficult to work with; there are many different fields and it's not clear which ones will contain the answer to my commands.

I imagine a lot of this could be solved with a few more examples, e.g.:

  • List the names of all the mailboxes
  • Find all unread mail
  • ...

I'll try and add some of these via a PR, as and when I figure them out, but if you had further examples ready to go, that would be great.

@michaelspiss
Copy link
Owner

michaelspiss commented Oct 12, 2018

Sorry for the delay, I somehow missed that an issue was opened.

In its current state, the package is a 1:1 implementation of all IMAP commands. However, the plan is to add another class which acts as an abstraction layer, so commands like listMailboxes() can be implemented and executed easily. I think this will make it much easier to get started with - and eventually use - this library.

I am also not quite satisfied with the ImapResponse class, any ideas on how it could be improved are highly appreciated. I would like it best if the class could be completely avoided in the future.

I will add some more examples soon, which I hope will it make it easier for you and others to get started.
PRs and suggestions/ideas are always welcome!

@michaelspiss michaelspiss self-assigned this Mar 9, 2019
@michaelspiss michaelspiss added help wanted Extra attention is needed good first issue Good for newcomers labels Mar 9, 2019
@michaelspiss michaelspiss added this to the Stable release milestone Mar 9, 2019
@michaelspiss michaelspiss added stalled until release This issue won't be fixed until there is a release version of this package and removed good first issue Good for newcomers labels Oct 31, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed stalled until release This issue won't be fixed until there is a release version of this package
Projects
None yet
Development

No branches or pull requests

2 participants