@@ -1,34 +1,59 @@
1−{-# LANGUAGE TemplateHaskell #-}
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DeriveFoldable #-}
3+{-# LANGUAGE DeriveFunctor #-}
4+{-# LANGUAGE DeriveTraversable #-}
5+{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE RankNTypes #-}
6+{-# LANGUAGE RankNTypes #-}
3{-# LANGUAGE ScopedTypeVariables #-}
7{-# LANGUAGE ScopedTypeVariables #-}
4−{-# LANGUAGE OverloadedStrings #-}
8+{-# LANGUAGE TemplateHaskell #-}
5module Network.API.Mandrill.Types where
9module Network.API.Mandrill.Types where
7−import Network.API.Mandrill.Utils
11+import Control.Applicative
8−import Test.QuickCheck
12+import Control.Monad (mzero)
9import Data.Char
13import Data.Char
10import Data.Time
15import Data.Time
11−import Control.Applicative
16+import Lens.Micro.TH (makeLenses)
17+import Network.API.Mandrill.Utils
18+import Test.QuickCheck
19+import Text.Email.Validate
20+#if MIN_VERSION_time(1,5,0)
21+import Data.Time.Format (TimeLocale, defaultTimeLocale)
12−import System.Locale (defaultTimeLocale)
23+import System.Locale (TimeLocale, defaultTimeLocale)
13−import qualified Data.Text as T
24+#endif
14−import qualified Data.Text.Lazy as TL
18import Data.Aeson
25import Data.Aeson
19−import Data.Aeson.Types
20import 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
21−import qualified Text.Blaze.Html as Blaze
39+import qualified Text.Blaze.Html as Blaze
22import qualified Text.Blaze.Html.Renderer.Text as Blaze
40import qualified Text.Blaze.Html.Renderer.Text as Blaze
41+import qualified Text.Email.Validate as TEV
43+timeParse :: ParseTime t => TimeLocale -> String -> String -> Maybe t
44+#if MIN_VERSION_time(1,5,0)
45+timeParse = parseTimeM True
25--------------------------------------------------------------------------------
50--------------------------------------------------------------------------------
26data MandrillError = MandrillError {
51data MandrillError = MandrillError {
27− _merr_status :: !T.Text
52+ _merr_status :: !T.Text
28− , _merr_code :: !Int
53+ , _merr_code :: !Int
29− , _merr_name :: !T.Text
54+ , _merr_name :: !T.Text
30 , _merr_message :: !T.Text
55 , _merr_message :: !T.Text
31− } deriving Show
56+ } deriving (Show, Eq)
33makeLenses ''MandrillError
58makeLenses ''MandrillError
34deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillError
59deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillError
@@ -53,6 +78,7 @@ data MandrillRejectReason = RR_HardBounce
53 | RR_InvalidSender
78 | RR_InvalidSender
54 | RR_Invalid
79 | RR_Invalid
55 | RR_TestModeLimit
80 | RR_TestModeLimit
56 | RR_Rule deriving Show
82 | RR_Rule deriving Show
58deriveJSON defaultOptions {
84deriveJSON defaultOptions {
@@ -64,17 +90,17 @@ deriveJSON defaultOptions {
64-- | The main datatypes which models the response from the Mandrill API,
90-- | The main datatypes which models the response from the Mandrill API,
65-- which can be either a success or a failure.
91-- which can be either a success or a failure.
66data MandrillResponse k =
92data MandrillResponse k =
67− MandrillSuccess [k]
93+ MandrillSuccess k
68− | MandrillFailure MandrillError deriving Show
94+ | MandrillFailure MandrillError deriving (Show, Eq, Functor, Foldable, Traversable)
70instance FromJSON k => FromJSON (MandrillResponse k) where
96instance FromJSON k => FromJSON (MandrillResponse k) where
71− parseJSON a@(Array _) = case (parseMaybe parseJSON a) :: Maybe [k] of
97+ parseJSON v = case (parseMaybe parseJSON v) :: Maybe k of
72 Just r -> return $ MandrillSuccess r
98 Just r -> return $ MandrillSuccess r
73− Nothing -> fail $ show a <> " is not a valid MandrillSuccess"
99+ Nothing -> do
100+ -- try to parse it as an error
74− parseJSON o@(Object _) = case (parseMaybe parseJSON o) :: Maybe MandrillError of
101+ case (parseMaybe parseJSON v) :: Maybe MandrillError of
75− Just e -> return $ MandrillFailure e
102+ Just e -> return $ MandrillFailure e
76− Nothing -> fail $ show o <> " is not a valid MandrillError"
103+ Nothing -> fail $ show v <> " is neither a MandrillSuccess or a MandrillError."
77− parseJSON v = typeMismatch "Expected an Object or an Array for MandrillResponse" v
80--------------------------------------------------------------------------------
106--------------------------------------------------------------------------------
@@ -83,14 +109,27 @@ data MandrillRecipientTag = To | Cc | Bcc deriving Show
83deriveJSON defaultOptions { constructorTagModifier = map toLower } ''MandrillRecipientTag
109deriveJSON 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
86--------------------------------------------------------------------------------
125--------------------------------------------------------------------------------
87-- | An array of recipient information.
126-- | An array of recipient information.
88data MandrillRecipient = MandrillRecipient {
127data MandrillRecipient = MandrillRecipient {
89− _mrec_email :: !T.Text
128+ _mrec_email :: MandrillEmail
90 -- ^ The email address of the recipient
129 -- ^ The email address of the recipient
91− , _mrec_name :: Maybe T.Text
130+ , _mrec_name :: Maybe T.Text
92 -- ^ The optional display name to use for the recipient
131 -- ^ The optional display name to use for the recipient
93− , _mrec_type :: Maybe MandrillRecipientTag
132+ , _mrec_type :: Maybe MandrillRecipientTag
94 -- ^ The header type to use for the recipient.
133 -- ^ The header type to use for the recipient.
95 -- defaults to "to" if not provided
134 -- defaults to "to" if not provided
96 } deriving Show
135 } deriving Show
@@ -98,17 +137,35 @@ data MandrillRecipient = MandrillRecipient {
98makeLenses ''MandrillRecipient
137makeLenses ''MandrillRecipient
99deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillRecipient
138deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillRecipient
140+newRecipient :: EmailAddress -> MandrillRecipient
141+newRecipient email = MandrillRecipient (MandrillEmail email) Nothing Nothing
101instance Arbitrary MandrillRecipient where
143instance Arbitrary MandrillRecipient where
102− arbitrary = pure $ MandrillRecipient "test@example.com" Nothing Nothing
144+ arbitrary = pure MandrillRecipient {
145+ _mrec_email = MandrillEmail $ fromJust (emailAddress "test@example.com")
146+ , _mrec_name = Nothing
147+ , _mrec_type = Nothing
104--------------------------------------------------------------------------------
150--------------------------------------------------------------------------------
105newtype MandrillHtml = MandrillHtml Blaze.Html
151newtype MandrillHtml = MandrillHtml Blaze.Html
107−mkMandrillHtml :: T.Text -> MandrillHtml
153+unsafeMkMandrillHtml :: T.Text -> MandrillHtml
108−mkMandrillHtml = MandrillHtml . Blaze.toHtml
154+unsafeMkMandrillHtml = MandrillHtml . Blaze.preEscapedToHtml
156+-- This might be slightly hairy because it violates
157+-- the nice encapsulation that newtypes offer.
110−mkMandrillHtml' :: Blaze.Html -> MandrillHtml
158+mkMandrillHtml :: Blaze.Html -> MandrillHtml
111−mkMandrillHtml' = MandrillHtml
159+mkMandrillHtml = MandrillHtml
161+#if MIN_VERSION_base(4,11,0)
162+instance Semigroup MandrillHtml where
163+ MandrillHtml m1 <> MandrillHtml m2 = MandrillHtml (m1 <> m2)
166+instance Monoid MandrillHtml where
167+ mempty = MandrillHtml mempty
168+ mappend (MandrillHtml m1) (MandrillHtml m2) = MandrillHtml (m1 <> m2)
113instance Show MandrillHtml where
170instance Show MandrillHtml where
114 show (MandrillHtml h) = show $ Blaze.renderHtml h
171 show (MandrillHtml h) = show $ Blaze.renderHtml h
@@ -117,27 +174,160 @@ instance ToJSON MandrillHtml where
117 toJSON (MandrillHtml h) = String . TL.toStrict . Blaze.renderHtml $ h
174 toJSON (MandrillHtml h) = String . TL.toStrict . Blaze.renderHtml $ h
119instance FromJSON MandrillHtml where
176instance FromJSON MandrillHtml where
120− parseJSON (String h) = return $ MandrillHtml (Blaze.toHtml h)
177+ parseJSON (String h) = return $ MandrillHtml (Blaze.preEscapedToHtml h)
121 parseJSON v = typeMismatch "Expecting a String for MandrillHtml" v
178 parseJSON v = typeMismatch "Expecting a String for MandrillHtml" v
123instance Arbitrary MandrillHtml where
180instance Arbitrary MandrillHtml where
124 arbitrary = pure $ mkMandrillHtml "<p><b>FooBar</b></p>"
181 arbitrary = pure $ mkMandrillHtml "<p><b>FooBar</b></p>"
183+--------------------------------------------------------------------------------
184+type MandrillTags = T.Text
187+--------------------------------------------------------------------------------
188+type MandrillHeaders = Object
191+--------------------------------------------------------------------------------
193+data MergeVar = MergeVar {
195+ , _mv_content :: Value
198+makeLenses ''MergeVar
199+deriveJSON defaultOptions { fieldLabelModifier = drop 4 } ''MergeVar
201+--------------------------------------------------------------------------------
202+data MandrillMergeVars = MandrillMergeVars {
203+ _mmvr_rcpt :: !T.Text
204+ , _mmvr_vars :: [MergeVar]
207+makeLenses ''MandrillMergeVars
208+deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillMergeVars
210+--------------------------------------------------------------------------------
211+data MandrillMetadata = MandrillMetadata {
212+ _mmdt_rcpt :: !T.Text
213+ , _mmdt_values :: Object
216+makeLenses ''MandrillMetadata
217+deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillMetadata
220+data Base64ByteString =
221+ EncodedB64BS B.ByteString
222+ -- ^ An already-encoded Base64 ByteString.
223+ | PlainBS B.ByteString
224+ -- ^ A plain Base64 ByteString which requires encoding.
227+instance ToJSON Base64ByteString where
228+ toJSON (PlainBS bs) = String . TL.decodeUtf8 . Base64.encode $ bs
229+ toJSON (EncodedB64BS bs) = String . TL.decodeUtf8 $ bs
231+instance FromJSON Base64ByteString where
232+ parseJSON (String v) = pure $ EncodedB64BS (TL.encodeUtf8 v)
233+ parseJSON rest = typeMismatch "Base64ByteString must be a String." rest
235+--------------------------------------------------------------------------------
236+data MandrillWebContent = MandrillWebContent {
237+ _mwct_type :: !T.Text
238+ , _mwct_name :: !T.Text
239+ -- ^ [for images] the Content ID of the image
240+ -- - use <img src="cid:THIS_VALUE"> to reference the image
241+ -- in your HTML content
242+ , _mwct_content :: !Base64ByteString
245+makeLenses ''MandrillWebContent
246+deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillWebContent
126--------------------------------------------------------------------------------
248--------------------------------------------------------------------------------
127-- | The information on the message to send
249-- | The information on the message to send
128data MandrillMessage = MandrillMessage {
250data MandrillMessage = MandrillMessage {
129− _mmsg_html :: MandrillHtml
251+ _mmsg_html :: MandrillHtml
130 -- ^ The full HTML content to be sent
252 -- ^ The full HTML content to be sent
131− , _mmsg_text :: Maybe T.Text
253+ , _mmsg_text :: Maybe T.Text
132 -- ^ Optional full text content to be sent
254 -- ^ Optional full text content to be sent
133− , _mmsg_subject :: !T.Text
255+ , _mmsg_subject :: !T.Text
134 -- ^ The message subject
256 -- ^ The message subject
135− , _mmsg_from_email :: !T.Text
257+ , _mmsg_from_email :: MandrillEmail
136 -- ^ The sender email address
258 -- ^ The sender email address
137− , _mmsg_from_name :: Maybe T.Text
259+ , _mmsg_from_name :: Maybe T.Text
138 -- ^ Optional from name to be used
260 -- ^ Optional from name to be used
139− , _mmsg_to :: [MandrillRecipient]
261+ , _mmsg_to :: [MandrillRecipient]
140 -- ^ A list of recipient information
262 -- ^ A list of recipient information
263+ , _mmsg_headers :: MandrillHeaders
264+ -- ^ optional extra headers to add to the message (most headers are allowed)
265+ , _mmsg_important :: Maybe Bool
266+ -- ^ whether or not this message is important, and should be delivered ahead
267+ -- of non-important messages
268+ , _mmsg_track_opens :: Maybe Bool
269+ -- ^ whether or not to turn on open tracking for the message
270+ , _mmsg_track_clicks :: Maybe Bool
271+ -- ^ whether or not to turn on click tracking for the message
272+ , _mmsg_auto_text :: Maybe Bool
273+ -- ^ whether or not to automatically generate a text part for messages that are not given text
274+ , _mmsg_auto_html :: Maybe Bool
275+ -- ^ whether or not to automatically generate an HTML part for messages that are not given HTML
276+ , _mmsg_inline_css :: Maybe Bool
277+ -- ^ whether or not to automatically inline all CSS styles provided in the message HTML
278+ -- - only for HTML documents less than 256KB in size
279+ , _mmsg_url_strip_qs :: Maybe Bool
280+ -- ^ whether or not to strip the query string from URLs when aggregating tracked URL data
281+ , _mmsg_preserve_recipients :: Maybe Bool
282+ -- ^ whether or not to expose all recipients in to "To" header for each email
283+ , _mmsg_view_content_link :: Maybe Bool
284+ -- ^ set to false to remove content logging for sensitive emails
285+ , _mmsg_bcc_address :: Maybe T.Text
286+ -- ^ an optional address to receive an exact copy of each recipient's email
287+ , _mmsg_tracking_domain :: Maybe T.Text
288+ -- ^ a custom domain to use for tracking opens and clicks instead of mandrillapp.com
289+ , _mmsg_signing_domain :: Maybe Bool
290+ -- ^ a custom domain to use for SPF/DKIM signing instead of mandrill
291+ -- (for "via" or "on behalf of" in email clients)
292+ , _mmsg_return_path_domain :: Maybe Bool
293+ -- ^ a custom domain to use for the messages's return-path
294+ , _mmsg_merge :: Maybe Bool
295+ -- ^ whether to evaluate merge tags in the message.
296+ -- Will automatically be set to true if either merge_vars
297+ -- or global_merge_vars are provided.
298+ , _mmsg_global_merge_vars :: [MergeVar]
299+ -- ^ global merge variables to use for all recipients. You can override these per recipient.
300+ , _mmsg_merge_vars :: [MandrillMergeVars]
301+ -- ^ per-recipient merge variables, which override global merge variables with the same name.
302+ , _mmsg_tags :: [MandrillTags]
303+ -- ^ 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
305+ -- or change frequently. Tags should be 50 characters or less.
306+ -- Any tags starting with an underscore are reserved for internal use
307+ -- and will cause errors.
308+ , _mmsg_subaccount :: Maybe T.Text
309+ -- ^ the unique id of a subaccount for this message
310+ -- - must already exist or will fail with an error
311+ , _mmsg_google_analytics_domains :: [T.Text]
312+ -- ^ an array of strings indicating for which any matching URLs
313+ -- will automatically have Google Analytics parameters appended
314+ -- to their query string automatically.
315+ , _mmsg_google_analytics_campaign :: Maybe T.Text
316+ -- ^ optional string indicating the value to set for the utm_campaign
317+ -- tracking parameter. If this isn't provided the email's from address
318+ -- will be used instead.
319+ , _mmsg_metadata :: Object
320+ -- ^ metadata an associative array of user metadata. Mandrill will store
321+ -- this metadata and make it available for retrieval.
322+ -- In addition, you can select up to 10 metadata fields to index
323+ -- and make searchable using the Mandrill search api.
324+ , _mmsg_recipient_metadata :: [MandrillMetadata]
325+ -- ^ Per-recipient metadata that will override the global values
326+ -- specified in the metadata parameter.
327+ , _mmsg_attachments :: [MandrillWebContent]
328+ -- ^ an array of supported attachments to add to the message
329+ , _mmsg_images :: [MandrillWebContent]
330+ -- ^ an array of embedded images to add to the message
141 } deriving Show
331 } deriving Show
143makeLenses ''MandrillMessage
333makeLenses ''MandrillMessage
@@ -147,12 +337,48 @@ instance Arbitrary MandrillMessage where
147 arbitrary = MandrillMessage <$> arbitrary
337 arbitrary = MandrillMessage <$> arbitrary
148 <*> pure Nothing
338 <*> pure Nothing
149 <*> pure "Test Subject"
339 <*> pure "Test Subject"
150− <*> pure "sender@example.com"
340+ <*> pure (MandrillEmail . fromJust $ emailAddress "sender@example.com")
151 <*> pure Nothing
341 <*> pure Nothing
152 <*> resize 2 arbitrary
342 <*> resize 2 arbitrary
369+--------------------------------------------------------------------------------
370+-- | Key value pair for replacing content in templates via 'Editable Regions'
371+data MandrillTemplateContent = MandrillTemplateContent {
373+ , _mtc_content :: T.Text
376+makeLenses ''MandrillTemplateContent
377+deriveJSON defaultOptions { fieldLabelModifier = drop 5 } ''MandrillTemplateContent
154--------------------------------------------------------------------------------
379--------------------------------------------------------------------------------
155type MandrillKey = T.Text
380type MandrillKey = T.Text
381+type MandrillTemplate = T.Text
157newtype MandrillDate = MandrillDate {
383newtype MandrillDate = MandrillDate {
158 fromMandrillDate :: UTCTime
384 fromMandrillDate :: UTCTime
@@ -163,6 +389,6 @@ instance ToJSON MandrillDate where
164instance FromJSON MandrillDate where
390instance FromJSON MandrillDate where
165 parseJSON = withText "MandrillDate" $ \t ->
391 parseJSON = withText "MandrillDate" $ \t ->
166− case parseTime defaultTimeLocale "%Y-%m-%d %I:%M:%S%Q" (T.unpack t) of
392+ case timeParse defaultTimeLocale "%Y-%m-%d %I:%M:%S%Q" (T.unpack t) of
167 Just d -> pure $ MandrillDate d
393 Just d -> pure $ MandrillDate d
168 _ -> fail "could not parse Mandrill date"
394 _ -> fail "could not parse Mandrill date"