NET-614 IMAP fails to quote/encode mailbox names

sebbASF · sebbASF · commit fb7aae4c64f7 · 2018-10-05T19:36:40.000Z
More commands with mailbox name parameters git-svn-id: https://svn.apache.org/repos/asf/commons/proper/net/trunk@1842972 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/main/java/org/apache/commons/net/imap/IMAP.java b/src/main/java/org/apache/commons/net/imap/IMAP.java
@@ -480,7 +480,7 @@ protected String generateCommandID()
      * @param input the value to be quoted, may be null
      * @return the quoted value
      */
-    static String quoteString(String input) {
+    static String quoteMailboxName(String input) {
         if (input == null) { // Don't throw NPE here
             return null;
         }
diff --git a/src/main/java/org/apache/commons/net/imap/IMAPClient.java b/src/main/java/org/apache/commons/net/imap/IMAPClient.java
@@ -112,7 +112,7 @@ public boolean login(String username, String password) throws IOException
      */
     public boolean select(String mailboxName) throws IOException
     {
-        return doCommand (IMAPCommand.SELECT, mailboxName);
+        return doCommand (IMAPCommand.SELECT, quoteMailboxName(mailboxName));
     }
 
     /**
@@ -123,7 +123,7 @@ public boolean select(String mailboxName) throws IOException
      */
     public boolean examine(String mailboxName) throws IOException
     {
-        return doCommand (IMAPCommand.EXAMINE, mailboxName);
+        return doCommand (IMAPCommand.EXAMINE, quoteMailboxName(mailboxName));
     }
 
     /**
@@ -134,7 +134,7 @@ public boolean examine(String mailboxName) throws IOException
      */
     public boolean create(String mailboxName) throws IOException
     {
-        return doCommand (IMAPCommand.CREATE, mailboxName);
+        return doCommand (IMAPCommand.CREATE, quoteMailboxName(mailboxName));
     }
 
     /**
@@ -145,7 +145,7 @@ public boolean create(String mailboxName) throws IOException
      */
     public boolean delete(String mailboxName) throws IOException
     {
-        return doCommand (IMAPCommand.DELETE, mailboxName);
+        return doCommand (IMAPCommand.DELETE, quoteMailboxName(mailboxName));
     }
 
     /**
@@ -157,7 +157,7 @@ public boolean delete(String mailboxName) throws IOException
      */
     public boolean rename(String oldMailboxName, String newMailboxName) throws IOException
     {
-        return doCommand (IMAPCommand.RENAME, oldMailboxName + " " + newMailboxName);
+        return doCommand (IMAPCommand.RENAME, quoteMailboxName(oldMailboxName) + " " + quoteMailboxName(newMailboxName));
     }
 
     /**
@@ -168,7 +168,7 @@ public boolean rename(String oldMailboxName, String newMailboxName) throws IOExc
      */
     public boolean subscribe(String mailboxName) throws IOException
     {
-        return doCommand (IMAPCommand.SUBSCRIBE, mailboxName);
+        return doCommand (IMAPCommand.SUBSCRIBE, quoteMailboxName(mailboxName));
     }
 
     /**
@@ -179,7 +179,7 @@ public boolean subscribe(String mailboxName) throws IOException
      */
     public boolean unsubscribe(String mailboxName) throws IOException
     {
-        return doCommand (IMAPCommand.UNSUBSCRIBE, mailboxName);
+        return doCommand (IMAPCommand.UNSUBSCRIBE, quoteMailboxName(mailboxName));
     }
 
     /**
@@ -196,7 +196,7 @@ public boolean unsubscribe(String mailboxName) throws IOException
      */
     public boolean list(String refName, String mailboxName) throws IOException
     {
-        return doCommand (IMAPCommand.LIST, quoteString(refName) + " " + quoteString(mailboxName));
+        return doCommand (IMAPCommand.LIST, quoteMailboxName(refName) + " " + quoteMailboxName(mailboxName));
     }
 
     /**
@@ -209,7 +209,7 @@ public boolean list(String refName, String mailboxName) throws IOException
      */
     public boolean lsub(String refName, String mailboxName) throws IOException
     {
-        return doCommand (IMAPCommand.LSUB, quoteString(refName) + " " + quoteString(mailboxName));
+        return doCommand (IMAPCommand.LSUB, quoteMailboxName(refName) + " " + quoteMailboxName(mailboxName));
     }
 
     /**
@@ -226,7 +226,7 @@ public boolean status(String mailboxName, String[] itemNames) throws IOException
         }
 
         StringBuilder sb = new StringBuilder();
-        sb.append(mailboxName);
+        sb.append(quoteMailboxName(mailboxName));
 
         sb.append(" (");
         for ( int i = 0; i < itemNames.length; i++ )
@@ -253,7 +253,7 @@ public boolean status(String mailboxName, String[] itemNames) throws IOException
      */
     public boolean append(String mailboxName, String flags, String datetime, String message) throws IOException
     {
-        StringBuilder args = new StringBuilder(mailboxName);
+        StringBuilder args = new StringBuilder(quoteMailboxName(mailboxName));
         if (flags != null) {
             args.append(" ").append(flags);
         }
@@ -417,7 +417,7 @@ public boolean store(String sequenceSet, String itemNames, String itemValues)
      */
     public boolean copy(String sequenceSet, String mailboxName) throws IOException
     {
-        return doCommand (IMAPCommand.COPY, sequenceSet + " " + mailboxName);
+        return doCommand (IMAPCommand.COPY, sequenceSet + " " + quoteMailboxName(mailboxName));
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -480,7 +480,7 @@ protected String generateCommandID()`
`480`	`480`	`* @param input the value to be quoted, may be null`
`481`	`481`	`* @return the quoted value`
`482`	`482`	`*/`
`483`		`- static String quoteString(String input) {`
	`483`	`+ static String quoteMailboxName(String input) {`
`484`	`484`	`if (input == null) { // Don't throw NPE here`
`485`	`485`	`return null;`
`486`	`486`	`}`
Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,7 @@ public boolean login(String username, String password) throws IOException`
`112`	`112`	`*/`
`113`	`113`	`public boolean select(String mailboxName) throws IOException`
`114`	`114`	`{`
`115`		`- return doCommand (IMAPCommand.SELECT, mailboxName);`
	`115`	`+ return doCommand (IMAPCommand.SELECT, quoteMailboxName(mailboxName));`
`116`	`116`	`}`
`117`	`117`
`118`	`118`	`/**`
`@@ -123,7 +123,7 @@ public boolean select(String mailboxName) throws IOException`
`123`	`123`	`*/`
`124`	`124`	`public boolean examine(String mailboxName) throws IOException`
`125`	`125`	`{`
`126`		`- return doCommand (IMAPCommand.EXAMINE, mailboxName);`
	`126`	`+ return doCommand (IMAPCommand.EXAMINE, quoteMailboxName(mailboxName));`
`127`	`127`	`}`
`128`	`128`
`129`	`129`	`/**`
`@@ -134,7 +134,7 @@ public boolean examine(String mailboxName) throws IOException`
`134`	`134`	`*/`
`135`	`135`	`public boolean create(String mailboxName) throws IOException`
`136`	`136`	`{`
`137`		`- return doCommand (IMAPCommand.CREATE, mailboxName);`
	`137`	`+ return doCommand (IMAPCommand.CREATE, quoteMailboxName(mailboxName));`
`138`	`138`	`}`
`139`	`139`
`140`	`140`	`/**`
`@@ -145,7 +145,7 @@ public boolean create(String mailboxName) throws IOException`
`145`	`145`	`*/`
`146`	`146`	`public boolean delete(String mailboxName) throws IOException`
`147`	`147`	`{`
`148`		`- return doCommand (IMAPCommand.DELETE, mailboxName);`
	`148`	`+ return doCommand (IMAPCommand.DELETE, quoteMailboxName(mailboxName));`
`149`	`149`	`}`
`150`	`150`
`151`	`151`	`/**`
`@@ -157,7 +157,7 @@ public boolean delete(String mailboxName) throws IOException`
`157`	`157`	`*/`
`158`	`158`	`public boolean rename(String oldMailboxName, String newMailboxName) throws IOException`
`159`	`159`	`{`
`160`		`- return doCommand (IMAPCommand.RENAME, oldMailboxName + " " + newMailboxName);`
	`160`	`+ return doCommand (IMAPCommand.RENAME, quoteMailboxName(oldMailboxName) + " " + quoteMailboxName(newMailboxName));`
`161`	`161`	`}`
`162`	`162`
`163`	`163`	`/**`
`@@ -168,7 +168,7 @@ public boolean rename(String oldMailboxName, String newMailboxName) throws IOExc`
`168`	`168`	`*/`
`169`	`169`	`public boolean subscribe(String mailboxName) throws IOException`
`170`	`170`	`{`
`171`		`- return doCommand (IMAPCommand.SUBSCRIBE, mailboxName);`
	`171`	`+ return doCommand (IMAPCommand.SUBSCRIBE, quoteMailboxName(mailboxName));`
`172`	`172`	`}`
`173`	`173`
`174`	`174`	`/**`
`@@ -179,7 +179,7 @@ public boolean subscribe(String mailboxName) throws IOException`
`179`	`179`	`*/`
`180`	`180`	`public boolean unsubscribe(String mailboxName) throws IOException`
`181`	`181`	`{`
`182`		`- return doCommand (IMAPCommand.UNSUBSCRIBE, mailboxName);`
	`182`	`+ return doCommand (IMAPCommand.UNSUBSCRIBE, quoteMailboxName(mailboxName));`
`183`	`183`	`}`
`184`	`184`
`185`	`185`	`/**`
`@@ -196,7 +196,7 @@ public boolean unsubscribe(String mailboxName) throws IOException`
`196`	`196`	`*/`
`197`	`197`	`public boolean list(String refName, String mailboxName) throws IOException`
`198`	`198`	`{`
`199`		`- return doCommand (IMAPCommand.LIST, quoteString(refName) + " " + quoteString(mailboxName));`
	`199`	`+ return doCommand (IMAPCommand.LIST, quoteMailboxName(refName) + " " + quoteMailboxName(mailboxName));`
`200`	`200`	`}`
`201`	`201`
`202`	`202`	`/**`
`@@ -209,7 +209,7 @@ public boolean list(String refName, String mailboxName) throws IOException`
`209`	`209`	`*/`
`210`	`210`	`public boolean lsub(String refName, String mailboxName) throws IOException`
`211`	`211`	`{`
`212`		`- return doCommand (IMAPCommand.LSUB, quoteString(refName) + " " + quoteString(mailboxName));`
	`212`	`+ return doCommand (IMAPCommand.LSUB, quoteMailboxName(refName) + " " + quoteMailboxName(mailboxName));`
`213`	`213`	`}`
`214`	`214`
`215`	`215`	`/**`
`@@ -226,7 +226,7 @@ public boolean status(String mailboxName, String[] itemNames) throws IOException`
`226`	`226`	`}`
`227`	`227`
`228`	`228`	`StringBuilder sb = new StringBuilder();`
`229`		`- sb.append(mailboxName);`
	`229`	`+ sb.append(quoteMailboxName(mailboxName));`
`230`	`230`
`231`	`231`	`sb.append(" (");`
`232`	`232`	`for ( int i = 0; i < itemNames.length; i++ )`
`@@ -253,7 +253,7 @@ public boolean status(String mailboxName, String[] itemNames) throws IOException`
`253`	`253`	`*/`
`254`	`254`	`public boolean append(String mailboxName, String flags, String datetime, String message) throws IOException`
`255`	`255`	`{`
`256`		`- StringBuilder args = new StringBuilder(mailboxName);`
	`256`	`+ StringBuilder args = new StringBuilder(quoteMailboxName(mailboxName));`
`257`	`257`	`if (flags != null) {`
`258`	`258`	`args.append(" ").append(flags);`
`259`	`259`	`}`
`@@ -417,7 +417,7 @@ public boolean store(String sequenceSet, String itemNames, String itemValues)`
`417`	`417`	`*/`
`418`	`418`	`public boolean copy(String sequenceSet, String mailboxName) throws IOException`
`419`	`419`	`{`
`420`		`- return doCommand (IMAPCommand.COPY, sequenceSet + " " + mailboxName);`
	`420`	`+ return doCommand (IMAPCommand.COPY, sequenceSet + " " + quoteMailboxName(mailboxName));`
`421`	`421`	`}`
`422`	`422`
`423`	`423`	`/**`