Add avatar preference tag

markvantilburg · Dec 29, 2024 · 23f68da · 23f68da
1 parent 64315ab
commit 23f68da
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 0 deletions.
diff --git a/BusinessMonitor.MailTools.Test/BimiTests.cs b/BusinessMonitor.MailTools.Test/BimiTests.cs
@@ -30,6 +30,25 @@ public void TestParse()
             Assert.That(record3, Is.Not.Null);
         }
 
+        [Test]
+        public void TestAvatar()
+        {
+            var record = BimiCheck.ParseBimiRecord("v=BIMI1; l=https://example.com/logo.svg; s=personal");
+
+            Assert.That(record, Is.Not.Null);
+            Assert.That(record.AvatarPreference, Is.EqualTo(AvatarPreference.Personal));
+
+            var record2 = BimiCheck.ParseBimiRecord("v=BIMI1; l=https://example.com/logo.svg; s=bimi");
+
+            Assert.That(record2, Is.Not.Null);
+            Assert.That(record2.AvatarPreference, Is.EqualTo(AvatarPreference.Bimi));
+
+            var record3 = BimiCheck.ParseBimiRecord("v=BIMI1; l=https://example.com/logo.svg");
+
+            Assert.That(record3, Is.Not.Null);
+            Assert.That(record3.AvatarPreference, Is.EqualTo(AvatarPreference.Bimi));
+        }
+
         [Test]
         public void TestLookup()
         {
@@ -48,6 +67,7 @@ public void TestLookup()
         [TestCase("v=BIMI1; l=invalidlink")]
         [TestCase("v=BIMI1; a=invalidlink l=https://businessmonitor.nl/logo.svg")]
         [TestCase("v=BIMI1; l=http://nothttpstransport")]
+        [TestCase("v=BIMI1; l=https://example.com/logo.svg; s=invalid")]
         public void TestInvalid(string value)
         {
             Assert.Throws<BimiInvalidException>(() =>

diff --git a/BusinessMonitor.MailTools/Bimi/AvatarPreference.cs b/BusinessMonitor.MailTools/Bimi/AvatarPreference.cs
@@ -0,0 +1,8 @@
+namespace BusinessMonitor.MailTools.Bimi
+{
+    public enum AvatarPreference
+    {
+        Personal,
+        Bimi
+    }
+}
diff --git a/BusinessMonitor.MailTools/Bimi/BimiCheck.cs b/BusinessMonitor.MailTools/Bimi/BimiCheck.cs
@@ -110,6 +110,12 @@ public static BimiRecord ParseBimiRecord(string value)
                         ValidateUri(val, "location");
                         record.Location = val;
 
+                        break;
+
+                    // Avatar Preference
+                    case "s":
+                        record.AvatarPreference = GetAvatarPreference(val);
+
                         break;
                 }
             }
@@ -148,5 +154,15 @@ private static void ValidateUri(string value, string type)
                 throw new BimiInvalidException($"BIMI record {type} is invalid, transport must be HTTPS");
             }
         }
+
+        private static AvatarPreference GetAvatarPreference(string value)
+        {
+            if (value != "personal" && value != "bimi")
+            {
+                throw new BimiInvalidException("Invalid avatar preference, must be personal or bimi");
+            }
+
+            return value == "personal" ? AvatarPreference.Personal : AvatarPreference.Bimi;
+        }
     }
 }
diff --git a/BusinessMonitor.MailTools/Bimi/BimiRecord.cs b/BusinessMonitor.MailTools/Bimi/BimiRecord.cs
@@ -9,6 +9,7 @@ internal BimiRecord()
         {
             Evidence = "";
             Location = null;
+            AvatarPreference = AvatarPreference.Bimi;
         }
 
         /// <summary>
@@ -20,5 +21,10 @@ internal BimiRecord()
         /// Gets the location of the Brand Indicator file
         /// </summary>
         public string? Location { get; internal set; }
+
+        /// <summary>
+        /// Gets the avatar preference
+        /// </summary>
+        public AvatarPreference AvatarPreference { get; internal set; }
     }
 }