Added a quirks mode for ProtonMail

Fixes issue #674
jstedfast · Mar 13, 2018 · 5b6032d · 5b6032d
1 parent e8c7027
commit 5b6032d
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 20 deletions.
diff --git a/MailKit/Net/Imap/ImapEngine.cs b/MailKit/Net/Imap/ImapEngine.cs
@@ -92,6 +92,11 @@ enum ImapUntaggedResult {
 		Handled
 	}
 
+	enum ImapQuirksMode {
+		None,
+		ProtonMail
+	}
+
 	class ImapFolderNameComparer : IEqualityComparer<string>
 	{
 		public char DirectorySeparator;
@@ -132,6 +137,7 @@ class ImapEngine : IDisposable
 		internal readonly Dictionary<string, ImapFolder> FolderCache;
 		readonly CreateImapFolderDelegate createImapFolder;
 		readonly ImapFolderNameComparer cacheComparer;
+		internal ImapQuirksMode QuirksMode;
 		readonly List<ImapCommand> queue;
 		internal char TagPrefix;
 		ImapCommand current;
@@ -169,6 +175,7 @@ public ImapEngine (CreateImapFolderDelegate createImapFolderDelegate)
 			ProtocolVersion = ImapProtocolVersion.Unknown;
 			createImapFolder = createImapFolderDelegate;
 			Capabilities = ImapCapabilities.None;
+			QuirksMode = ImapQuirksMode.None;
 			queue = new List<ImapCommand> ();
 		}
 
@@ -561,6 +568,7 @@ public async Task ConnectAsync (ImapStream stream, bool doAsync, CancellationTok
 			Rights.Clear ();
 
 			State = ImapEngineState.Connected;
+			QuirksMode = ImapQuirksMode.None;
 			SupportedCharsets.Add ("UTF-8");
 			CapabilitiesVersion = 0;
 			QResyncEnabled = false;
@@ -605,7 +613,10 @@ public async Task ConnectAsync (ImapStream stream, bool doAsync, CancellationTok
 						OnAlert (code.Message);
 				} else if (token.Type != ImapTokenType.Eoln) {
 					// throw away any remaining text up until the end of the line
-					await ReadLineAsync (doAsync, cancellationToken).ConfigureAwait (false);
+					var line = await ReadLineAsync (doAsync, cancellationToken).ConfigureAwait (false);
+
+					if (line.IndexOf ("ProtonMail", StringComparison.OrdinalIgnoreCase) != -1)
+						QuirksMode = ImapQuirksMode.ProtonMail;
 				}
 			} catch {
 				Disconnect ();
@@ -2252,30 +2263,20 @@ public async Task QuerySpecialFoldersAsync (bool doAsync, CancellationToken canc
 			list.Clear ();
 
 			if ((Capabilities & ImapCapabilities.SpecialUse) != 0) {
-				ic = new ImapCommand (this, cancellationToken, null, "LIST (SPECIAL-USE) \"\" \"*\"\r\n");
+				// Note: Some IMAP servers like ProtonMail respond to SPECIAL-USE LIST queries with BAD, so fall
+				// back to just issuing a standard LIST command and hope we get back some SPECIAL-USE attributes.
+				//
+				// See https://github.com/jstedfast/MailKit/issues/674 for dertails.
+				if (QuirksMode != ImapQuirksMode.ProtonMail)
+					ic = new ImapCommand (this, cancellationToken, null, "LIST (SPECIAL-USE) \"\" \"*\"\r\n");
+				else
+					ic = new ImapCommand (this, cancellationToken, null, "LIST \"\" \"%%\"\r\n");
 				ic.RegisterUntaggedHandler ("LIST", ImapUtils.ParseFolderListAsync);
 				ic.UserData = list;
 
 				QueueCommand (ic);
 
-				try {
-					await RunAsync (ic, doAsync).ConfigureAwait (false);
-				} catch (ImapCommandException) {
-					// Note: Some IMAP servers like ProtonMail respond to SPECIAL-USE LIST queries with BAD, so fall
-					// back to just issuing a standard LIST command and hope we get back some SPECIAL-USE attributes.
-					//
-					// See https://github.com/jstedfast/MailKit/issues/674 for dertails.
-					ic = new ImapCommand (this, cancellationToken, null, "LIST \"\" \"%\"\r\n");
-					ic.RegisterUntaggedHandler ("LIST", ImapUtils.ParseFolderListAsync);
-					ic.UserData = list;
-
-					list.Clear ();
-
-					QueueCommand (ic);
-
-					await RunAsync (ic, doAsync).ConfigureAwait (false);
-				}
-
+				await RunAsync (ic, doAsync).ConfigureAwait (false);
 				await LookupParentFoldersAsync (list, doAsync, cancellationToken).ConfigureAwait (false);
 
 				AssignSpecialFolders (list);

diff --git a/MailKit/Net/Imap/ImapUtils.cs b/MailKit/Net/Imap/ImapUtils.cs
@@ -443,10 +443,12 @@ public static async Task ParseFolderListAsync (ImapEngine engine, ImapCommand ic
 			switch (token.Type) {
 			case ImapTokenType.Literal:
 				encodedName = await engine.ReadLiteralAsync (doAsync, ic.CancellationToken).ConfigureAwait (false);
+				encodedName.TrimEnd (delim);
 				break;
 			case ImapTokenType.QString:
 			case ImapTokenType.Atom:
 				encodedName = (string) token.Value;
+				encodedName.TrimEnd (delim);
 				break;
 			case ImapTokenType.Nil:
 				// Note: according to rfc3501, section 4.5, NIL is acceptable as a mailbox name.