Added note about UIDPLUS values #661
Open
Conversation
This file contains 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
Added note about `UIDPLUS` parameter in append callback. See issue mscdex#660
mscdex
reviewed
Nov 5, 2017
| @@ -502,8 +502,9 @@ Connection Instance Methods | |||
| * **flags** - _mixed_ - A single flag (e.g. 'Seen') or an _array_ of flags (e.g. `['Seen', 'Flagged']`) to append to the message. **Default:** (no flags) | |||
| * **date** - _Date_ - What to use for message arrival date/time. **Default:** (current date/time) | |||
|
|
|||
| `callback` has 1 parameter: < _Error_ >err. | |||
|
|
|||
| `callback` has 2 parameters: < _Error_ >err., < _array_ >UIDs. | |||
mscdex
reviewed
Nov 5, 2017
| `callback` has 1 parameter: < _Error_ >err. | ||
|
|
||
| `callback` has 2 parameters: < _Error_ >err., < _array_ >UIDs. | ||
| (Note: If the server supports the UIDPLUS capability, then the UID validity and message UID will be passed as an array as the second argument to your callback.) |
There was a problem hiding this comment.
Period can be dropped inside the parentheses.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Updated docs to include note about UIDPLUS. See issue #660