Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Fix StyleCop warnings #936

Merged
merged 2 commits into from
Feb 19, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions src/SendGrid/Helpers/Mail/MailHelper.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
namespace SendGrid.Helpers.Mail
{
/// <summary>
/// Simplified email sending for common use cases
/// Simplified email sending for common use cases.
/// </summary>
public class MailHelper
{
Expand All @@ -21,7 +21,7 @@ public class MailHelper
RegexOptions.ECMAScript);

/// <summary>
/// Send a single simple email
/// Send a single simple email.
/// </summary>
/// <param name="from">An email object that may contain the recipient’s name, but must always contain the sender’s email.</param>
/// <param name="to">An email object that may contain the recipient’s name, but must always contain the recipient’s email.</param>
Expand Down Expand Up @@ -54,7 +54,7 @@ public static SendGridMessage CreateSingleEmail(
}

/// <summary>
/// Send a single dynamic template email
/// Send a single dynamic template email.
/// </summary>
/// <param name="from">An email object that may contain the recipient’s name, but must always contain the sender’s email.</param>
/// <param name="to">An email object that may contain the recipient’s name, but must always contain the recipient’s email.</param>
Expand Down Expand Up @@ -86,7 +86,7 @@ public static SendGridMessage CreateSingleTemplateEmail(
}

/// <summary>
/// Send a single simple email to multiple recipients
/// Send a single simple email to multiple recipients.
/// </summary>
/// <param name="from">An email object that may contain the recipient’s name, but must always contain the sender’s email.</param>
/// <param name="tos">A list of email objects that may contain the recipient’s name, but must always contain the recipient’s email.</param>
Expand Down Expand Up @@ -123,7 +123,7 @@ public static SendGridMessage CreateSingleEmailToMultipleRecipients(
}

/// <summary>
/// Send a single simple email to multiple recipients
/// Send a single simple email to multiple recipients.
/// </summary>
/// <param name="from">An email object that may contain the recipient’s name, but must always contain the sender’s email.</param>
/// <param name="tos">A list of email objects that may contain the recipient’s name, but must always contain the recipient’s email.</param>
Expand Down Expand Up @@ -239,10 +239,10 @@ public static SendGridMessage CreateMultipleTemplateEmailsToMultipleRecipients(
}

/// <summary>
/// Uncomplex conversion of a <![CDATA["Name <email@email.com>"]]> to EmailAddress
/// Uncomplex conversion of a <![CDATA["Name <email@email.com>"]]> to EmailAddress.
/// </summary>
/// <param name="rfc2822Email">"email@email.com" or <![CDATA["Name <email@email.com>"]]> string</param>
/// <returns>EmailsAddress Object</returns>
/// <param name="rfc2822Email">"email@email.com" or <![CDATA["Name <email@email.com>"]]> string.</param>
/// <returns>EmailsAddress Object.</returns>
public static EmailAddress StringToEmailAddress(string rfc2822Email)
{
var match = Rfc2822Regex.Match(rfc2822Email);
Expand All @@ -257,14 +257,14 @@ public static EmailAddress StringToEmailAddress(string rfc2822Email)
}

/// <summary>
/// Send a single simple email to multiple recipients with option for displaying all the recipients present in "To" section of email
/// Send a single simple email to multiple recipients with option for displaying all the recipients present in "To" section of email.
/// </summary>
/// <param name="from">An email object that may contain the recipient’s name, but must always contain the sender’s email.</param>
/// <param name="tos">A list of email objects that may contain the recipient’s name, but must always contain the recipient’s email.</param>
/// <param name="subject">The subject of your email. This may be overridden by SetGlobalSubject().</param>
/// <param name="plainTextContent">The text/plain content of the email body.</param>
/// <param name="htmlContent">The text/html content of the email body.</param>
/// <param name="showAllRecipients">Displays all the recipients present in the "To" section of email.The default value is false</param>
/// <param name="showAllRecipients">Displays all the recipients present in the "To" section of email.The default value is false.</param>
/// <returns>A SendGridMessage object.</returns>
public static SendGridMessage CreateSingleEmailToMultipleRecipients(
EmailAddress from,
Expand Down
2 changes: 1 addition & 1 deletion src/SendGrid/Helpers/Mail/Model/ASM.cs
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public class ASM

/// <summary>
/// Gets or sets an array containing the unsubscribe groups that you would like to be displayed on the unsubscribe preferences page.
/// https://sendgrid.com/docs/User_Guide/Suppressions/recipient_subscription_preferences.html
/// https://sendgrid.com/docs/User_Guide/Suppressions/recipient_subscription_preferences.html.
/// </summary>
[JsonProperty(PropertyName = "groups_to_display", IsReference = false)]
public List<int> GroupsToDisplay { get; set; }
Expand Down
2 changes: 1 addition & 1 deletion src/SendGrid/Helpers/Mail/Model/Attachment.cs
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public class Attachment
public string Disposition { get; set; }

/// <summary>
/// Gets or sets a unique id that you specify for the attachment. This is used when the disposition is set to "inline" and the attachment is an image, allowing the file to be displayed within the body of your email. Ex: <img src="cid:ii_139db99fdb5c3704"></img>
/// Gets or sets a unique id that you specify for the attachment. This is used when the disposition is set to "inline" and the attachment is an image, allowing the file to be displayed within the body of your email. Ex: <img src="cid:ii_139db99fdb5c3704"></img>.
/// </summary>
[JsonProperty(PropertyName = "content_id")]
public string ContentId { get; set; }
Expand Down
2 changes: 1 addition & 1 deletion src/SendGrid/Helpers/Mail/Model/Content.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
namespace SendGrid.Helpers.Mail
{
/// <summary>
/// Specifies the content of your email. You can include multiple mime types of content, but you must specify at least one. To include more than one mime type, simply add another object to the array containing the type and value parameters. If included, text/plain and text/html must be the first indices of the array in this order. If you choose to include the text/plain or text/html mime types, they must be the first indices of the content array in the order text/plain, text/html.*Content is NOT mandatory if you using a transactional template and have defined the template_id in the Request
/// Specifies the content of your email. You can include multiple mime types of content, but you must specify at least one. To include more than one mime type, simply add another object to the array containing the type and value parameters. If included, text/plain and text/html must be the first indices of the array in this order. If you choose to include the text/plain or text/html mime types, they must be the first indices of the content array in the order text/plain, text/html.*Content is NOT mandatory if you using a transactional template and have defined the template_id in the Request.
/// </summary>
[JsonObject(IsReference = false)]
public class Content
Expand Down
4 changes: 2 additions & 2 deletions src/SendGrid/Helpers/Mail/Model/Ganalytics.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ public class Ganalytics
public bool? Enable { get; set; }

/// <summary>
/// Gets or sets the name of the referrer source. (e.g. Google, SomeDomain.com, or Marketing Email)
/// Gets or sets the name of the referrer source (e.g. Google, SomeDomain.com, or Marketing Email).
/// </summary>
[JsonProperty(PropertyName = "utm_source")]
public string UtmSource { get; set; }

/// <summary>
/// Gets or sets the name of the marketing medium. (e.g. Email)
/// Gets or sets the name of the marketing medium (e.g. Email).
/// </summary>
[JsonProperty(PropertyName = "utm_medium")]
public string UtmMedium { get; set; }
Expand Down
2 changes: 1 addition & 1 deletion src/SendGrid/Helpers/Mail/Model/HtmlContent.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
namespace SendGrid.Helpers.Mail.Model
{
/// <summary>
/// Helper class for plain html mime types
/// Helper class for plain html mime types.
/// </summary>
[JsonObject(IsReference = false)]
public class HtmlContent : Content
Expand Down
2 changes: 1 addition & 1 deletion src/SendGrid/Helpers/Mail/Model/MailSettings.cs
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public class MailSettings

/// <summary>
/// Gets or sets the ability to send a test email to ensure that your request body is valid and formatted correctly. For more information, please see our Classroom.
/// https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/sandbox_mode.html
/// https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/sandbox_mode.html.
/// </summary>
[JsonProperty(PropertyName = "sandbox_mode")]
public SandboxMode SandboxMode { get; set; }
Expand Down
2 changes: 1 addition & 1 deletion src/SendGrid/Helpers/Mail/Model/Personalization.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ namespace SendGrid.Helpers.Mail
{
/// <summary>
/// An array of messages and their metadata. Each object within personalizations can be thought of as an envelope - it defines who should receive an individual message and how that message should be handled. For more information, please see our documentation on Personalizations. Parameters in personalizations will override the parameters of the same name from the message level.
/// https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/personalizations.html
/// https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/personalizations.html.
/// </summary>
[JsonObject(IsReference = false)]
public class Personalization
Expand Down
2 changes: 1 addition & 1 deletion src/SendGrid/Helpers/Mail/Model/PlainTextContent.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
namespace SendGrid.Helpers.Mail.Model
{
/// <summary>
/// Helper class for plain text mime types
/// Helper class for plain text mime types.
/// </summary>
public class PlainTextContent : Content
{
Expand Down
2 changes: 1 addition & 1 deletion src/SendGrid/Helpers/Mail/Model/SandboxMode.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ namespace SendGrid.Helpers.Mail
{
/// <summary>
/// This allows you to send a test email to ensure that your request body is valid and formatted correctly. For more information, please see our Classroom.
/// https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/sandbox_mode.html
/// https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/sandbox_mode.html.
/// </summary>
[JsonObject(IsReference = false)]
public class SandboxMode
Expand Down
4 changes: 2 additions & 2 deletions src/SendGrid/Helpers/Mail/Model/SubscriptionTracking.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ public class SubscriptionTracking
public bool Enable { get; set; }

/// <summary>
/// Gets or sets the text to be appended to the email, with the subscription tracking link. You may control where the link is by using the tag (percent symbol) (percent symbol)
/// Gets or sets the text to be appended to the email, with the subscription tracking link. You may control where the link is by using the tag (percent symbol) (percent symbol).
/// </summary>
[JsonProperty(PropertyName = "text")]
public string Text { get; set; }

/// <summary>
/// Gets or sets the HTML to be appended to the email, with the subscription tracking link. You may control where the link is by using the tag (percent symbol) (percent symbol)
/// Gets or sets the HTML to be appended to the email, with the subscription tracking link. You may control where the link is by using the tag (percent symbol) (percent symbol).
/// </summary>
[JsonProperty(PropertyName = "html")]
public string Html { get; set; }
Expand Down
Loading