Adding Metadata and Tags to Message

Author: david-schrenker

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>

src/SocketLabs/InjectionApi/Message/BulkMessage.cs

@@ -167,6 +167,22 @@ public class BulkMessage : IBulkMessage
         /// </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>

src/SocketLabs/InjectionApi/Message/IMessageBase.cs

@@ -108,5 +108,22 @@ public interface IMessageBase
         /// (Optional)
         /// </remarks> 
         IList<ICustomHeader> CustomHeaders { get; set; }
+
+
+        /// <summary>
+        /// A list of metadata headers added to the message.
+        /// </summary>
+        /// <remarks>
+        /// (Optional)
+        /// </remarks> 
+        IList<IMetadata> Metadata { get; set; }
+
+        /// <summary>
+        /// A list of tag headers added to the message.
+        /// </summary>
+        /// <remarks>
+        /// (Optional)
+        /// </remarks> 
+        IList<string> Tags { get; set; }
     }
 }

src/SocketLabs/InjectionApi/Message/IMetadata.cs

@@ -0,0 +1,35 @@
+namespace SocketLabs.InjectionApi.Message
+{
+
+    /// <summary>
+    /// Represents a metadata header as a name and value pair.
+    /// </summary>
+    /// <example>
+    /// Using extension methods
+    /// <code>
+    /// var metadata = new <![CDATA[ List<IMetadata> ]]>();
+    /// metadata.Add("name1", "value1");
+    /// metadata.Add("name2", "value2");
+    /// </code>
+    /// </example>
+    /// <seealso cref="Metadata"/>
+    /// <seealso cref="SocketLabsExtensions"/>
+    public interface IMetadata
+    {
+        /// <summary>
+        /// Gets or sets the metadata header name.
+        /// </summary>
+        string Name { get; set; }
+
+        /// <summary>
+        /// Gets or sets the metadata header value.
+        /// </summary>
+        string Value { get; set; }
+
+        /// <summary>
+        /// A quick check to ensure that the metadata header is valid.
+        /// </summary>
+        bool IsValid { get; }
+    }
+
+}

src/SocketLabs/InjectionApi/Message/Metadata.cs

@@ -0,0 +1,78 @@
+namespace SocketLabs.InjectionApi.Message
+{
+    /// <summary>
+    /// Represents a metadata header as a name and value pair.
+    /// </summary>
+    /// <example>
+    /// Using the constructors
+    /// <code>
+    /// var metadata1 = new Metadata();
+    /// metadata1.Name = "name1";
+    /// metadata1.Value = "value1";
+    ///
+    /// var metadata2 = new Metadata("name1", "value1");
+    /// </code>
+    /// Using extension methods
+    /// <code>
+    /// var metadata = new <![CDATA[ List<IMetadata> ]]>();
+    /// metadata.Add("name1", "value1");
+    /// metadata.Add("name2", "value2");
+    /// </code>
+    /// </example>
+    /// <seealso cref="IMetadata"/>
+    /// <seealso cref="SocketLabsExtensions"/>
+    public class Metadata : IMetadata
+    {
+        /// <summary>
+        /// Creates a new instance of the Metadata class.
+        /// </summary>
+        /// <example>
+        /// <code>
+        /// var metadata = new Metadata();
+        /// metadata.Name = "name1";
+        /// metadata.Value = "value1";
+        /// </code>
+        /// </example>
+        public Metadata() { }
+
+        /// <summary>
+        /// Creates a new instance of the Metadata class and sets the name and value pair.
+        /// </summary>
+        /// <param name="name">The name of your metadata header.</param>
+        /// <param name="value">The value for your metadata header.</param>
+        /// <example>
+        /// <code>
+        /// var metadata = new Metadata("name1", "value1");
+        /// </code>
+        /// </example>
+        public Metadata(string name, string value)
+        {
+            Name = name;
+            Value = value;
+        }
+
+        /// <summary>
+        /// Gets or sets the metadata header name.
+        /// </summary>
+        public string Name { get; set; }
+
+        /// <summary>
+        /// Gets or sets the metadata header value.
+        /// </summary>
+        public string Value { get; set; }
+
+        /// <summary>
+        /// A quick check to ensure that the metadata header is valid.
+        /// </summary>
+        public bool IsValid => !(string.IsNullOrEmpty(Value) || string.IsNullOrEmpty(Name));
+
+        /// <summary>
+        /// Returns the metadata header as a name-value pair, useful for debugging.
+        /// </summary>
+        /// <returns></returns>
+        public override string ToString()
+        {
+            return $"{Name ?? "null"}: {Value ?? "null"}";
+        }
+    }
+}