@@ -1,35 +1,44 @@
1−{-# LANGUAGE TemplateHaskell #-}
2−{-# LANGUAGE CPP #-}
3−{-# LANGUAGE RankNTypes #-}
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DeriveFoldable #-}
3+{-# LANGUAGE DeriveFunctor #-}
4+{-# LANGUAGE DeriveTraversable #-}
5+{-# LANGUAGE OverloadedStrings #-}
6+{-# LANGUAGE RankNTypes #-}
47{-# LANGUAGE ScopedTypeVariables #-}
5−{-# LANGUAGE OverloadedStrings #-}
8+{-# LANGUAGE TemplateHaskell #-}
69module Network.API.Mandrill.Types where
710
8−import Network.API.Mandrill.Utils
9−import Test.QuickCheck
10−import Text.Email.Validate
11+import Control.Applicative
12+import Control.Monad (mzero)
1113import Data.Char
1214import Data.Maybe
1315import 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
1520#if MIN_VERSION_time(1,5,0)
16−import Data.Time.Format (TimeLocale, defaultTimeLocale)
21+import Data.Time.Format (TimeLocale, defaultTimeLocale)
1722#else
18−import System.Locale (TimeLocale, defaultTimeLocale)
23+import System.Locale (TimeLocale, defaultTimeLocale)
1924#endif
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
25−import Control.Lens
26−import Data.Monoid
2725import Data.Aeson
28−import Data.Aeson.Types
2926import Data.Aeson.TH
30−import qualified Text.Blaze.Html as Blaze
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)
31+import Data.Foldable
32+import Data.Traversable
33+#endif
34+import qualified Data.HashMap.Strict as H
35+import Data.Monoid
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
3140import qualified Text.Blaze.Html.Renderer.Text as Blaze
32−
41+import qualified Text.Email.Validate as TEV
3342
3443timeParse :: ParseTime t => TimeLocale -> String -> String -> Maybe t
3544#if MIN_VERSION_time(1,5,0)
@@ -40,11 +49,11 @@ timeParse = parseTime
4049
4150--------------------------------------------------------------------------------
4251data MandrillError = MandrillError {
43− _merr_status :: !T.Text
44− , _merr_code :: !Int
45− , _merr_name :: !T.Text
52+ _merr_status :: !T.Text
53+ , _merr_code :: !Int
54+ , _merr_name :: !T.Text
4655 , _merr_message :: !T.Text
47− } deriving Show
56+ } deriving (Show, Eq)
4857
4958makeLenses ''MandrillError
5059deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillError
@@ -69,6 +78,7 @@ data MandrillRejectReason = RR_HardBounce
6978 | RR_InvalidSender
7079 | RR_Invalid
7180 | RR_TestModeLimit
81+ | RR_Unsigned
7282 | RR_Rule deriving Show
7383
7484deriveJSON defaultOptions {
@@ -81,7 +91,7 @@ deriveJSON defaultOptions {
8191-- which can be either a success or a failure.
8292data MandrillResponse k =
8393 MandrillSuccess k
84− | MandrillFailure MandrillError deriving Show
94+ | MandrillFailure MandrillError deriving (Show, Eq, Functor, Foldable, Traversable)
8595
8696instance FromJSON k => FromJSON (MandrillResponse k) where
8797 parseJSON v = case (parseMaybe parseJSON v) :: Maybe k of
@@ -117,9 +127,9 @@ instance FromJSON MandrillEmail where
117127data MandrillRecipient = MandrillRecipient {
118128 _mrec_email :: MandrillEmail
119129 -- ^ The email address of the recipient
120− , _mrec_name :: Maybe T.Text
130+ , _mrec_name :: Maybe T.Text
121131 -- ^ The optional display name to use for the recipient
122− , _mrec_type :: Maybe MandrillRecipientTag
132+ , _mrec_type :: Maybe MandrillRecipientTag
123133 -- ^ The header type to use for the recipient.
124134 -- defaults to "to" if not provided
125135 } deriving Show
@@ -148,6 +158,11 @@ unsafeMkMandrillHtml = MandrillHtml . Blaze.preEscapedToHtml
148158mkMandrillHtml :: Blaze.Html -> MandrillHtml
149159mkMandrillHtml = MandrillHtml
150160
161+#if MIN_VERSION_base(4,11,0)
162+instance Semigroup MandrillHtml where
163+ MandrillHtml m1 <> MandrillHtml m2 = MandrillHtml (m1 <> m2)
164+#endif
165+
151166instance Monoid MandrillHtml where
152167 mempty = MandrillHtml mempty
153168 mappend (MandrillHtml m1) (MandrillHtml m2) = MandrillHtml (m1 <> m2)
@@ -170,17 +185,23 @@ type MandrillTags = T.Text
170185
171186
172187--------------------------------------------------------------------------------
173−type MandrillHeaders = Value
188+type MandrillHeaders = Object
174189
175190
176191--------------------------------------------------------------------------------
177−type MandrillVars = Value
178192
193+data MergeVar = MergeVar {
194+ _mv_name :: !T.Text
195+ , _mv_content :: Value
196+ } deriving Show
197+
198+makeLenses ''MergeVar
199+deriveJSON defaultOptions { fieldLabelModifier = drop 4 } ''MergeVar
179200
180201--------------------------------------------------------------------------------
181202data MandrillMergeVars = MandrillMergeVars {
182203 _mmvr_rcpt :: !T.Text
183− , _mmvr_vars :: [MandrillVars]
204+ , _mmvr_vars :: [MergeVar]
184205 } deriving Show
185206
186207makeLenses ''MandrillMergeVars
@@ -188,8 +209,8 @@ deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillMergeVars
188209
189210--------------------------------------------------------------------------------
190211data MandrillMetadata = MandrillMetadata {
191− _mmdt_rcpt :: !T.Text
192− , _mmdt_values :: MandrillVars
212+ _mmdt_rcpt :: !T.Text
213+ , _mmdt_values :: Object
193214 } deriving Show
194215
195216makeLenses ''MandrillMetadata
@@ -213,8 +234,8 @@ instance FromJSON Base64ByteString where
213234
214235--------------------------------------------------------------------------------
215236data MandrillWebContent = MandrillWebContent {
216− _mwct_type :: !T.Text
217− , _mwct_name :: !T.Text
237+ _mwct_type :: !T.Text
238+ , _mwct_name :: !T.Text
218239 -- ^ [for images] the Content ID of the image
219240 -- - use <img src="cid:THIS_VALUE"> to reference the image
220241 -- in your HTML content
@@ -227,67 +248,67 @@ deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillWebContent
227248--------------------------------------------------------------------------------
228249-- | The information on the message to send
229250data MandrillMessage = MandrillMessage {
230− _mmsg_html :: MandrillHtml
251+ _mmsg_html :: MandrillHtml
231252 -- ^ The full HTML content to be sent
232− , _mmsg_text :: Maybe T.Text
253+ , _mmsg_text :: Maybe T.Text
233254 -- ^ Optional full text content to be sent
234− , _mmsg_subject :: !T.Text
255+ , _mmsg_subject :: !T.Text
235256 -- ^ The message subject
236− , _mmsg_from_email :: MandrillEmail
257+ , _mmsg_from_email :: MandrillEmail
237258 -- ^ The sender email address
238− , _mmsg_from_name :: Maybe T.Text
259+ , _mmsg_from_name :: Maybe T.Text
239260 -- ^ Optional from name to be used
240− , _mmsg_to :: [MandrillRecipient]
261+ , _mmsg_to :: [MandrillRecipient]
241262 -- ^ A list of recipient information
242− , _mmsg_headers :: MandrillHeaders
263+ , _mmsg_headers :: MandrillHeaders
243264 -- ^ optional extra headers to add to the message (most headers are allowed)
244− , _mmsg_important :: Maybe Bool
265+ , _mmsg_important :: Maybe Bool
245266 -- ^ whether or not this message is important, and should be delivered ahead
246267 -- of non-important messages
247− , _mmsg_track_opens :: Maybe Bool
268+ , _mmsg_track_opens :: Maybe Bool
248269 -- ^ whether or not to turn on open tracking for the message
249− , _mmsg_track_clicks :: Maybe Bool
270+ , _mmsg_track_clicks :: Maybe Bool
250271 -- ^ whether or not to turn on click tracking for the message
251− , _mmsg_auto_text :: Maybe Bool
272+ , _mmsg_auto_text :: Maybe Bool
252273 -- ^ whether or not to automatically generate a text part for messages that are not given text
253− , _mmsg_auto_html :: Maybe Bool
274+ , _mmsg_auto_html :: Maybe Bool
254275 -- ^ whether or not to automatically generate an HTML part for messages that are not given HTML
255− , _mmsg_inline_css :: Maybe Bool
276+ , _mmsg_inline_css :: Maybe Bool
256277 -- ^ whether or not to automatically inline all CSS styles provided in the message HTML
257278 -- - only for HTML documents less than 256KB in size
258− , _mmsg_url_strip_qs :: Maybe Bool
279+ , _mmsg_url_strip_qs :: Maybe Bool
259280 -- ^ whether or not to strip the query string from URLs when aggregating tracked URL data
260− , _mmsg_preserve_recipients :: Maybe Bool
281+ , _mmsg_preserve_recipients :: Maybe Bool
261282 -- ^ whether or not to expose all recipients in to "To" header for each email
262− , _mmsg_view_content_link :: Maybe Bool
283+ , _mmsg_view_content_link :: Maybe Bool
263284 -- ^ set to false to remove content logging for sensitive emails
264− , _mmsg_bcc_address :: Maybe T.Text
285+ , _mmsg_bcc_address :: Maybe T.Text
265286 -- ^ an optional address to receive an exact copy of each recipient's email
266− , _mmsg_tracking_domain :: Maybe T.Text
287+ , _mmsg_tracking_domain :: Maybe T.Text
267288 -- ^ a custom domain to use for tracking opens and clicks instead of mandrillapp.com
268− , _mmsg_signing_domain :: Maybe Bool
269− -- ^ a custom domain to use for SPF/DKIM signing instead of mandrill
289+ , _mmsg_signing_domain :: Maybe Bool
290+ -- ^ a custom domain to use for SPF/DKIM signing instead of mandrill
270291 -- (for "via" or "on behalf of" in email clients)
271− , _mmsg_return_path_domain :: Maybe Bool
292+ , _mmsg_return_path_domain :: Maybe Bool
272293 -- ^ a custom domain to use for the messages's return-path
273− , _mmsg_merge :: Maybe Bool
294+ , _mmsg_merge :: Maybe Bool
274295 -- ^ whether to evaluate merge tags in the message.
275296 -- Will automatically be set to true if either merge_vars
276297 -- or global_merge_vars are provided.
277− , _mmsg_global_merge_vars :: [MandrillVars]
298+ , _mmsg_global_merge_vars :: [MergeVar]
278299 -- ^ global merge variables to use for all recipients. You can override these per recipient.
279− , _mmsg_merge_vars :: [MandrillMergeVars]
300+ , _mmsg_merge_vars :: [MandrillMergeVars]
280301 -- ^ per-recipient merge variables, which override global merge variables with the same name.
281− , _mmsg_tags :: [MandrillTags]
302+ , _mmsg_tags :: [MandrillTags]
282303 -- ^ an array of string to tag the message with. Stats are accumulated using tags,
283304 -- though we only store the first 100 we see, so this should not be unique
284305 -- or change frequently. Tags should be 50 characters or less.
285306 -- Any tags starting with an underscore are reserved for internal use
286307 -- and will cause errors.
287− , _mmsg_subaccount :: Maybe T.Text
308+ , _mmsg_subaccount :: Maybe T.Text
288309 -- ^ the unique id of a subaccount for this message
289310 -- - must already exist or will fail with an error
290− , _mmsg_google_analytics_domains :: [T.Text]
311+ , _mmsg_google_analytics_domains :: [T.Text]
291312 -- ^ an array of strings indicating for which any matching URLs
292313 -- will automatically have Google Analytics parameters appended
293314 -- to their query string automatically.
@@ -295,17 +316,17 @@ data MandrillMessage = MandrillMessage {
295316 -- ^ optional string indicating the value to set for the utm_campaign
296317 -- tracking parameter. If this isn't provided the email's from address
297318 -- will be used instead.
298− , _mmsg_metadata :: MandrillVars
319+ , _mmsg_metadata :: Object
299320 -- ^ metadata an associative array of user metadata. Mandrill will store
300321 -- this metadata and make it available for retrieval.
301322 -- In addition, you can select up to 10 metadata fields to index
302323 -- and make searchable using the Mandrill search api.
303− , _mmsg_recipient_metadata :: [MandrillMetadata]
324+ , _mmsg_recipient_metadata :: [MandrillMetadata]
304325 -- ^ Per-recipient metadata that will override the global values
305326 -- specified in the metadata parameter.
306− , _mmsg_attachments :: [MandrillWebContent]
327+ , _mmsg_attachments :: [MandrillWebContent]
307328 -- ^ an array of supported attachments to add to the message
308− , _mmsg_images :: [MandrillWebContent]
329+ , _mmsg_images :: [MandrillWebContent]
309330 -- ^ an array of embedded images to add to the message
310331 } deriving Show
311332
@@ -319,7 +340,7 @@ instance Arbitrary MandrillMessage where
319340 <*> pure (MandrillEmail . fromJust $ emailAddress "sender@example.com")
320341 <*> pure Nothing
321342 <*> resize 2 arbitrary
322− <*> pure emptyObject
343+ <*> pure H.empty
323344 <*> pure Nothing
324345 <*> pure Nothing
325346 <*> pure Nothing
@@ -340,7 +361,7 @@ instance Arbitrary MandrillMessage where
340361 <*> pure Nothing
341362 <*> pure []
342363 <*> pure Nothing
343− <*> pure emptyObject
364+ <*> pure H.empty
344365 <*> pure []
345366 <*> pure []
346367 <*> pure []