From 0392738d198ff53b545c510ec4387abc5fd98c1c Mon Sep 17 00:00:00 2001 From: Chris Jones Date: Tue, 28 Feb 2012 17:11:46 -0800 Subject: [PATCH] docs. --- README.rst | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index e906a1a..ecc48c4 100644 --- a/README.rst +++ b/README.rst @@ -93,10 +93,14 @@ Example, in a view: :: msg.send() ... # you'll want to return some sort of HttpResponse -Any tags over 50 characters in length are silently ignored. Same for any attached alternatives after the first one. +Any tags over 50 characters in length are silently ignored since Mandrill doesn't support them. Any tags starting with an underscore will raise an ``ImproperlyConfigured`` +exception. Tags with an underscore are reserved by Mandrill. -Not shown above, but settable, are the two options, ``track_clicks`` and ``track_opens``. They are both set to ``True`` by -default, but can be set to ``False`` and passed in when you instantiate your ``DjrillMessage`` object. +If you attach more than one alternative type, an ``ImproperlyConfigured`` exception will be raised. Mandrill does not support attaching +files to an email, so attachments will be silently ignored. + +Not shown above, but settable, are the two options, ``track_clicks`` and ``track_opens``. They are both set to ``True`` by default, but can be set to ``False`` and passed in when you instantiate your ``DjrillMessage`` +object. Just like Django's ``EmailMessage`` and ``EmailMultiAlternatives``, ``DjrillMessage`` accepts extra headers through the ``headers`` argument. Currently it only accepts ``Reply-To`` and ``X-*`` headers since that is all that Mandrill accepts. Any