@@ -1,36 +1,44 @@
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 Test.QuickCheck
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
15#if MIN_VERSION_time(1,5,0)
20#if MIN_VERSION_time(1,5,0)
16−import Data.Time.Format (TimeLocale, defaultTimeLocale)
21+import Data.Time.Format (TimeLocale, defaultTimeLocale)
18−import System.Locale (TimeLocale, defaultTimeLocale)
23+import System.Locale (TimeLocale, defaultTimeLocale)
20−import qualified Data.ByteString as B
21−import qualified Data.ByteString.Base64 as Base64
22−import qualified Data.HashMap.Strict as H
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
33−
41+import qualified Text.Email.Validate as TEV
35timeParse :: ParseTime t => TimeLocale -> String -> String -> Maybe t
43timeParse :: ParseTime t => TimeLocale -> String -> String -> Maybe t
36#if MIN_VERSION_time(1,5,0)
44#if MIN_VERSION_time(1,5,0)
@@ -41,11 +49,11 @@ timeParse = parseTime
42--------------------------------------------------------------------------------
50--------------------------------------------------------------------------------
43data MandrillError = MandrillError {
51data MandrillError = MandrillError {
44− _merr_status :: !T.Text
52+ _merr_status :: !T.Text
45− , _merr_code :: !Int
53+ , _merr_code :: !Int
46− , _merr_name :: !T.Text
54+ , _merr_name :: !T.Text
47 , _merr_message :: !T.Text
55 , _merr_message :: !T.Text
48− } deriving Show
56+ } deriving (Show, Eq)
50makeLenses ''MandrillError
58makeLenses ''MandrillError
51deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillError
59deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillError
@@ -70,6 +78,7 @@ data MandrillRejectReason = RR_HardBounce
70 | RR_InvalidSender
78 | RR_InvalidSender
71 | RR_Invalid
79 | RR_Invalid
72 | RR_TestModeLimit
80 | RR_TestModeLimit
73 | RR_Rule deriving Show
82 | RR_Rule deriving Show
75deriveJSON defaultOptions {
84deriveJSON defaultOptions {
@@ -82,7 +91,7 @@ deriveJSON defaultOptions {
82-- which can be either a success or a failure.
91-- which can be either a success or a failure.
83data MandrillResponse k =
92data MandrillResponse k =
84 MandrillSuccess k
93 MandrillSuccess k
85− | MandrillFailure MandrillError deriving Show
94+ | MandrillFailure MandrillError deriving (Show, Eq, Functor, Foldable, Traversable)
87instance FromJSON k => FromJSON (MandrillResponse k) where
96instance FromJSON k => FromJSON (MandrillResponse k) where
88 parseJSON v = case (parseMaybe parseJSON v) :: Maybe k of
97 parseJSON v = case (parseMaybe parseJSON v) :: Maybe k of
@@ -118,9 +127,9 @@ instance FromJSON MandrillEmail where
118data MandrillRecipient = MandrillRecipient {
127data MandrillRecipient = MandrillRecipient {
119 _mrec_email :: MandrillEmail
128 _mrec_email :: MandrillEmail
120 -- ^ The email address of the recipient
129 -- ^ The email address of the recipient
121− , _mrec_name :: Maybe T.Text
130+ , _mrec_name :: Maybe T.Text
122 -- ^ The optional display name to use for the recipient
131 -- ^ The optional display name to use for the recipient
123− , _mrec_type :: Maybe MandrillRecipientTag
132+ , _mrec_type :: Maybe MandrillRecipientTag
124 -- ^ The header type to use for the recipient.
133 -- ^ The header type to use for the recipient.
125 -- defaults to "to" if not provided
134 -- defaults to "to" if not provided
126 } deriving Show
135 } deriving Show
@@ -149,6 +158,11 @@ unsafeMkMandrillHtml = MandrillHtml . Blaze.preEscapedToHtml
149mkMandrillHtml :: Blaze.Html -> MandrillHtml
158mkMandrillHtml :: Blaze.Html -> MandrillHtml
150mkMandrillHtml = MandrillHtml
159mkMandrillHtml = MandrillHtml
161+#if MIN_VERSION_base(4,11,0)
162+instance Semigroup MandrillHtml where
163+ MandrillHtml m1 <> MandrillHtml m2 = MandrillHtml (m1 <> m2)
152instance Monoid MandrillHtml where
166instance Monoid MandrillHtml where
153 mempty = MandrillHtml mempty
167 mempty = MandrillHtml mempty
154 mappend (MandrillHtml m1) (MandrillHtml m2) = MandrillHtml (m1 <> m2)
168 mappend (MandrillHtml m1) (MandrillHtml m2) = MandrillHtml (m1 <> m2)
@@ -175,13 +189,19 @@ type MandrillHeaders = Object
177--------------------------------------------------------------------------------
191--------------------------------------------------------------------------------
178−type MandrillVars = Value
193+data MergeVar = MergeVar {
195+ , _mv_content :: Value
198+makeLenses ''MergeVar
199+deriveJSON defaultOptions { fieldLabelModifier = drop 4 } ''MergeVar
181--------------------------------------------------------------------------------
201--------------------------------------------------------------------------------
182data MandrillMergeVars = MandrillMergeVars {
202data MandrillMergeVars = MandrillMergeVars {
183 _mmvr_rcpt :: !T.Text
203 _mmvr_rcpt :: !T.Text
184− , _mmvr_vars :: [MandrillVars]
204+ , _mmvr_vars :: [MergeVar]
185 } deriving Show
205 } deriving Show
187makeLenses ''MandrillMergeVars
207makeLenses ''MandrillMergeVars
@@ -189,8 +209,8 @@ deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillMergeVars
190--------------------------------------------------------------------------------
210--------------------------------------------------------------------------------
191data MandrillMetadata = MandrillMetadata {
211data MandrillMetadata = MandrillMetadata {
192− _mmdt_rcpt :: !T.Text
212+ _mmdt_rcpt :: !T.Text
193− , _mmdt_values :: MandrillVars
213+ , _mmdt_values :: Object
194 } deriving Show
214 } deriving Show
196makeLenses ''MandrillMetadata
216makeLenses ''MandrillMetadata
@@ -214,8 +234,8 @@ instance FromJSON Base64ByteString where
215--------------------------------------------------------------------------------
235--------------------------------------------------------------------------------
216data MandrillWebContent = MandrillWebContent {
236data MandrillWebContent = MandrillWebContent {
217− _mwct_type :: !T.Text
237+ _mwct_type :: !T.Text
218− , _mwct_name :: !T.Text
238+ , _mwct_name :: !T.Text
219 -- ^ [for images] the Content ID of the image
239 -- ^ [for images] the Content ID of the image
220 -- - use <img src="cid:THIS_VALUE"> to reference the image
240 -- - use <img src="cid:THIS_VALUE"> to reference the image
221 -- in your HTML content
241 -- in your HTML content
@@ -228,67 +248,67 @@ deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillWebContent
228--------------------------------------------------------------------------------
248--------------------------------------------------------------------------------
229-- | The information on the message to send
249-- | The information on the message to send
230data MandrillMessage = MandrillMessage {
250data MandrillMessage = MandrillMessage {
231− _mmsg_html :: MandrillHtml
251+ _mmsg_html :: MandrillHtml
232 -- ^ The full HTML content to be sent
252 -- ^ The full HTML content to be sent
233− , _mmsg_text :: Maybe T.Text
253+ , _mmsg_text :: Maybe T.Text
234 -- ^ Optional full text content to be sent
254 -- ^ Optional full text content to be sent
235− , _mmsg_subject :: !T.Text
255+ , _mmsg_subject :: !T.Text
236 -- ^ The message subject
256 -- ^ The message subject
237− , _mmsg_from_email :: MandrillEmail
257+ , _mmsg_from_email :: MandrillEmail
238 -- ^ The sender email address
258 -- ^ The sender email address
239− , _mmsg_from_name :: Maybe T.Text
259+ , _mmsg_from_name :: Maybe T.Text
240 -- ^ Optional from name to be used
260 -- ^ Optional from name to be used
241− , _mmsg_to :: [MandrillRecipient]
261+ , _mmsg_to :: [MandrillRecipient]
242 -- ^ A list of recipient information
262 -- ^ A list of recipient information
243− , _mmsg_headers :: MandrillHeaders
263+ , _mmsg_headers :: MandrillHeaders
244 -- ^ 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)
245− , _mmsg_important :: Maybe Bool
265+ , _mmsg_important :: Maybe Bool
246 -- ^ 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
247 -- of non-important messages
267 -- of non-important messages
248− , _mmsg_track_opens :: Maybe Bool
268+ , _mmsg_track_opens :: Maybe Bool
249 -- ^ whether or not to turn on open tracking for the message
269 -- ^ whether or not to turn on open tracking for the message
250− , _mmsg_track_clicks :: Maybe Bool
270+ , _mmsg_track_clicks :: Maybe Bool
251 -- ^ whether or not to turn on click tracking for the message
271 -- ^ whether or not to turn on click tracking for the message
252− , _mmsg_auto_text :: Maybe Bool
272+ , _mmsg_auto_text :: Maybe Bool
253 -- ^ 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
254− , _mmsg_auto_html :: Maybe Bool
274+ , _mmsg_auto_html :: Maybe Bool
255 -- ^ 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
256− , _mmsg_inline_css :: Maybe Bool
276+ , _mmsg_inline_css :: Maybe Bool
257 -- ^ 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
258 -- - only for HTML documents less than 256KB in size
278 -- - only for HTML documents less than 256KB in size
259− , _mmsg_url_strip_qs :: Maybe Bool
279+ , _mmsg_url_strip_qs :: Maybe Bool
260 -- ^ 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
261− , _mmsg_preserve_recipients :: Maybe Bool
281+ , _mmsg_preserve_recipients :: Maybe Bool
262 -- ^ 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
263− , _mmsg_view_content_link :: Maybe Bool
283+ , _mmsg_view_content_link :: Maybe Bool
264 -- ^ set to false to remove content logging for sensitive emails
284 -- ^ set to false to remove content logging for sensitive emails
265− , _mmsg_bcc_address :: Maybe T.Text
285+ , _mmsg_bcc_address :: Maybe T.Text
266 -- ^ 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
267− , _mmsg_tracking_domain :: Maybe T.Text
287+ , _mmsg_tracking_domain :: Maybe T.Text
268 -- ^ 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
269− , _mmsg_signing_domain :: Maybe Bool
289+ , _mmsg_signing_domain :: Maybe Bool
270 -- ^ 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
271 -- (for "via" or "on behalf of" in email clients)
291 -- (for "via" or "on behalf of" in email clients)
272− , _mmsg_return_path_domain :: Maybe Bool
292+ , _mmsg_return_path_domain :: Maybe Bool
273 -- ^ a custom domain to use for the messages's return-path
293 -- ^ a custom domain to use for the messages's return-path
274− , _mmsg_merge :: Maybe Bool
294+ , _mmsg_merge :: Maybe Bool
275 -- ^ whether to evaluate merge tags in the message.
295 -- ^ whether to evaluate merge tags in the message.
276 -- Will automatically be set to true if either merge_vars
296 -- Will automatically be set to true if either merge_vars
277 -- or global_merge_vars are provided.
297 -- or global_merge_vars are provided.
278− , _mmsg_global_merge_vars :: [MandrillVars]
298+ , _mmsg_global_merge_vars :: [MergeVar]
279 -- ^ 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.
280− , _mmsg_merge_vars :: [MandrillMergeVars]
300+ , _mmsg_merge_vars :: [MandrillMergeVars]
281 -- ^ 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.
282− , _mmsg_tags :: [MandrillTags]
302+ , _mmsg_tags :: [MandrillTags]
283 -- ^ 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,
284 -- 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
285 -- or change frequently. Tags should be 50 characters or less.
305 -- or change frequently. Tags should be 50 characters or less.
286 -- Any tags starting with an underscore are reserved for internal use
306 -- Any tags starting with an underscore are reserved for internal use
287 -- and will cause errors.
307 -- and will cause errors.
288− , _mmsg_subaccount :: Maybe T.Text
308+ , _mmsg_subaccount :: Maybe T.Text
289 -- ^ the unique id of a subaccount for this message
309 -- ^ the unique id of a subaccount for this message
290 -- - must already exist or will fail with an error
310 -- - must already exist or will fail with an error
291− , _mmsg_google_analytics_domains :: [T.Text]
311+ , _mmsg_google_analytics_domains :: [T.Text]
292 -- ^ an array of strings indicating for which any matching URLs
312 -- ^ an array of strings indicating for which any matching URLs
293 -- will automatically have Google Analytics parameters appended
313 -- will automatically have Google Analytics parameters appended
294 -- to their query string automatically.
314 -- to their query string automatically.
@@ -296,17 +316,17 @@ data MandrillMessage = MandrillMessage {
296 -- ^ optional string indicating the value to set for the utm_campaign
316 -- ^ optional string indicating the value to set for the utm_campaign
297 -- 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
298 -- will be used instead.
318 -- will be used instead.
299− , _mmsg_metadata :: MandrillVars
319+ , _mmsg_metadata :: Object
300 -- ^ metadata an associative array of user metadata. Mandrill will store
320 -- ^ metadata an associative array of user metadata. Mandrill will store
301 -- this metadata and make it available for retrieval.
321 -- this metadata and make it available for retrieval.
302 -- 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
303 -- and make searchable using the Mandrill search api.
323 -- and make searchable using the Mandrill search api.
304− , _mmsg_recipient_metadata :: [MandrillMetadata]
324+ , _mmsg_recipient_metadata :: [MandrillMetadata]
305 -- ^ Per-recipient metadata that will override the global values
325 -- ^ Per-recipient metadata that will override the global values
306 -- specified in the metadata parameter.
326 -- specified in the metadata parameter.
307− , _mmsg_attachments :: [MandrillWebContent]
327+ , _mmsg_attachments :: [MandrillWebContent]
308 -- ^ an array of supported attachments to add to the message
328 -- ^ an array of supported attachments to add to the message
309− , _mmsg_images :: [MandrillWebContent]
329+ , _mmsg_images :: [MandrillWebContent]
310 -- ^ an array of embedded images to add to the message
330 -- ^ an array of embedded images to add to the message
311 } deriving Show
331 } deriving Show
@@ -341,7 +361,7 @@ instance Arbitrary MandrillMessage where
341 <*> pure Nothing
361 <*> pure Nothing
342 <*> pure []
362 <*> pure []
343 <*> pure Nothing
363 <*> pure Nothing
344− <*> pure emptyObject
364+ <*> pure H.empty
345 <*> pure []
365 <*> pure []
346 <*> pure []
366 <*> pure []
347 <*> pure []
367 <*> pure []