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.

Sign up for GitHub

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

Added note about UIDPLUS values #661

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Added note about UIDPLUS values #661

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1aecad
Updated README
dudewheresmycode Nov 5, 2017
8cd74f3
Merge pull request #1 from dudewheresmycode/dudewheresmycode-patch-1
dudewheresmycode Nov 5, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/err.,/err,/

(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.)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Period can be dropped inside the parentheses.


**All functions below have sequence number-based counterparts that can be accessed by using the 'seq' namespace of the imap connection's instance (e.g. conn.seq.search() returns sequence number(s) instead of UIDs, conn.seq.fetch() fetches by sequence number(s) instead of UIDs, etc):**

* **search**(< _array_ >criteria, < _function_ >callback) - _(void)_ - Searches the currently open mailbox for messages using given criteria. `criteria` is a list describing what you want to find. For criteria types that require arguments, use an _array_ instead of just the string criteria type name (e.g. ['FROM', '[email protected]']). Prefix criteria types with an "!" to negate.
Expand Down