@@ -1,44 +1,59 @@
1−{-# LANGUAGE TemplateHaskell #-}
1+{-# LANGUAGE CPP #-}
2−{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DeriveFoldable #-}
3+{-# LANGUAGE DeriveFunctor #-}
4+{-# LANGUAGE DeriveTraversable #-}
5+{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE RankNTypes #-}
6+{-# LANGUAGE RankNTypes #-}
4{-# LANGUAGE ScopedTypeVariables #-}
7{-# LANGUAGE ScopedTypeVariables #-}
5−{-# LANGUAGE OverloadedStrings #-}
8+{-# LANGUAGE TemplateHaskell #-}
6module Network.API.Mandrill.Types where
9module Network.API.Mandrill.Types where
8−import Network.API.Mandrill.Utils
11+import Control.Applicative
9−import Network.API.Mandrill.Orphans()
12+import Control.Monad (mzero)
10−import Test.QuickCheck
11−import Text.Email.Validate
12import Data.Char
13import Data.Char
13import Data.Maybe
14import Data.Maybe
14import Data.Time
15import Data.Time
15−import Control.Applicative
16+import Lens.Micro.TH (makeLenses)
17+import Network.API.Mandrill.Utils
18+import Test.QuickCheck
19+import Text.Email.Validate
16#if MIN_VERSION_time(1,5,0)
20#if MIN_VERSION_time(1,5,0)
17−import Data.Time.Format (defaultTimeLocale)
21+import Data.Time.Format (TimeLocale, defaultTimeLocale)
19−import System.Locale (defaultTimeLocale)
23+import System.Locale (TimeLocale, defaultTimeLocale)
21−import qualified Data.ByteString as B
22−import qualified Data.ByteString.Base64 as Base64
23−import qualified Data.Text as T
24−import qualified Data.Text.Encoding as TL
25−import qualified Data.Text.Lazy as TL
28import Data.Aeson
25import Data.Aeson
29−import Data.Aeson.Types
30import Data.Aeson.TH
26import Data.Aeson.TH
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)
32+import Data.Traversable
34+import qualified Data.HashMap.Strict as H
36+import qualified Data.Text as T
37+import qualified Data.Text.Encoding as TL
38+import qualified Data.Text.Lazy as TL
31−import qualified Text.Blaze.Html as Blaze
39+import qualified Text.Blaze.Html as Blaze
32import qualified Text.Blaze.Html.Renderer.Text as Blaze
40import qualified Text.Blaze.Html.Renderer.Text as Blaze
41+import qualified Text.Email.Validate as TEV
43+timeParse :: ParseTime t => TimeLocale -> String -> String -> Maybe t
44+#if MIN_VERSION_time(1,5,0)
45+timeParse = parseTimeM True
35--------------------------------------------------------------------------------
50--------------------------------------------------------------------------------
36data MandrillError = MandrillError {
51data MandrillError = MandrillError {
37− _merr_status :: !T.Text
52+ _merr_status :: !T.Text
38− , _merr_code :: !Int
53+ , _merr_code :: !Int
39− , _merr_name :: !T.Text
54+ , _merr_name :: !T.Text
40 , _merr_message :: !T.Text
55 , _merr_message :: !T.Text
41− } deriving Show
56+ } deriving (Show, Eq)
43makeLenses ''MandrillError
58makeLenses ''MandrillError
44deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillError
59deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillError
@@ -63,6 +78,7 @@ data MandrillRejectReason = RR_HardBounce
63 | RR_InvalidSender
78 | RR_InvalidSender
64 | RR_Invalid
79 | RR_Invalid
65 | RR_TestModeLimit
80 | RR_TestModeLimit
66 | RR_Rule deriving Show
82 | RR_Rule deriving Show
68deriveJSON defaultOptions {
84deriveJSON defaultOptions {
@@ -75,7 +91,7 @@ deriveJSON defaultOptions {
75-- which can be either a success or a failure.
91-- which can be either a success or a failure.
76data MandrillResponse k =
92data MandrillResponse k =
77 MandrillSuccess k
93 MandrillSuccess k
78− | MandrillFailure MandrillError deriving Show
94+ | MandrillFailure MandrillError deriving (Show, Eq, Functor, Foldable, Traversable)
80instance FromJSON k => FromJSON (MandrillResponse k) where
96instance FromJSON k => FromJSON (MandrillResponse k) where
81 parseJSON v = case (parseMaybe parseJSON v) :: Maybe k of
97 parseJSON v = case (parseMaybe parseJSON v) :: Maybe k of
@@ -93,14 +109,27 @@ data MandrillRecipientTag = To | Cc | Bcc deriving Show
93deriveJSON defaultOptions { constructorTagModifier = map toLower } ''MandrillRecipientTag
109deriveJSON defaultOptions { constructorTagModifier = map toLower } ''MandrillRecipientTag
112+--------------------------------------------------------------------------------
113+newtype MandrillEmail = MandrillEmail EmailAddress deriving Show
115+instance ToJSON MandrillEmail where
116+ toJSON (MandrillEmail e) = String . TL.decodeUtf8 . toByteString $ e
118+instance FromJSON MandrillEmail where
119+ parseJSON (String s) = case validate (TL.encodeUtf8 s) of
120+ Left err -> fail err
121+ Right v -> return . MandrillEmail $ v
122+ parseJSON o = typeMismatch "Expecting a String for MandrillEmail." o
96--------------------------------------------------------------------------------
125--------------------------------------------------------------------------------
97-- | An array of recipient information.
126-- | An array of recipient information.
98data MandrillRecipient = MandrillRecipient {
127data MandrillRecipient = MandrillRecipient {
99− _mrec_email :: EmailAddress
128+ _mrec_email :: MandrillEmail
100 -- ^ The email address of the recipient
129 -- ^ The email address of the recipient
101− , _mrec_name :: Maybe T.Text
130+ , _mrec_name :: Maybe T.Text
102 -- ^ The optional display name to use for the recipient
131 -- ^ The optional display name to use for the recipient
103− , _mrec_type :: Maybe MandrillRecipientTag
132+ , _mrec_type :: Maybe MandrillRecipientTag
104 -- ^ The header type to use for the recipient.
133 -- ^ The header type to use for the recipient.
105 -- defaults to "to" if not provided
134 -- defaults to "to" if not provided
106 } deriving Show
135 } deriving Show
@@ -109,11 +138,11 @@ makeLenses ''MandrillRecipient
109deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillRecipient
138deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillRecipient
111newRecipient :: EmailAddress -> MandrillRecipient
140newRecipient :: EmailAddress -> MandrillRecipient
112−newRecipient email = MandrillRecipient email Nothing Nothing
141+newRecipient email = MandrillRecipient (MandrillEmail email) Nothing Nothing
114instance Arbitrary MandrillRecipient where
143instance Arbitrary MandrillRecipient where
115 arbitrary = pure MandrillRecipient {
144 arbitrary = pure MandrillRecipient {
116− _mrec_email = fromJust (emailAddress "test@example.com")
145+ _mrec_email = MandrillEmail $ fromJust (emailAddress "test@example.com")
117 , _mrec_name = Nothing
146 , _mrec_name = Nothing
118 , _mrec_type = Nothing
147 , _mrec_type = Nothing
@@ -129,6 +158,11 @@ unsafeMkMandrillHtml = MandrillHtml . Blaze.preEscapedToHtml
129mkMandrillHtml :: Blaze.Html -> MandrillHtml
158mkMandrillHtml :: Blaze.Html -> MandrillHtml
130mkMandrillHtml = MandrillHtml
159mkMandrillHtml = MandrillHtml
161+#if MIN_VERSION_base(4,11,0)
162+instance Semigroup MandrillHtml where
163+ MandrillHtml m1 <> MandrillHtml m2 = MandrillHtml (m1 <> m2)
132instance Monoid MandrillHtml where
166instance Monoid MandrillHtml where
133 mempty = MandrillHtml mempty
167 mempty = MandrillHtml mempty
134 mappend (MandrillHtml m1) (MandrillHtml m2) = MandrillHtml (m1 <> m2)
168 mappend (MandrillHtml m1) (MandrillHtml m2) = MandrillHtml (m1 <> m2)
@@ -151,17 +185,23 @@ type MandrillTags = T.Text
153--------------------------------------------------------------------------------
187--------------------------------------------------------------------------------
154−type MandrillHeaders = Value
188+type MandrillHeaders = Object
157--------------------------------------------------------------------------------
191--------------------------------------------------------------------------------
158−type MandrillVars = Value
193+data MergeVar = MergeVar {
195+ , _mv_content :: Value
198+makeLenses ''MergeVar
199+deriveJSON defaultOptions { fieldLabelModifier = drop 4 } ''MergeVar
161--------------------------------------------------------------------------------
201--------------------------------------------------------------------------------
162data MandrillMergeVars = MandrillMergeVars {
202data MandrillMergeVars = MandrillMergeVars {
163 _mmvr_rcpt :: !T.Text
203 _mmvr_rcpt :: !T.Text
164− , _mmvr_vars :: [MandrillVars]
204+ , _mmvr_vars :: [MergeVar]
165 } deriving Show
205 } deriving Show
167makeLenses ''MandrillMergeVars
207makeLenses ''MandrillMergeVars
@@ -169,29 +209,33 @@ deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillMergeVars
170--------------------------------------------------------------------------------
210--------------------------------------------------------------------------------
171data MandrillMetadata = MandrillMetadata {
211data MandrillMetadata = MandrillMetadata {
172− _mmdt_rcpt :: !T.Text
212+ _mmdt_rcpt :: !T.Text
173− , _mmdt_values :: MandrillVars
213+ , _mmdt_values :: Object
174 } deriving Show
214 } deriving Show
176makeLenses ''MandrillMetadata
216makeLenses ''MandrillMetadata
177deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillMetadata
217deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillMetadata
180−newtype Base64ByteString = B64BS B.ByteString deriving Show
220+data Base64ByteString =
221+ EncodedB64BS B.ByteString
222+ -- ^ An already-encoded Base64 ByteString.
223+ | PlainBS B.ByteString
224+ -- ^ A plain Base64 ByteString which requires encoding.
182instance ToJSON Base64ByteString where
227instance ToJSON Base64ByteString where
183− toJSON (B64BS bs) = String . TL.decodeUtf8 . Base64.encode $ bs
228+ toJSON (PlainBS bs) = String . TL.decodeUtf8 . Base64.encode $ bs
229+ toJSON (EncodedB64BS bs) = String . TL.decodeUtf8 $ bs
185instance FromJSON Base64ByteString where
231instance FromJSON Base64ByteString where
186− parseJSON (String v) = case Base64.decode (TL.encodeUtf8 v) of
232+ parseJSON (String v) = pure $ EncodedB64BS (TL.encodeUtf8 v)
187− Left err -> fail err
188− Right rs -> return $ B64BS rs
189 parseJSON rest = typeMismatch "Base64ByteString must be a String." rest
233 parseJSON rest = typeMismatch "Base64ByteString must be a String." rest
191--------------------------------------------------------------------------------
235--------------------------------------------------------------------------------
192data MandrillWebContent = MandrillWebContent {
236data MandrillWebContent = MandrillWebContent {
193− _mwct_type :: !T.Text
237+ _mwct_type :: !T.Text
194− , _mwct_name :: !T.Text
238+ , _mwct_name :: !T.Text
195 -- ^ [for images] the Content ID of the image
239 -- ^ [for images] the Content ID of the image
196 -- - use <img src="cid:THIS_VALUE"> to reference the image
240 -- - use <img src="cid:THIS_VALUE"> to reference the image
197 -- in your HTML content
241 -- in your HTML content
@@ -204,67 +248,67 @@ deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillWebContent
204--------------------------------------------------------------------------------
248--------------------------------------------------------------------------------
205-- | The information on the message to send
249-- | The information on the message to send
206data MandrillMessage = MandrillMessage {
250data MandrillMessage = MandrillMessage {
207− _mmsg_html :: MandrillHtml
251+ _mmsg_html :: MandrillHtml
208 -- ^ The full HTML content to be sent
252 -- ^ The full HTML content to be sent
209− , _mmsg_text :: Maybe T.Text
253+ , _mmsg_text :: Maybe T.Text
210 -- ^ Optional full text content to be sent
254 -- ^ Optional full text content to be sent
211− , _mmsg_subject :: !T.Text
255+ , _mmsg_subject :: !T.Text
212 -- ^ The message subject
256 -- ^ The message subject
213− , _mmsg_from_email :: EmailAddress
257+ , _mmsg_from_email :: MandrillEmail
214 -- ^ The sender email address
258 -- ^ The sender email address
215− , _mmsg_from_name :: Maybe T.Text
259+ , _mmsg_from_name :: Maybe T.Text
216 -- ^ Optional from name to be used
260 -- ^ Optional from name to be used
217− , _mmsg_to :: [MandrillRecipient]
261+ , _mmsg_to :: [MandrillRecipient]
218 -- ^ A list of recipient information
262 -- ^ A list of recipient information
219− , _mmsg_headers :: MandrillHeaders
263+ , _mmsg_headers :: MandrillHeaders
220 -- ^ optional extra headers to add to the message (most headers are allowed)
264 -- ^ optional extra headers to add to the message (most headers are allowed)
221− , _mmsg_important :: Maybe Bool
265+ , _mmsg_important :: Maybe Bool
222 -- ^ whether or not this message is important, and should be delivered ahead
266 -- ^ whether or not this message is important, and should be delivered ahead
223 -- of non-important messages
267 -- of non-important messages
224− , _mmsg_track_opens :: Maybe Bool
268+ , _mmsg_track_opens :: Maybe Bool
225 -- ^ whether or not to turn on open tracking for the message
269 -- ^ whether or not to turn on open tracking for the message
226− , _mmsg_track_clicks :: Maybe Bool
270+ , _mmsg_track_clicks :: Maybe Bool
227 -- ^ whether or not to turn on click tracking for the message
271 -- ^ whether or not to turn on click tracking for the message
228− , _mmsg_auto_text :: Maybe Bool
272+ , _mmsg_auto_text :: Maybe Bool
229 -- ^ whether or not to automatically generate a text part for messages that are not given text
273 -- ^ whether or not to automatically generate a text part for messages that are not given text
230− , _mmsg_auto_html :: Maybe Bool
274+ , _mmsg_auto_html :: Maybe Bool
231 -- ^ whether or not to automatically generate an HTML part for messages that are not given HTML
275 -- ^ whether or not to automatically generate an HTML part for messages that are not given HTML
232− , _mmsg_inline_css :: Maybe Bool
276+ , _mmsg_inline_css :: Maybe Bool
233 -- ^ whether or not to automatically inline all CSS styles provided in the message HTML
277 -- ^ whether or not to automatically inline all CSS styles provided in the message HTML
234 -- - only for HTML documents less than 256KB in size
278 -- - only for HTML documents less than 256KB in size
235− , _mmsg_url_strip_qs :: Maybe Bool
279+ , _mmsg_url_strip_qs :: Maybe Bool
236 -- ^ whether or not to strip the query string from URLs when aggregating tracked URL data
280 -- ^ whether or not to strip the query string from URLs when aggregating tracked URL data
237− , _mmsg_preserve_recipients :: Maybe Bool
281+ , _mmsg_preserve_recipients :: Maybe Bool
238 -- ^ whether or not to expose all recipients in to "To" header for each email
282 -- ^ whether or not to expose all recipients in to "To" header for each email
239− , _mmsg_view_content_link :: Maybe Bool
283+ , _mmsg_view_content_link :: Maybe Bool
240 -- ^ set to false to remove content logging for sensitive emails
284 -- ^ set to false to remove content logging for sensitive emails
241− , _mmsg_bcc_address :: Maybe T.Text
285+ , _mmsg_bcc_address :: Maybe T.Text
242 -- ^ an optional address to receive an exact copy of each recipient's email
286 -- ^ an optional address to receive an exact copy of each recipient's email
243− , _mmsg_tracking_domain :: Maybe T.Text
287+ , _mmsg_tracking_domain :: Maybe T.Text
244 -- ^ a custom domain to use for tracking opens and clicks instead of mandrillapp.com
288 -- ^ a custom domain to use for tracking opens and clicks instead of mandrillapp.com
245− , _mmsg_signing_domain :: Maybe Bool
289+ , _mmsg_signing_domain :: Maybe Bool
246− -- ^ a custom domain to use for SPF/DKIM signing instead of mandrill
290+ -- ^ a custom domain to use for SPF/DKIM signing instead of mandrill
247 -- (for "via" or "on behalf of" in email clients)
291 -- (for "via" or "on behalf of" in email clients)
248− , _mmsg_return_path_domain :: Maybe Bool
292+ , _mmsg_return_path_domain :: Maybe Bool
249 -- ^ a custom domain to use for the messages's return-path
293 -- ^ a custom domain to use for the messages's return-path
250− , _mmsg_merge :: Maybe Bool
294+ , _mmsg_merge :: Maybe Bool
251 -- ^ whether to evaluate merge tags in the message.
295 -- ^ whether to evaluate merge tags in the message.
252 -- Will automatically be set to true if either merge_vars
296 -- Will automatically be set to true if either merge_vars
253 -- or global_merge_vars are provided.
297 -- or global_merge_vars are provided.
254− , _mmsg_global_merge_vars :: [MandrillVars]
298+ , _mmsg_global_merge_vars :: [MergeVar]
255 -- ^ global merge variables to use for all recipients. You can override these per recipient.
299 -- ^ global merge variables to use for all recipients. You can override these per recipient.
256− , _mmsg_merge_vars :: [MandrillMergeVars]
300+ , _mmsg_merge_vars :: [MandrillMergeVars]
257 -- ^ per-recipient merge variables, which override global merge variables with the same name.
301 -- ^ per-recipient merge variables, which override global merge variables with the same name.
258− , _mmsg_tags :: [MandrillTags]
302+ , _mmsg_tags :: [MandrillTags]
259 -- ^ an array of string to tag the message with. Stats are accumulated using tags,
303 -- ^ an array of string to tag the message with. Stats are accumulated using tags,
260 -- though we only store the first 100 we see, so this should not be unique
304 -- though we only store the first 100 we see, so this should not be unique
261 -- or change frequently. Tags should be 50 characters or less.
305 -- or change frequently. Tags should be 50 characters or less.
262 -- Any tags starting with an underscore are reserved for internal use
306 -- Any tags starting with an underscore are reserved for internal use
263 -- and will cause errors.
307 -- and will cause errors.
264− , _mmsg_subaccount :: Maybe T.Text
308+ , _mmsg_subaccount :: Maybe T.Text
265 -- ^ the unique id of a subaccount for this message
309 -- ^ the unique id of a subaccount for this message
266 -- - must already exist or will fail with an error
310 -- - must already exist or will fail with an error
267− , _mmsg_google_analytics_domains :: [T.Text]
311+ , _mmsg_google_analytics_domains :: [T.Text]
268 -- ^ an array of strings indicating for which any matching URLs
312 -- ^ an array of strings indicating for which any matching URLs
269 -- will automatically have Google Analytics parameters appended
313 -- will automatically have Google Analytics parameters appended
270 -- to their query string automatically.
314 -- to their query string automatically.
@@ -272,17 +316,17 @@ data MandrillMessage = MandrillMessage {
272 -- ^ optional string indicating the value to set for the utm_campaign
316 -- ^ optional string indicating the value to set for the utm_campaign
273 -- tracking parameter. If this isn't provided the email's from address
317 -- tracking parameter. If this isn't provided the email's from address
274 -- will be used instead.
318 -- will be used instead.
275− , _mmsg_metadata :: MandrillVars
319+ , _mmsg_metadata :: Object
276 -- ^ metadata an associative array of user metadata. Mandrill will store
320 -- ^ metadata an associative array of user metadata. Mandrill will store
277 -- this metadata and make it available for retrieval.
321 -- this metadata and make it available for retrieval.
278 -- In addition, you can select up to 10 metadata fields to index
322 -- In addition, you can select up to 10 metadata fields to index
279 -- and make searchable using the Mandrill search api.
323 -- and make searchable using the Mandrill search api.
280− , _mmsg_recipient_metadata :: [MandrillMetadata]
324+ , _mmsg_recipient_metadata :: [MandrillMetadata]
281 -- ^ Per-recipient metadata that will override the global values
325 -- ^ Per-recipient metadata that will override the global values
282 -- specified in the metadata parameter.
326 -- specified in the metadata parameter.
283− , _mmsg_attachments :: [MandrillWebContent]
327+ , _mmsg_attachments :: [MandrillWebContent]
284 -- ^ an array of supported attachments to add to the message
328 -- ^ an array of supported attachments to add to the message
285− , _mmsg_images :: [MandrillWebContent]
329+ , _mmsg_images :: [MandrillWebContent]
286 -- ^ an array of embedded images to add to the message
330 -- ^ an array of embedded images to add to the message
287 } deriving Show
331 } deriving Show
@@ -293,10 +337,10 @@ instance Arbitrary MandrillMessage where
293 arbitrary = MandrillMessage <$> arbitrary
337 arbitrary = MandrillMessage <$> arbitrary
294 <*> pure Nothing
338 <*> pure Nothing
295 <*> pure "Test Subject"
339 <*> pure "Test Subject"
296− <*> pure (fromJust $ emailAddress "sender@example.com")
340+ <*> pure (MandrillEmail . fromJust $ emailAddress "sender@example.com")
297 <*> pure Nothing
341 <*> pure Nothing
298 <*> resize 2 arbitrary
342 <*> resize 2 arbitrary
299− <*> pure emptyObject
343+ <*> pure H.empty
300 <*> pure Nothing
344 <*> pure Nothing
301 <*> pure Nothing
345 <*> pure Nothing
302 <*> pure Nothing
346 <*> pure Nothing
@@ -317,13 +361,24 @@ instance Arbitrary MandrillMessage where
317 <*> pure Nothing
361 <*> pure Nothing
318 <*> pure []
362 <*> pure []
319 <*> pure Nothing
363 <*> pure Nothing
320− <*> pure emptyObject
364+ <*> pure H.empty
321 <*> pure []
365 <*> pure []
322 <*> pure []
366 <*> pure []
323 <*> pure []
367 <*> pure []
369+--------------------------------------------------------------------------------
370+-- | Key value pair for replacing content in templates via 'Editable Regions'
371+data MandrillTemplateContent = MandrillTemplateContent {
373+ , _mtc_content :: T.Text
376+makeLenses ''MandrillTemplateContent
377+deriveJSON defaultOptions { fieldLabelModifier = drop 5 } ''MandrillTemplateContent
325--------------------------------------------------------------------------------
379--------------------------------------------------------------------------------
326type MandrillKey = T.Text
380type MandrillKey = T.Text
381+type MandrillTemplate = T.Text
328newtype MandrillDate = MandrillDate {
383newtype MandrillDate = MandrillDate {
329 fromMandrillDate :: UTCTime
384 fromMandrillDate :: UTCTime
@@ -334,6 +389,6 @@ instance ToJSON MandrillDate where
335instance FromJSON MandrillDate where
390instance FromJSON MandrillDate where
336 parseJSON = withText "MandrillDate" $ \t ->
391 parseJSON = withText "MandrillDate" $ \t ->
337− case parseTimeM True defaultTimeLocale "%Y-%m-%d %I:%M:%S%Q" (T.unpack t) of
392+ case timeParse defaultTimeLocale "%Y-%m-%d %I:%M:%S%Q" (T.unpack t) of
338 Just d -> pure $ MandrillDate d
393 Just d -> pure $ MandrillDate d
339 _ -> fail "could not parse Mandrill date"
394 _ -> fail "could not parse Mandrill date"