@@ -1,36 +1,44 @@
1−{-# LANGUAGE TemplateHaskell #-}
2−{-# LANGUAGE CPP #-}
3−{-# LANGUAGE RankNTypes #-}
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DeriveFoldable #-}
3+{-# LANGUAGE DeriveFunctor #-}
4+{-# LANGUAGE DeriveTraversable #-}
5+{-# LANGUAGE OverloadedStrings #-}
6+{-# LANGUAGE RankNTypes #-}
47{-# LANGUAGE ScopedTypeVariables #-}
5−{-# LANGUAGE OverloadedStrings #-}
8+{-# LANGUAGE TemplateHaskell #-}
69module Network.API.Mandrill.Types where
710
8−import Network.API.Mandrill.Utils
9−import Test.QuickCheck
10−import Text.Email.Validate
11+import Control.Applicative
12+import Control.Monad (mzero)
1113import Data.Char
1214import Data.Maybe
1315import Data.Time
14−import Control.Applicative
16+import Lens.Micro.TH (makeLenses)
17+import Network.API.Mandrill.Utils
18+import Test.QuickCheck
19+import Text.Email.Validate
1520#if MIN_VERSION_time(1,5,0)
16−import Data.Time.Format (TimeLocale, defaultTimeLocale)
21+import Data.Time.Format (TimeLocale, defaultTimeLocale)
1722#else
18−import System.Locale (TimeLocale, defaultTimeLocale)
23+import System.Locale (TimeLocale, defaultTimeLocale)
1924#endif
20−import qualified Data.ByteString as B
21−import qualified Data.ByteString.Base64 as Base64
22−import qualified Data.HashMap.Strict as H
23−import qualified Data.Text as T
24−import qualified Data.Text.Encoding as TL
25−import qualified Data.Text.Lazy as TL
26−import Control.Lens
27−import Data.Monoid
2825import Data.Aeson
29−import Data.Aeson.Types
3026import Data.Aeson.TH
31−import qualified Text.Blaze.Html as Blaze
27+import Data.Aeson.Types
28+import qualified Data.ByteString as B
29+import qualified Data.ByteString.Base64 as Base64
30+#if !MIN_VERSION_base(4,8,0)
31+import Data.Foldable
32+import Data.Traversable
33+#endif
34+import qualified Data.HashMap.Strict as H
35+import Data.Monoid
36+import qualified Data.Text as T
37+import qualified Data.Text.Encoding as TL
38+import qualified Data.Text.Lazy as TL
39+import qualified Text.Blaze.Html as Blaze
3240import qualified Text.Blaze.Html.Renderer.Text as Blaze
33−
41+import qualified Text.Email.Validate as TEV
3442
3543timeParse :: ParseTime t => TimeLocale -> String -> String -> Maybe t
3644#if MIN_VERSION_time(1,5,0)
@@ -41,11 +49,11 @@ timeParse = parseTime
4149
4250--------------------------------------------------------------------------------
4351data MandrillError = MandrillError {
44− _merr_status :: !T.Text
45− , _merr_code :: !Int
46− , _merr_name :: !T.Text
52+ _merr_status :: !T.Text
53+ , _merr_code :: !Int
54+ , _merr_name :: !T.Text
4755 , _merr_message :: !T.Text
48− } deriving Show
56+ } deriving (Show, Eq)
4957
5058makeLenses ''MandrillError
5159deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillError
@@ -70,6 +78,7 @@ data MandrillRejectReason = RR_HardBounce
7078 | RR_InvalidSender
7179 | RR_Invalid
7280 | RR_TestModeLimit
81+ | RR_Unsigned
7382 | RR_Rule deriving Show
7483
7584deriveJSON defaultOptions {
@@ -82,7 +91,7 @@ deriveJSON defaultOptions {
8291-- which can be either a success or a failure.
8392data MandrillResponse k =
8493 MandrillSuccess k
85− | MandrillFailure MandrillError deriving Show
94+ | MandrillFailure MandrillError deriving (Show, Eq, Functor, Foldable, Traversable)
8695
8796instance FromJSON k => FromJSON (MandrillResponse k) where
8897 parseJSON v = case (parseMaybe parseJSON v) :: Maybe k of
@@ -118,9 +127,9 @@ instance FromJSON MandrillEmail where
118127data MandrillRecipient = MandrillRecipient {
119128 _mrec_email :: MandrillEmail
120129 -- ^ The email address of the recipient
121− , _mrec_name :: Maybe T.Text
130+ , _mrec_name :: Maybe T.Text
122131 -- ^ The optional display name to use for the recipient
123− , _mrec_type :: Maybe MandrillRecipientTag
132+ , _mrec_type :: Maybe MandrillRecipientTag
124133 -- ^ The header type to use for the recipient.
125134 -- defaults to "to" if not provided
126135 } deriving Show
@@ -149,6 +158,11 @@ unsafeMkMandrillHtml = MandrillHtml . Blaze.preEscapedToHtml
149158mkMandrillHtml :: Blaze.Html -> MandrillHtml
150159mkMandrillHtml = MandrillHtml
151160
161+#if MIN_VERSION_base(4,11,0)
162+instance Semigroup MandrillHtml where
163+ MandrillHtml m1 <> MandrillHtml m2 = MandrillHtml (m1 <> m2)
164+#endif
165+
152166instance Monoid MandrillHtml where
153167 mempty = MandrillHtml mempty
154168 mappend (MandrillHtml m1) (MandrillHtml m2) = MandrillHtml (m1 <> m2)
@@ -174,9 +188,6 @@ type MandrillTags = T.Text
174188type MandrillHeaders = Object
175189
176190
177−--------------------------------------------------------------------------------
178−type MandrillVars = Value
179−
180191--------------------------------------------------------------------------------
181192
182193data MergeVar = MergeVar {
@@ -198,7 +209,7 @@ deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillMergeVars
198209
199210--------------------------------------------------------------------------------
200211data MandrillMetadata = MandrillMetadata {
201− _mmdt_rcpt :: !T.Text
212+ _mmdt_rcpt :: !T.Text
202213 , _mmdt_values :: Object
203214 } deriving Show
204215
@@ -223,8 +234,8 @@ instance FromJSON Base64ByteString where
223234
224235--------------------------------------------------------------------------------
225236data MandrillWebContent = MandrillWebContent {
226− _mwct_type :: !T.Text
227− , _mwct_name :: !T.Text
237+ _mwct_type :: !T.Text
238+ , _mwct_name :: !T.Text
228239 -- ^ [for images] the Content ID of the image
229240 -- - use <img src="cid:THIS_VALUE"> to reference the image
230241 -- in your HTML content
@@ -237,67 +248,67 @@ deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillWebContent
237248--------------------------------------------------------------------------------
238249-- | The information on the message to send
239250data MandrillMessage = MandrillMessage {
240− _mmsg_html :: MandrillHtml
251+ _mmsg_html :: MandrillHtml
241252 -- ^ The full HTML content to be sent
242− , _mmsg_text :: Maybe T.Text
253+ , _mmsg_text :: Maybe T.Text
243254 -- ^ Optional full text content to be sent
244− , _mmsg_subject :: !T.Text
255+ , _mmsg_subject :: !T.Text
245256 -- ^ The message subject
246− , _mmsg_from_email :: MandrillEmail
257+ , _mmsg_from_email :: MandrillEmail
247258 -- ^ The sender email address
248− , _mmsg_from_name :: Maybe T.Text
259+ , _mmsg_from_name :: Maybe T.Text
249260 -- ^ Optional from name to be used
250− , _mmsg_to :: [MandrillRecipient]
261+ , _mmsg_to :: [MandrillRecipient]
251262 -- ^ A list of recipient information
252− , _mmsg_headers :: MandrillHeaders
263+ , _mmsg_headers :: MandrillHeaders
253264 -- ^ optional extra headers to add to the message (most headers are allowed)
254− , _mmsg_important :: Maybe Bool
265+ , _mmsg_important :: Maybe Bool
255266 -- ^ whether or not this message is important, and should be delivered ahead
256267 -- of non-important messages
257− , _mmsg_track_opens :: Maybe Bool
268+ , _mmsg_track_opens :: Maybe Bool
258269 -- ^ whether or not to turn on open tracking for the message
259− , _mmsg_track_clicks :: Maybe Bool
270+ , _mmsg_track_clicks :: Maybe Bool
260271 -- ^ whether or not to turn on click tracking for the message
261− , _mmsg_auto_text :: Maybe Bool
272+ , _mmsg_auto_text :: Maybe Bool
262273 -- ^ whether or not to automatically generate a text part for messages that are not given text
263− , _mmsg_auto_html :: Maybe Bool
274+ , _mmsg_auto_html :: Maybe Bool
264275 -- ^ whether or not to automatically generate an HTML part for messages that are not given HTML
265− , _mmsg_inline_css :: Maybe Bool
276+ , _mmsg_inline_css :: Maybe Bool
266277 -- ^ whether or not to automatically inline all CSS styles provided in the message HTML
267278 -- - only for HTML documents less than 256KB in size
268− , _mmsg_url_strip_qs :: Maybe Bool
279+ , _mmsg_url_strip_qs :: Maybe Bool
269280 -- ^ whether or not to strip the query string from URLs when aggregating tracked URL data
270− , _mmsg_preserve_recipients :: Maybe Bool
281+ , _mmsg_preserve_recipients :: Maybe Bool
271282 -- ^ whether or not to expose all recipients in to "To" header for each email
272− , _mmsg_view_content_link :: Maybe Bool
283+ , _mmsg_view_content_link :: Maybe Bool
273284 -- ^ set to false to remove content logging for sensitive emails
274− , _mmsg_bcc_address :: Maybe T.Text
285+ , _mmsg_bcc_address :: Maybe T.Text
275286 -- ^ an optional address to receive an exact copy of each recipient's email
276− , _mmsg_tracking_domain :: Maybe T.Text
287+ , _mmsg_tracking_domain :: Maybe T.Text
277288 -- ^ a custom domain to use for tracking opens and clicks instead of mandrillapp.com
278− , _mmsg_signing_domain :: Maybe Bool
289+ , _mmsg_signing_domain :: Maybe Bool
279290 -- ^ a custom domain to use for SPF/DKIM signing instead of mandrill
280291 -- (for "via" or "on behalf of" in email clients)
281− , _mmsg_return_path_domain :: Maybe Bool
292+ , _mmsg_return_path_domain :: Maybe Bool
282293 -- ^ a custom domain to use for the messages's return-path
283− , _mmsg_merge :: Maybe Bool
294+ , _mmsg_merge :: Maybe Bool
284295 -- ^ whether to evaluate merge tags in the message.
285296 -- Will automatically be set to true if either merge_vars
286297 -- or global_merge_vars are provided.
287− , _mmsg_global_merge_vars :: [MergeVar]
298+ , _mmsg_global_merge_vars :: [MergeVar]
288299 -- ^ global merge variables to use for all recipients. You can override these per recipient.
289− , _mmsg_merge_vars :: [MandrillMergeVars]
300+ , _mmsg_merge_vars :: [MandrillMergeVars]
290301 -- ^ per-recipient merge variables, which override global merge variables with the same name.
291− , _mmsg_tags :: [MandrillTags]
302+ , _mmsg_tags :: [MandrillTags]
292303 -- ^ an array of string to tag the message with. Stats are accumulated using tags,
293304 -- though we only store the first 100 we see, so this should not be unique
294305 -- or change frequently. Tags should be 50 characters or less.
295306 -- Any tags starting with an underscore are reserved for internal use
296307 -- and will cause errors.
297− , _mmsg_subaccount :: Maybe T.Text
308+ , _mmsg_subaccount :: Maybe T.Text
298309 -- ^ the unique id of a subaccount for this message
299310 -- - must already exist or will fail with an error
300− , _mmsg_google_analytics_domains :: [T.Text]
311+ , _mmsg_google_analytics_domains :: [T.Text]
301312 -- ^ an array of strings indicating for which any matching URLs
302313 -- will automatically have Google Analytics parameters appended
303314 -- to their query string automatically.
@@ -305,17 +316,17 @@ data MandrillMessage = MandrillMessage {
305316 -- ^ optional string indicating the value to set for the utm_campaign
306317 -- tracking parameter. If this isn't provided the email's from address
307318 -- will be used instead.
308− , _mmsg_metadata :: Object
319+ , _mmsg_metadata :: Object
309320 -- ^ metadata an associative array of user metadata. Mandrill will store
310321 -- this metadata and make it available for retrieval.
311322 -- In addition, you can select up to 10 metadata fields to index
312323 -- and make searchable using the Mandrill search api.
313− , _mmsg_recipient_metadata :: [MandrillMetadata]
324+ , _mmsg_recipient_metadata :: [MandrillMetadata]
314325 -- ^ Per-recipient metadata that will override the global values
315326 -- specified in the metadata parameter.
316− , _mmsg_attachments :: [MandrillWebContent]
327+ , _mmsg_attachments :: [MandrillWebContent]
317328 -- ^ an array of supported attachments to add to the message
318− , _mmsg_images :: [MandrillWebContent]
329+ , _mmsg_images :: [MandrillWebContent]
319330 -- ^ an array of embedded images to add to the message
320331 } deriving Show
321332