Merge pull request #37 from socketlabs/feature/metadata-tags

Feature/metadata tags

Author: david-schrenker

Example Projects/dotNetCoreExample/Examples/Basic/BasicComplexExample.cs

@@ -48,6 +48,22 @@ public SendResponse RunExample()
 
             message.CustomHeaders.Add("x-mycustomheader", "I am a message header");
 
+            var metadata = new List<IMetadata>()
+            {
+                new Metadata("example-type", "basic-send-complex"),
+                new Metadata()
+                {
+                    Key = "message-contains",
+                    Value = "attachments, headers"
+                }
+            };
+            message.Metadata.Add(metadata);
+            message.Metadata.Add("x-mycustommetadata", "I am custom metadata");
+            message.Metadata.Add(new Metadata("testMessageHeader", "I am metadata"));
+
+            message.Tags.Add("Basic-Complex-Example");
+            message.Tags.Add("c#-Example");
+
             var attachment = message.Attachments.Add("bus.png", MimeType.PNG, @".\examples\img\bus.png");
             attachment.ContentId = "Bus";
 

Example Projects/dotNetCoreExample/Examples/Bulk/BulkSendComplexExample.cs

@@ -1,4 +1,5 @@
-using System.Text;
+using System.Collections.Generic;
+using System.Text;
 using System.Text.RegularExpressions;
 using SocketLabs.InjectionApi;
 using SocketLabs.InjectionApi.Message;
@@ -41,7 +42,23 @@ public SendResponse RunExample()
             message.From.Set("from@example.com", "FromMe");
             message.ReplyTo.Email = "replyto@example.com";
 
-            message.CustomHeaders.Add(new CustomHeader("testMessageHeader", "I am a message header"));
+            var metadata = new List<IMetadata>()
+            {
+                new Metadata("example-type", "bulk-send-complex"),
+                new Metadata()
+                {
+                    Key = "message-contains",
+                    Value = "attachments, headers"
+                }
+            };
+            message.Metadata.Add(metadata);
+            message.Metadata.Add("x-mycustommetadata", "I am custom metadata");
+            message.Metadata.Add(new Metadata("testMessageHeader", "I am metadata"));
+
+            message.Metadata.Add("x-mycustommetadata", "I am custom metadata");
+
+            message.Tags.Add("Bulk-Complex-Example");
+            message.Tags.Add("c#-Example");
 
             // Build the Content (Note the %% symbols used to denote the data to be merged)
             var html = new StringBuilder();

Example Projects/dotNetCoreExample/dotNetCoreExample.csproj

@@ -3,7 +3,7 @@
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <TargetFramework>net6.0</TargetFramework>
-    <Copyright>Copyright © 2018-2022 SocketLabs Acquisition LLC</Copyright>
+    <Copyright>Copyright © 2018-2023 SocketLabs Acquisition LLC</Copyright>
   </PropertyGroup>
 
   <ItemGroup>

README.md

@@ -36,7 +36,7 @@ PM> Install-Package SocketLabs.EmailDelivery
 Adding a Package Reference to your project:
 
 ```
-<PackageReference Include="SocketLabs.EmailDelivery" Version="1.2.3" />
+<PackageReference Include="SocketLabs.EmailDelivery" Version="1.4.0" />
 ```
 
 .NET CLI users can also use the following command:

docs/release-notes/latest.md

@@ -1,3 +1,11 @@
 ## 1.3.4
 * Bump Castle.Core from 5.0.0 to 5.1.0
-* Bump Moq from 4.18.1 to 4.18.2 
+* Bump Moq from 4.18.1 to 4.18.2 
+
+## 1.4.0
+* Adding Metadata and Tags
+* Bump coverlet.collector from 3.1.2 to 3.2.0 
+* Bump Newtonsoft.Json from 13.0.1 to 13.0.2 
+* Bump Microsoft.NET.Test.Sdk from 17.2.0 to 17.4.1 
+* Bump MSTest.TestFramework from 2.2.10 to 3.0.2 
+* Bump Moq from 4.18.2 to 4.18.4 

src/SocketLabs/InjectionApi/Core/InjectionRequestFactory.cs

@@ -92,7 +92,9 @@ internal virtual MessageJson GenerateBaseMessageJson(IMessageBase message)
                 CharSet = message.CharSet,
                 CustomHeaders = PopulateCustomHeaders(message.CustomHeaders),
                 From = new AddressJson(message.From.Email, message.From.FriendlyName),
-                Attachments = PopulateList(message.Attachments)
+                Attachments = PopulateList(message.Attachments),
+                Metadata = PopulateMetadata(message.Metadata),
+                Tags = PopulateTags(message.Tags)
             };
 
             if (message.ReplyTo != null)
@@ -192,5 +194,28 @@ internal virtual List<MergeFieldJson> PopulateMergeData(IDictionary<string, stri
             var result = mergeData?.Select(item => new MergeFieldJson(item.Key, item.Value));
             return result?.ToList();
         }
+
+
+        /// <summary>
+        /// Converting a <c><![CDATA[ IList<IMetadata> ]]></c> to a <c><![CDATA[ List<MetadataHeaderJson> ]]></c>
+        /// </summary>
+        /// <param name="metadata">A <c><![CDATA[ IList<IMetadata> ]]></c> from the message</param>
+        /// <returns>A <c><![CDATA[ List<MetadataHeaderJson> ]]></c> used in generating an InjectionRequest</returns>
+        internal virtual List<MetadataHeaderJson> PopulateMetadata(IList<IMetadata> metadata)
+        {
+            var result = metadata?.Select(item => new MetadataHeaderJson(item.Key, item.Value));
+            return result?.ToList();
+        }
+
+        /// <summary>
+        /// Converting a <c><![CDATA[ IList<ICustomHeader> ]]></c> to a <c><![CDATA[ List<CustomHeadersJson> ]]></c>
+        /// </summary>
+        /// <param name="tags">A <c><![CDATA[ IList<ICustomHeader> ]]></c> from the message</param>
+        /// <returns>A <c><![CDATA[ List<CustomHeadersJson> ]]></c> used in generating an InjectionRequest</returns>
+        internal virtual List<string> PopulateTags(IList<string> tags)
+        {
+            var result = tags.ToList();
+            return result?.ToList();
+        }
     }
 }

src/SocketLabs/InjectionApi/Core/SendValidator.cs

@@ -78,6 +78,9 @@ internal virtual SendResult ValidateIMessageBase(IMessageBase message)
             if (message.CustomHeaders != null && message.CustomHeaders.Any())
                 if (!HasValidCustomHeaders(message.CustomHeaders)) return SendResult.MessageValidationInvalidCustomHeaders;
 
+            if (message.Metadata != null && message.Metadata.Any())
+                if (!HasValidMetadata(message.Metadata)) return SendResult.MessageValidationInvalidMetadata;
+
             return SendResult.Success;
         }
 
@@ -334,5 +337,16 @@ internal virtual bool HasValidCustomHeaders(IList<ICustomHeader> customHeaders)
             var result = customHeaders?.Where(item => !item.IsValid);
             return result == null || !result.Any();
         }
+
+        /// <summary>
+        /// Check if <c>IMetadata</c> in List are valid
+        /// </summary>
+        /// <param name="metadata"><c><![CDATA[ IList<IMetadata> ]]></c> to validate</param>
+        /// <returns><c>bool</c> result</returns>
+        internal virtual bool HasValidMetadata(IList<IMetadata> metadata)
+        {
+            var result = metadata?.Where(item => !item.IsValid);
+            return result == null || !result.Any();
+        }
     }
 }

src/SocketLabs/InjectionApi/Core/Serialization/MessageJson.cs

@@ -19,6 +19,8 @@ public MessageJson()
             Bcc = new List<AddressJson>();
             MergeData = new MergeDataJson();
             Attachments = new List<AttachmentJson>();
+            Metadata = new List<MetadataHeaderJson>();
+            Tags = new List<string>();
         }
 
         /// <summary>
@@ -101,6 +103,16 @@ public MessageJson()
         /// Gets or sets the list of merge data.
         /// </summary>
         public MergeDataJson MergeData { get; set; }
+        
+        /// <summary>
+        /// A list of metadata headers added to the message.
+        /// </summary>
+        public List<MetadataHeaderJson> Metadata { get; set; }
+
+        /// <summary>
+        /// A list of tag headers added to the message.
+        /// </summary>
+        public List<string> Tags { get; set; }
 
         #region Conditional Property Serialization
 
@@ -170,5 +182,6 @@ public bool ShouldSerializeAttachment()
         }
 
         #endregion
+
     }
 }

src/SocketLabs/InjectionApi/Core/Serialization/MetadataHeaderJson.cs

@@ -0,0 +1,30 @@
+namespace SocketLabs.InjectionApi.Core.Serialization
+{
+    /// <summary>
+    /// Represents a metadata item as a key and value pair.
+    /// To be serialized into JSON string before sending to the Injection Api.
+    /// </summary>
+    internal class MetadataHeaderJson
+    {
+        /// <summary>
+        /// Creates a new instance of the MetadataHeaderJson class and sets the key and value pair.
+        /// </summary>
+        /// <param name="key">The key of your custom header.</param>
+        /// <param name="value">The value for your custom header.</param>
+        public MetadataHeaderJson(string key, string value)
+        {
+            Key = key;
+            Value = value;
+        }
+
+        /// <summary>
+        /// Gets or sets the metadata key.
+        /// </summary>
+        public string Key { get; set; }
+
+        /// <summary>
+        /// Gets or sets the metadata value.
+        /// </summary>
+        public string Value { get; set; }
+    }
+}

src/SocketLabs/InjectionApi/Message/BasicMessage.cs

@@ -170,6 +170,22 @@ public class BasicMessage : IBasicMessage
         /// </remarks> 
         public IList<ICustomHeader> CustomHeaders { get; set; } = new List<ICustomHeader>();
 
+        /// <summary>
+        /// A list of metadata headers added to the message.
+        /// </summary>
+        /// <remarks>
+        /// (Optional)
+        /// </remarks> 
+        public IList<IMetadata> Metadata { get; set; } = new List<IMetadata>();
+
+        /// <summary>
+        /// A list of tag headers added to the message.
+        /// </summary>
+        /// <remarks>
+        /// (Optional)
+        /// </remarks> 
+        public IList<string> Tags { get; set; } = new List<string>();
+
         /// <summary>
         /// Returns the number of recipients and subject for the message, useful for debugging.
         /// </summary>