]> granicus.if.org Git - curl/commitdiff
DOCS: Added the list command to the IMAP URL section
authorSteve Holme <steve_holme@hotmail.com>
Thu, 7 Mar 2013 11:51:40 +0000 (11:51 +0000)
committerSteve Holme <steve_holme@hotmail.com>
Thu, 7 Mar 2013 11:51:40 +0000 (11:51 +0000)
Added examples of the list command and clarified existing example URLs
following recent changes.

docs/libcurl/curl_easy_setopt.3

index cc419f68762ff576feab4dc2988ccf5119876053..d3d3c828ed54df1776999a6dc98fbeabd5f3fa00 100644 (file)
@@ -738,25 +738,25 @@ the user
 
 .B IMAP
 
-The path part of an IMAP request not only specifies the mailbox to select, but
-can also be used to check the UIDVALIDITY of the mailbox and to specify the
-UID and SECTION of the message to fetch (Added in 7.30.0).
+The path part of an IMAP request not only specifies the mailbox to list (Added
+in 7.30.0) or select, but can also be used to check the UIDVALIDITY of the
+mailbox and to specify the UID and SECTION of the message to fetch (Added in
+7.30.0).
 
-imap://user:password@mail.example.com - Selects the user's INBOX and fetches
-message 1
+imap://user:password@mail.example.com - Performs a top level folder list
 
-imap://user:password@mail.example.com/INBOX/;UIDVALIDITY=50 - Selects the
-user's inbox, checks the UIDVALIDITY of the mailbox is 50 and fetches message
-1 if it is
+imap://user:password@mail.example.com/INBOX - Performs a folder list on the
+user's inbox
 
-imap://user:password@mail.example.com/OUTBOX - Selects the user's OUTBOX and
-fetches message 1
+imap://user:password@mail.example.com/INBOX/;UID=1 - Selects the user's inbox
+and fetches message 1
 
-imap://user:password@mail.example.com/OUTBOX/;UID=2 - Selects the user's OUTBOX
-mailbox and fetches message 2
+imap://user:password@mail.example.com/INBOX/;UID=2/;UIDVALIDITY=50 - Selects
+the user's inbox, checks the UIDVALIDITY of the mailbox is 50 and fetches
+message 2 if it is
 
-imap://user:password@mail.example.com/OUTBOX/;UID=3/;SECTION=TEXT - Selects the
-SENT mailbox and fetches message 3 with only the text portion of the message
+imap://user:password@mail.example.com/INBOX/;UID=3/;SECTION=TEXT - Selects the
+user's inbox and fetches message 3 with only the text portion of the message
 
 For more information about the individual components of an IMAP URL please
 see RFC5092.