Author: sebb
Date: Sat Oct 22 09:46:43 2016
New Revision: 1766181
URL: http://svn.apache.org/viewvc?rev=1766181&view=rev
Log:
Javadoc
Modified:
commons/proper/net/trunk/src/main/java/examples/mail/IMAPExportMbox.java
Modified:
commons/proper/net/trunk/src/main/java/examples/mail/IMAPExportMbox.java
URL:
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/examples/mail/IMAPExportMbox.java?rev=1766181&r1=1766180&r2=1766181&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/examples/mail/IMAPExportMbox.java
(original)
+++ commons/proper/net/trunk/src/main/java/examples/mail/IMAPExportMbox.java
Sat Oct 22 09:46:43 2016
@@ -56,21 +56,26 @@ import org.apache.commons.net.imap.IMAPR
* <ul>
* <li>BODY.PEEK[HEADER]</li>
* <li>'BODY.PEEK[HEADER.FIELDS (SUBJECT)]'</li>
- * <li>ALL</li>
- * <li>ENVELOPE</li>
+ * <li>ALL - macro equivalent to '(FLAGS INTERNALDATE RFC822.SIZE
ENVELOPE)'</li>
+ * <li>FAST - macro equivalent to '(FLAGS INTERNALDATE RFC822.SIZE)'</li>
+ * <li>FULL - macro equivalent to '(FLAGS INTERNALDATE RFC822.SIZE ENVELOPE
BODY)'</li>
+ * <li>ENVELOPE X-GM-LABELS</li>
* <li>'(INTERNALDATE BODY.PEEK[])' - this is the default</li>
* </ul>
* <p>
+ * Macro names cannot be combined with anything else; they must be used
alone.<br>
+ * Note that using BODY will set the \Seen flag. This is why the default uses
BODY.PEEK[].<br>
+ * The item name X-GM-LABELS is a Google Mail extension; it shows the labels
for a message.<br>
* For example:<br>
* IMAPExportMbox
imaps://username:passw...@imap.googlemail.com/messages_for_export exported.mbox
1:10,20<br>
- * IMAPExportMbox
imaps://username:passw...@imap.googlemail.com/messages_for_export exported.mbox
3 ENVELOPE<br>
+ * IMAPExportMbox
imaps://username:passw...@imap.googlemail.com/messages_for_export exported.mbox
3 ENVELOPE X-GM-LABELS<br>
* <p>
- * Note that the sequence-set is passed unmodified to the FETCH command.
+ * The sequence-set is passed unmodified to the FETCH command.<br>
* The item names are wrapped in parentheses if more than one is provided.
- * Otherwise, the parameter is assumed to be wrapped if necessary.
- * Parameters with spaces must be quoted otherwise the OS shell will normally
treat them as separate parameters.
- * Also the listener that writes the mailbox only captures the multi-line
responses.
- * It does not capture the output from ENVELOPE commands.
+ * Otherwise, the parameter is assumed to be wrapped if necessary.<br>
+ * Parameters with spaces must be quoted otherwise the OS shell will normally
treat them as separate parameters.<br>
+ * Also the listener that writes the mailbox only captures the multi-line
responses (e.g. ones that include BODY references).
+ * It does not capture the output from FETCH commands using item names such as
ENVELOPE or FLAGS that return a single line response.
*/
public final class IMAPExportMbox
{
