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