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