diff options
| -rwxr-xr-x | SendGrid/SendGridMail/IHeader.cs | 50 |
1 files changed, 49 insertions, 1 deletions
diff --git a/SendGrid/SendGridMail/IHeader.cs b/SendGrid/SendGridMail/IHeader.cs index a9464ed..f55eadd 100755 --- a/SendGrid/SendGridMail/IHeader.cs +++ b/SendGrid/SendGridMail/IHeader.cs @@ -6,16 +6,64 @@ using System.Text; namespace SendGridMail
{
+ /// <summary>
+ /// Represents the additional functionality to add SendGrid specific mail headers
+ /// </summary>
public interface IHeader
{
- void AddTo(IEnumerable<String> recipients);
+ /// <summary>
+ /// This adds a substitution value to be used during the mail merge. Substitutions
+ /// will happen in order added, so calls to this should match calls to addTo in the mail message.
+ /// </summary>
+ /// <param name="tag">string to be replaced in the message</param>
+ /// <param name="substitutions">substitutions to be made, one per recipient</param>
void AddSubVal(String tag, IEnumerable<String> substitutions);
+
+ /// <summary>
+ /// This adds parameters and values that will be bassed back through SendGrid's
+ /// Event API if an event notification is triggered by this email.
+ /// </summary>
+ /// <param name="identifiers">parameter value pairs to be passed back on event notification</param>
void AddUniqueIdentifier(IDictionary<String, String> identifiers);
+
+ /// <summary>
+ /// This sets the category for this email. Statistics are stored on a per category
+ /// basis, so this can be useful for tracking on a per group basis.
+ /// </summary>
+ /// <param name="category">categories applied to the message</param>
void SetCategory(String category);
+
+ /// <summary>
+ /// Shortcut method for enabling a filter.
+ /// </summary>
+ /// <param name="filter">The name of the filter to enable</param>
void Enable(String filter);
+
+ /// <summary>
+ /// Shortcut method for disabling a filter.
+ /// </summary>
+ /// <param name="filter">The name of the filter to disable</param>
void Disable(String filter);
+
+ /// <summary>
+ /// Allows you to specify a filter setting. You can find a list of filters and settings here:
+ /// http://docs.sendgrid.com/documentation/api/web-api/filtersettings/
+ /// </summary>
+ /// <param name="filter">The name of the filter to set</param>
+ /// <param name="settings">The multipart name of the parameter being set</param>
+ /// <param name="value">The value that the settings name will be assigning</param>
void AddFilterSetting(String filter, IEnumerable<String> settings, String value);
+
+ /// <summary>
+ /// Attaches the SendGrid headers to the MIME.
+ /// </summary>
+ /// <param name="mime">the MIME to which we are attaching</param>
void AddHeader(MailMessage mime);
+
+ /// <summary>
+ /// Converts the filter settings into a JSON string.
+ /// </summary>
+ /// <returns>String representation of the SendGrid headers</returns>
String AsJson();
}
}
|