@@ -1,39 +1,59 @@
1−{-# LANGUAGE TemplateHaskell #-}
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DeriveFoldable #-}
3+{-# LANGUAGE DeriveFunctor #-}
4+{-# LANGUAGE DeriveTraversable #-}
5+{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE RankNTypes #-}
6+{-# LANGUAGE RankNTypes #-}
3{-# LANGUAGE ScopedTypeVariables #-}
7{-# LANGUAGE ScopedTypeVariables #-}
4−{-# LANGUAGE OverloadedStrings #-}
8+{-# LANGUAGE TemplateHaskell #-}
5module Network.API.Mandrill.Types where
9module Network.API.Mandrill.Types where
7−import Network.API.Mandrill.Utils
11+import Control.Applicative
8−import Network.API.Mandrill.Orphans()
12+import Control.Monad (mzero)
10−import Text.Email.Validate
11import Data.Char
13import Data.Char
12import Data.Maybe
14import Data.Maybe
13import Data.Time
15import 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
20+#if MIN_VERSION_time(1,5,0)
21+import Data.Time.Format (TimeLocale, defaultTimeLocale)
15−import System.Locale (defaultTimeLocale)
23+import System.Locale (TimeLocale, defaultTimeLocale)
16−import qualified Data.ByteString as B
24+#endif
17−import qualified Data.ByteString.Base64 as Base64
18−import qualified Data.Text as T
19−import qualified Data.Text.Encoding as TL
20−import qualified Data.Text.Lazy as TL
23import Data.Aeson
25import Data.Aeson
24−import Data.Aeson.Types
25import 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
26−import qualified Text.Blaze.Html as Blaze
39+import qualified Text.Blaze.Html as Blaze
27import 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
30--------------------------------------------------------------------------------
50--------------------------------------------------------------------------------
31data MandrillError = MandrillError {
51data MandrillError = MandrillError {
32− _merr_status :: !T.Text
52+ _merr_status :: !T.Text
33− , _merr_code :: !Int
53+ , _merr_code :: !Int
34− , _merr_name :: !T.Text
54+ , _merr_name :: !T.Text
35 , _merr_message :: !T.Text
55 , _merr_message :: !T.Text
36− } deriving Show
56+ } deriving (Show, Eq)
38makeLenses ''MandrillError
58makeLenses ''MandrillError
39deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillError
59deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillError
@@ -58,6 +78,7 @@ data MandrillRejectReason = RR_HardBounce
58 | RR_InvalidSender
78 | RR_InvalidSender
59 | RR_Invalid
79 | RR_Invalid
60 | RR_TestModeLimit
80 | RR_TestModeLimit
61 | RR_Rule deriving Show
82 | RR_Rule deriving Show
63deriveJSON defaultOptions {
84deriveJSON defaultOptions {
@@ -70,7 +91,7 @@ deriveJSON defaultOptions {
70-- which can be either a success or a failure.
91-- which can be either a success or a failure.
71data MandrillResponse k =
92data MandrillResponse k =
72 MandrillSuccess k
93 MandrillSuccess k
73− | MandrillFailure MandrillError deriving Show
94+ | MandrillFailure MandrillError deriving (Show, Eq, Functor, Foldable, Traversable)
75instance FromJSON k => FromJSON (MandrillResponse k) where
96instance FromJSON k => FromJSON (MandrillResponse k) where
76 parseJSON v = case (parseMaybe parseJSON v) :: Maybe k of
97 parseJSON v = case (parseMaybe parseJSON v) :: Maybe k of
@@ -88,14 +109,27 @@ data MandrillRecipientTag = To | Cc | Bcc deriving Show
88deriveJSON 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
91--------------------------------------------------------------------------------
125--------------------------------------------------------------------------------
92-- | An array of recipient information.
126-- | An array of recipient information.
93data MandrillRecipient = MandrillRecipient {
127data MandrillRecipient = MandrillRecipient {
94− _mrec_email :: EmailAddress
128+ _mrec_email :: MandrillEmail
95 -- ^ The email address of the recipient
129 -- ^ The email address of the recipient
96− , _mrec_name :: Maybe T.Text
130+ , _mrec_name :: Maybe T.Text
97 -- ^ The optional display name to use for the recipient
131 -- ^ The optional display name to use for the recipient
98− , _mrec_type :: Maybe MandrillRecipientTag
132+ , _mrec_type :: Maybe MandrillRecipientTag
99 -- ^ The header type to use for the recipient.
133 -- ^ The header type to use for the recipient.
100 -- defaults to "to" if not provided
134 -- defaults to "to" if not provided
101 } deriving Show
135 } deriving Show
@@ -104,11 +138,11 @@ makeLenses ''MandrillRecipient
104deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillRecipient
138deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillRecipient
106newRecipient :: EmailAddress -> MandrillRecipient
140newRecipient :: EmailAddress -> MandrillRecipient
107−newRecipient email = MandrillRecipient email Nothing Nothing
141+newRecipient email = MandrillRecipient (MandrillEmail email) Nothing Nothing
109instance Arbitrary MandrillRecipient where
143instance Arbitrary MandrillRecipient where
110 arbitrary = pure MandrillRecipient {
144 arbitrary = pure MandrillRecipient {
111− _mrec_email = fromJust (emailAddress "test@example.com")
145+ _mrec_email = MandrillEmail $ fromJust (emailAddress "test@example.com")
112 , _mrec_name = Nothing
146 , _mrec_name = Nothing
113 , _mrec_type = Nothing
147 , _mrec_type = Nothing
@@ -124,6 +158,11 @@ unsafeMkMandrillHtml = MandrillHtml . Blaze.preEscapedToHtml
124mkMandrillHtml :: Blaze.Html -> MandrillHtml
158mkMandrillHtml :: Blaze.Html -> MandrillHtml
125mkMandrillHtml = MandrillHtml
159mkMandrillHtml = MandrillHtml
161+#if MIN_VERSION_base(4,11,0)
162+instance Semigroup MandrillHtml where
163+ MandrillHtml m1 <> MandrillHtml m2 = MandrillHtml (m1 <> m2)
127instance Monoid MandrillHtml where
166instance Monoid MandrillHtml where
128 mempty = MandrillHtml mempty
167 mempty = MandrillHtml mempty
129 mappend (MandrillHtml m1) (MandrillHtml m2) = MandrillHtml (m1 <> m2)
168 mappend (MandrillHtml m1) (MandrillHtml m2) = MandrillHtml (m1 <> m2)
@@ -146,17 +185,23 @@ type MandrillTags = T.Text
148--------------------------------------------------------------------------------
187--------------------------------------------------------------------------------
149−type MandrillHeaders = Value
188+type MandrillHeaders = Object
152--------------------------------------------------------------------------------
191--------------------------------------------------------------------------------
153−type MandrillVars = Value
193+data MergeVar = MergeVar {
195+ , _mv_content :: Value
198+makeLenses ''MergeVar
199+deriveJSON defaultOptions { fieldLabelModifier = drop 4 } ''MergeVar
156--------------------------------------------------------------------------------
201--------------------------------------------------------------------------------
157data MandrillMergeVars = MandrillMergeVars {
202data MandrillMergeVars = MandrillMergeVars {
158 _mmvr_rcpt :: !T.Text
203 _mmvr_rcpt :: !T.Text
159− , _mmvr_vars :: [MandrillVars]
204+ , _mmvr_vars :: [MergeVar]
160 } deriving Show
205 } deriving Show
162makeLenses ''MandrillMergeVars
207makeLenses ''MandrillMergeVars
@@ -164,29 +209,33 @@ deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillMergeVars
165--------------------------------------------------------------------------------
210--------------------------------------------------------------------------------
166data MandrillMetadata = MandrillMetadata {
211data MandrillMetadata = MandrillMetadata {
167− _mmdt_rcpt :: !T.Text
212+ _mmdt_rcpt :: !T.Text
168− , _mmdt_values :: MandrillVars
213+ , _mmdt_values :: Object
169 } deriving Show
214 } deriving Show
171makeLenses ''MandrillMetadata
216makeLenses ''MandrillMetadata
172deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillMetadata
217deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillMetadata
175−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.
177instance ToJSON Base64ByteString where
227instance ToJSON Base64ByteString where
178− 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
180instance FromJSON Base64ByteString where
231instance FromJSON Base64ByteString where
181− parseJSON (String v) = case Base64.decode (TL.encodeUtf8 v) of
232+ parseJSON (String v) = pure $ EncodedB64BS (TL.encodeUtf8 v)
182− Left err -> fail err
183− Right rs -> return $ B64BS rs
184 parseJSON rest = typeMismatch "Base64ByteString must be a String." rest
233 parseJSON rest = typeMismatch "Base64ByteString must be a String." rest
186--------------------------------------------------------------------------------
235--------------------------------------------------------------------------------
187data MandrillWebContent = MandrillWebContent {
236data MandrillWebContent = MandrillWebContent {
188− _mwct_type :: !T.Text
237+ _mwct_type :: !T.Text
189− , _mwct_name :: !T.Text
238+ , _mwct_name :: !T.Text
190 -- ^ [for images] the Content ID of the image
239 -- ^ [for images] the Content ID of the image
191 -- - use <img src="cid:THIS_VALUE"> to reference the image
240 -- - use <img src="cid:THIS_VALUE"> to reference the image
192 -- in your HTML content
241 -- in your HTML content
@@ -199,67 +248,67 @@ deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillWebContent
199--------------------------------------------------------------------------------
248--------------------------------------------------------------------------------
200-- | The information on the message to send
249-- | The information on the message to send
201data MandrillMessage = MandrillMessage {
250data MandrillMessage = MandrillMessage {
202− _mmsg_html :: MandrillHtml
251+ _mmsg_html :: MandrillHtml
203 -- ^ The full HTML content to be sent
252 -- ^ The full HTML content to be sent
204− , _mmsg_text :: Maybe T.Text
253+ , _mmsg_text :: Maybe T.Text
205 -- ^ Optional full text content to be sent
254 -- ^ Optional full text content to be sent
206− , _mmsg_subject :: !T.Text
255+ , _mmsg_subject :: !T.Text
207 -- ^ The message subject
256 -- ^ The message subject
208− , _mmsg_from_email :: EmailAddress
257+ , _mmsg_from_email :: MandrillEmail
209 -- ^ The sender email address
258 -- ^ The sender email address
210− , _mmsg_from_name :: Maybe T.Text
259+ , _mmsg_from_name :: Maybe T.Text
211 -- ^ Optional from name to be used
260 -- ^ Optional from name to be used
212− , _mmsg_to :: [MandrillRecipient]
261+ , _mmsg_to :: [MandrillRecipient]
213 -- ^ A list of recipient information
262 -- ^ A list of recipient information
214− , _mmsg_headers :: MandrillHeaders
263+ , _mmsg_headers :: MandrillHeaders
215 -- ^ 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)
216− , _mmsg_important :: Maybe Bool
265+ , _mmsg_important :: Maybe Bool
217 -- ^ 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
218 -- of non-important messages
267 -- of non-important messages
219− , _mmsg_track_opens :: Maybe Bool
268+ , _mmsg_track_opens :: Maybe Bool
220 -- ^ whether or not to turn on open tracking for the message
269 -- ^ whether or not to turn on open tracking for the message
221− , _mmsg_track_clicks :: Maybe Bool
270+ , _mmsg_track_clicks :: Maybe Bool
222 -- ^ whether or not to turn on click tracking for the message
271 -- ^ whether or not to turn on click tracking for the message
223− , _mmsg_auto_text :: Maybe Bool
272+ , _mmsg_auto_text :: Maybe Bool
224 -- ^ 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
225− , _mmsg_auto_html :: Maybe Bool
274+ , _mmsg_auto_html :: Maybe Bool
226 -- ^ 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
227− , _mmsg_inline_css :: Maybe Bool
276+ , _mmsg_inline_css :: Maybe Bool
228 -- ^ 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
229 -- - only for HTML documents less than 256KB in size
278 -- - only for HTML documents less than 256KB in size
230− , _mmsg_url_strip_qs :: Maybe Bool
279+ , _mmsg_url_strip_qs :: Maybe Bool
231 -- ^ 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
232− , _mmsg_preserve_recipients :: Maybe Bool
281+ , _mmsg_preserve_recipients :: Maybe Bool
233 -- ^ 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
234− , _mmsg_view_content_link :: Maybe Bool
283+ , _mmsg_view_content_link :: Maybe Bool
235 -- ^ set to false to remove content logging for sensitive emails
284 -- ^ set to false to remove content logging for sensitive emails
236− , _mmsg_bcc_address :: Maybe T.Text
285+ , _mmsg_bcc_address :: Maybe T.Text
237 -- ^ 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
238− , _mmsg_tracking_domain :: Maybe T.Text
287+ , _mmsg_tracking_domain :: Maybe T.Text
239 -- ^ 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
240− , _mmsg_signing_domain :: Maybe Bool
289+ , _mmsg_signing_domain :: Maybe Bool
241− -- ^ 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
242 -- (for "via" or "on behalf of" in email clients)
291 -- (for "via" or "on behalf of" in email clients)
243− , _mmsg_return_path_domain :: Maybe Bool
292+ , _mmsg_return_path_domain :: Maybe Bool
244 -- ^ a custom domain to use for the messages's return-path
293 -- ^ a custom domain to use for the messages's return-path
245− , _mmsg_merge :: Maybe Bool
294+ , _mmsg_merge :: Maybe Bool
246 -- ^ whether to evaluate merge tags in the message.
295 -- ^ whether to evaluate merge tags in the message.
247 -- Will automatically be set to true if either merge_vars
296 -- Will automatically be set to true if either merge_vars
248 -- or global_merge_vars are provided.
297 -- or global_merge_vars are provided.
249− , _mmsg_global_merge_vars :: [MandrillVars]
298+ , _mmsg_global_merge_vars :: [MergeVar]
250 -- ^ 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.
251− , _mmsg_merge_vars :: [MandrillMergeVars]
300+ , _mmsg_merge_vars :: [MandrillMergeVars]
252 -- ^ 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.
253− , _mmsg_tags :: [MandrillTags]
302+ , _mmsg_tags :: [MandrillTags]
254 -- ^ 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,
255 -- 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
256 -- or change frequently. Tags should be 50 characters or less.
305 -- or change frequently. Tags should be 50 characters or less.
257 -- Any tags starting with an underscore are reserved for internal use
306 -- Any tags starting with an underscore are reserved for internal use
258 -- and will cause errors.
307 -- and will cause errors.
259− , _mmsg_subaccount :: Maybe T.Text
308+ , _mmsg_subaccount :: Maybe T.Text
260 -- ^ the unique id of a subaccount for this message
309 -- ^ the unique id of a subaccount for this message
261 -- - must already exist or will fail with an error
310 -- - must already exist or will fail with an error
262− , _mmsg_google_analytics_domains :: [T.Text]
311+ , _mmsg_google_analytics_domains :: [T.Text]
263 -- ^ an array of strings indicating for which any matching URLs
312 -- ^ an array of strings indicating for which any matching URLs
264 -- will automatically have Google Analytics parameters appended
313 -- will automatically have Google Analytics parameters appended
265 -- to their query string automatically.
314 -- to their query string automatically.
@@ -267,17 +316,17 @@ data MandrillMessage = MandrillMessage {
267 -- ^ optional string indicating the value to set for the utm_campaign
316 -- ^ optional string indicating the value to set for the utm_campaign
268 -- 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
269 -- will be used instead.
318 -- will be used instead.
270− , _mmsg_metadata :: MandrillVars
319+ , _mmsg_metadata :: Object
271 -- ^ metadata an associative array of user metadata. Mandrill will store
320 -- ^ metadata an associative array of user metadata. Mandrill will store
272 -- this metadata and make it available for retrieval.
321 -- this metadata and make it available for retrieval.
273 -- 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
274 -- and make searchable using the Mandrill search api.
323 -- and make searchable using the Mandrill search api.
275− , _mmsg_recipient_metadata :: [MandrillMetadata]
324+ , _mmsg_recipient_metadata :: [MandrillMetadata]
276 -- ^ Per-recipient metadata that will override the global values
325 -- ^ Per-recipient metadata that will override the global values
277 -- specified in the metadata parameter.
326 -- specified in the metadata parameter.
278− , _mmsg_attachments :: [MandrillWebContent]
327+ , _mmsg_attachments :: [MandrillWebContent]
279 -- ^ an array of supported attachments to add to the message
328 -- ^ an array of supported attachments to add to the message
280− , _mmsg_images :: [MandrillWebContent]
329+ , _mmsg_images :: [MandrillWebContent]
281 -- ^ an array of embedded images to add to the message
330 -- ^ an array of embedded images to add to the message
282 } deriving Show
331 } deriving Show
@@ -288,10 +337,10 @@ instance Arbitrary MandrillMessage where
288 arbitrary = MandrillMessage <$> arbitrary
337 arbitrary = MandrillMessage <$> arbitrary
289 <*> pure Nothing
338 <*> pure Nothing
290 <*> pure "Test Subject"
339 <*> pure "Test Subject"
291− <*> pure (fromJust $ emailAddress "sender@example.com")
340+ <*> pure (MandrillEmail . fromJust $ emailAddress "sender@example.com")
292 <*> pure Nothing
341 <*> pure Nothing
293 <*> resize 2 arbitrary
342 <*> resize 2 arbitrary
294− <*> pure emptyObject
343+ <*> pure H.empty
295 <*> pure Nothing
344 <*> pure Nothing
296 <*> pure Nothing
345 <*> pure Nothing
297 <*> pure Nothing
346 <*> pure Nothing
@@ -312,13 +361,24 @@ instance Arbitrary MandrillMessage where
312 <*> pure Nothing
361 <*> pure Nothing
313 <*> pure []
362 <*> pure []
314 <*> pure Nothing
363 <*> pure Nothing
315− <*> pure emptyObject
364+ <*> pure H.empty
316 <*> pure []
365 <*> pure []
317 <*> pure []
366 <*> pure []
318 <*> 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
320--------------------------------------------------------------------------------
379--------------------------------------------------------------------------------
321type MandrillKey = T.Text
380type MandrillKey = T.Text
381+type MandrillTemplate = T.Text
323newtype MandrillDate = MandrillDate {
383newtype MandrillDate = MandrillDate {
324 fromMandrillDate :: UTCTime
384 fromMandrillDate :: UTCTime
@@ -329,6 +389,6 @@ instance ToJSON MandrillDate where
330instance FromJSON MandrillDate where
390instance FromJSON MandrillDate where
331 parseJSON = withText "MandrillDate" $ \t ->
391 parseJSON = withText "MandrillDate" $ \t ->
332− case parseTime 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
333 Just d -> pure $ MandrillDate d
393 Just d -> pure $ MandrillDate d
334 _ -> fail "could not parse Mandrill date"
394 _ -> fail "could not parse Mandrill date"