From: Eric Morris Date: Fri, 3 Jan 2014 22:17:21 +0000 (-0800) Subject: Add troubleshooting section to the docs to talk about DOCTYPE + ESP interaction X-Git-Tag: v1.0.5~14 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ed29316074e02ee04ed7b408312b6c8310abef5a;p=thirdparty%2Ffoundation%2Ffoundation-emails.git Add troubleshooting section to the docs to talk about DOCTYPE + ESP interaction --- diff --git a/docs/components/getting-started.php b/docs/components/getting-started.php index 69da60ef..8201b760 100644 --- a/docs/components/getting-started.php +++ b/docs/components/getting-started.php @@ -70,4 +70,9 @@

Sending Your Email

Sending HTML email is a lot different than sending plain text email. While it may be tempting to just open the email in a browser and click “share” or to use the “Insert HTML” function of your favorite email client, this often strips off a lot of the styling and makes your email completely unusable on mobile devices.

-

To get the best results, we recommend that you send your HTML email using an Email Service Provider (ESP) such as Mailchimp or Campaign Monitor. If you’re just running a quick test and don't want to sign up for an ESP, sending from the command line using a scripting language like PHP or Ruby usually works fine.

\ No newline at end of file +

To get the best results, we recommend that you send your HTML email using an Email Service Provider (ESP) such as Mailchimp or Campaign Monitor. If you’re just running a quick test and don't want to sign up for an ESP, sending from the command line using a scripting language like PHP or Ruby usually works fine.

+
+

Testing and Troubleshooting

+

Since targeting a diverse range of email clients requires some specific and rather quirky markup, Ink doesn’t always preview properly in the browser. When doing browser tests, we recommend using the latest version of Chrome, Safari or Opera, since Ink doesn’t always display properly in Firefox or Internet Explorer.

+

Testing in the browser isn't enough, however, and you should always test in actual email clients. If you don't have access to the actual clients you want to test, a testing service like Litmus or Email on Acid can help.

+

If you're having trouble with an email, the first thing to check is the markup. Often times a simple error like a forgotten <tr> or a nested tag that's been closed in the wrong order can wreak havoc on your design. If that's not the problem, it could be an issue with your ESP. Some senders prepend an <html> tag to your message, which causes the DOCTYPE tag to not be interpreted by the email recipient. To see if this is what's happening, try sending a test email to yourself and using the "view original" or "view raw source" option in your mail client to manually inspect the code.

\ No newline at end of file