Skip to content

Commit 32dfda9

Browse files
committed
📚 Update #search documentation, search criteria
1 parent c76e9d6 commit 32dfda9

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

lib/net/imap.rb

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1239,17 +1239,23 @@ def uid_expunge(uid_set)
12391239
#
12401240
# ===== Search criteria
12411241
#
1242-
# The following are some common search criteria;
1243-
# see [{IMAP4rev1 §6.4.4}[https://www.rfc-editor.org/rfc/rfc3501.html#section-6.4.4]]
1244-
# for a full list:
1242+
# For a full list of search criteria,
1243+
# see [{IMAP4rev1 §6.4.4}[https://www.rfc-editor.org/rfc/rfc3501.html#section-6.4.4]],
1244+
# or [{IMAP4rev2 §6.4.4}[https://www.rfc-editor.org/rfc/rfc9051.html#section-6.4.4]],
1245+
# in addition to documentation for
1246+
# any [CAPABILITIES[https://www.iana.org/assignments/imap-capabilities/imap-capabilities.xhtml]]
1247+
# reported by #capability which may define additional search filters, e.g:
1248+
# +CONDSTORE+, +WITHIN+, +FILTERS+, <tt>SEARCH=FUZZY</tt>, +OBJECTID+, or
1249+
# +SAVEDATE+. The following are some common search criteria:
12451250
#
12461251
# <message set>:: a set of message sequence numbers. "<tt>,</tt>" indicates
12471252
# an interval, "+:+" indicates a range. For instance,
12481253
# "<tt>2,10:12,15</tt>" means "<tt>2,10,11,12,15</tt>".
12491254
#
12501255
# BEFORE <date>:: messages with an internal date strictly before
1251-
# <date>. The date argument has a format similar
1252-
# to 8-Aug-2002.
1256+
# <b><date></b>. The date argument has a format similar
1257+
# to <tt>8-Aug-2002</tt>, and can be formatted using
1258+
# Net::IMAP.format_date.
12531259
#
12541260
# BODY <string>:: messages that contain <string> within their body.
12551261
#

0 commit comments

Comments
 (0)