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