Added protocol logger.

Author: CollinAlpert

MailSort.csproj

@@ -5,7 +5,7 @@
         <TargetFramework>net5.0</TargetFramework>
         <Nullable>enable</Nullable>
         <Authors>Collin Alpert</Authors>
-        <Version>1.0.1</Version>
+        <Version>1.0.2</Version>
         <RepositoryUrl>https://github.com/CollinAlpert/MailSort</RepositoryUrl>
         <PackageLicenseUrl>https://github.com/CollinAlpert/MailSort/blob/master/LICENSE</PackageLicenseUrl>
         <Copyright>Copyright © 2021 Collin Alpert</Copyright>

MailSortConfig.cs

@@ -18,5 +18,11 @@ public class MailSortConfig
 
 		[Option('s', "ssl", Required = false, Default = true, HelpText = "Whether or not to connect to the IMAP server securely.")]
 		public bool UseSsl { get; set; }
+
+		[Option('l', "log", Required = false, Default = "imap.log", HelpText = "The file to log the protocol log to.")]
+		public string LogFile { get; set; } = null!;
+		
+		[Option("no-log", Required = false, Default = false, HelpText = "Do not create a log file with the protocol log.")]
+		public bool DontLog { get; set; }
 	}
 }

Program.cs

@@ -59,7 +59,8 @@ private static async Task RunAsync(MailSortConfig config)
 				rules.Where(r => !r.IsCombinationRule)
 					.Select(r => Tuple.Create(BuildPredicate(GetCombinedRules(r, new Queue<MailSortRule>(new[] { r }), rules)), r.TargetFolder)).ToList();
 
-			using var imapClient = new ImapClient();
+			IProtocolLogger logger = config.DontLog ? new NullProtocolLogger() : new ProtocolLogger(config.LogFile);
+			using var imapClient = new ImapClient(logger);
 			await imapClient.ConnectAsync(config.Host, config.UseSsl ? EncryptedImapPort : ImapPort, config.UseSsl).ConfigureAwait(false);
 			await imapClient.AuthenticateAsync(config.Username, config.Password).ConfigureAwait(false);
 

README.md

@@ -19,10 +19,10 @@ Already have .NET 5 installed on the target machine? Even better. Just download
 This tool works by connecting to an IMAP server, going through all the messages in your inbox, checking if they match some criteria and if so, move that message to a folder.\
 The most common usage will probably be to run this tool via a cronjob at certain intervals.\
 Here's an example usage:\
-`./MailSort -h imap.gmail.com -u your@username.com -p very_secure -s -c /path/to/config/file.json`\
+`./MailSort -h imap.gmail.com -u your@username.com -p very_secure -c /path/to/config/file.json`\
 or for more clarity\
-`./MailSort --host imap.gmail.com --username your@username.com --password very_secure --ssl --config /path/to/config/file.json`\
-All of those flags arguments are mandatory, except for the -s/--ssl flag. It specifies whether or not to connect to the IMAP server using SSL (port 993) and is on by default.\
+`./MailSort --host imap.gmail.com --username your@username.com --password very_secure --config /path/to/config/file.json`\
+These are the mandatory arguments. There are a few more, run `./MailSort --help` to get an overview of all the options.
 Please make sure you have the correct credentials to authenticate with the IMAP server. For example, Gmail users will no be able to authenticate with their Google password, they will need to generate and supply an application-specific password.
 
 The config file is a JSON file where you define your rules. Here's an example: