Search code examples
htmlasp.netemailwebformssystem.net.mail

Correct Syntax for Generating HTML Email using AlternateView


I'm trying to use the AlternateView to cater for both HTML and Text clients. I would prefer to use HTML and only fall back to text where necessary. I started re-coding an old console app to do this but I still have carriage returns and newlines as "/r/n" in my code and my problem is trying to figure out how and where to use Environment.Newline instead of these?

Right now, the console application is being called from a Web form. I'm experiencing some difficulties debugging and the eventual plan is to create a WCF service for this.

I think the difficulty I'm having is determining what AlternateView actually does for me as opposed to how much of the email body I have to explicitly code separately, in text and HTML versions. Specifically, I still have old carriage returns and newlines in the final else block of the following code and I'm trying to figure out a more elegant way of doing this.

    // args[0] - Subject
    // args[1] - Message (uses all Environment.Newlines)
    // args[2] - RfpID

    static void Main(string[] args)
    {
        string subject = args[0];
        string message  = args[1];

        // Get programatic access to the email information stored in the web.config file
        string emailHost = WebConfigurationManager.AppSettings["EmailHost"];
        string fromAddress = WebConfigurationManager.AppSettings["FromEmailAddress"];

        SmtpClient client = new SmtpClient(emailHost);

        int count = 0;
        using (SqlDataReader dr = MailerDALC.GetAddressesByRFP(Convert.ToInt32(args[2])))
        {
            string hash;
            while (dr.Read())
            {
                MailMessage mailMessage = new MailMessage();

                mailMessage.IsBodyHtml = true;
                mailMessage.SubjectEncoding = System.Text.Encoding.UTF8;
                mailMessage.BodyEncoding = System.Text.Encoding.UTF8;

                using (AlternateView textPart = 
                    AlternateView.CreateAlternateViewFromString(mailMessage.Body,
                        System.Text.Encoding.UTF8, "text/plain"))
                {
                    textPart.TransferEncoding = 
                        System.Net.Mime.TransferEncoding.QuotedPrintable;
                    mailMessage.AlternateViews.Add(textPart);
                }

                using (AlternateView htmlPart = 
                    AlternateView.CreateAlternateViewFromString(mailMessage.Body,
                        System.Text.Encoding.UTF8, "text/html"))
               {
                   htmlPart.TransferEncoding = 
                       System.Net.Mime.TransferEncoding.QuotedPrintable;
                   mailMessage.AlternateViews.Add(htmlPart);
               }

               mailMessage.Priority = MailPriority.High;

               mailMessage.From = new MailAddress(fromAddress);
               mailMessage.Subject = subject;

               mailMessage.To.Add(new MailAddress(dr["EmailAddress"].ToString()));

               if ((bool)dr["SecondaryNotify"])
                   mailMessage.Bcc.Add(new MailAddress(dr["SecondaryEmail"].ToString()));

                   // Send email in batches of 100 with a 30 second pause between each batch 
                   if ((count >= 100) && (count % 100 == 0))
                       Thread.Sleep(30000);

                   // Check well-formedness of each email adddress
                   if (!IsWellformedEmailAddr(mailMessage.To.ToString()))       
                   {
                       LogError(dr[1].ToString() 
                        + " is a malformed email address. 
                            Message was not sent to this subscriber "
                                + dr[1].ToString() + ".", "");
                       continue;
                   }
                   else
                   {
                       mailMessage.Body = message; 

                       hash = dr["Hash"].ToString();
                       mailMessage.Body += 
                           "\n\nIf you no longer wish to receive notifications, you can "
                               + "unsubscribe and your details will be removed from our system:\n" 
                               + "http://example.com/apps/vendorreg/unsubscribe.aspx?unsub=" 
                               + hash + "\n\n";

                       mailMessage.Body += "My Website Policies:\n"
                           + "http://example.com/doc/help/policies/help_website_policies";

                        client.Send(mailMessage.From.Address, mailMessage.To[0].ToString(),
                            mailMessage.Subject, mailMessage.Body);

                        count++;
                   }
                   hash = "";
               } 
           } 
    }

Solution

  • UPDATE - 09-30-2019: Microsoft updated the documentation for this.

    As I guessed, I had to explicitly provide a plain text and HTML version of the message body. The MSDN documentation was not very helpful. Here's a snippet of the code I created to get this working:

    // args[0] - Subject
    // args[1] - Plain text body content
    // args[2] - HTML body content
    // args[3] - RfpID
    
    textMessage += "\n\nIf you no longer wish to receive notifications, you can "
        + "unsubscribe and your details will be removed from our system:\n"
        + "http://example.com/apps/vendorreg/unsubscribe.aspx?unsub=" + hash + "\n\n"
        + "Example Website Policies:\n"
        + "http://example.com/doc/help/policies/help_website_policies";
    
    // Important: Mime standard dictates that text version must come first 
    using (AlternateView textPart = 
        AlternateView.CreateAlternateViewFromString(textMessage, null, "text/plain"))
    {
        textPart.TransferEncoding = System.Net.Mime.TransferEncoding.QuotedPrintable;
        mailMessage.AlternateViews.Add(textPart);
        mailMessage.IsBodyHtml = false;
        mailMessage.Body = textMessage;
    }
    
    htmlMessage += Environment.NewLine + Environment.NewLine
        + "If you no longer wish to receive notifications, you can "
        + "unsubscribe and your details will be removed from our system:"
        + Environment.NewLine 
        + "http://example.com/apps/vendorreg/unsubscribe.aspx?unsub=" + hash
        + Environment.NewLine + Environment.NewLine
        + "Example.com Website Policies:" 
        + Environment.NewLine
        + "http://example.com/doc/help/policies/help_website_policies";
    
    using (AlternateView htmlPart = 
        AlternateView.CreateAlternateViewFromString(htmlMessage,
        System.Text.Encoding.UTF8, "text/html"))
    {
        htmlPart.TransferEncoding = System.Net.Mime.TransferEncoding.QuotedPrintable;
        mailMessage.AlternateViews.Add(htmlPart);
        mailMessage.IsBodyHtml = true;
        mailMessage.Body = htmlMessage;
    }
    
    // Send email