@@ -1,37 +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 Network.API.Mandrill.Orphans()
10−import Test.QuickCheck
11−import Text.Email.Validate
11+import Control.Applicative
12+import Control.Monad (mzero)
1213import Data.Char
1314import Data.Maybe
1415import Data.Time
15−import Control.Applicative
16−import Data.Time (ParseTime)
16+import Lens.Micro.TH (makeLenses)
17+import Network.API.Mandrill.Utils
18+import Test.QuickCheck
19+import Text.Email.Validate
1720#if MIN_VERSION_time(1,5,0)
18−import Data.Time.Format (TimeLocale, defaultTimeLocale)
21+import Data.Time.Format (TimeLocale, defaultTimeLocale)
1922#else
20−import System.Locale (TimeLocale, defaultTimeLocale)
23+import System.Locale (TimeLocale, defaultTimeLocale)
2124#endif
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
27−import Control.Lens
28−import Data.Monoid
2925import Data.Aeson
30−import Data.Aeson.Types
3126import Data.Aeson.TH
32−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
3340import qualified Text.Blaze.Html.Renderer.Text as Blaze
34−
41+import qualified Text.Email.Validate as TEV
3542
3643timeParse :: ParseTime t => TimeLocale -> String -> String -> Maybe t
3744#if MIN_VERSION_time(1,5,0)
@@ -42,11 +49,11 @@ timeParse = parseTime
4249
4350--------------------------------------------------------------------------------
4451data MandrillError = MandrillError {
45− _merr_status :: !T.Text
46− , _merr_code :: !Int
47− , _merr_name :: !T.Text
52+ _merr_status :: !T.Text
53+ , _merr_code :: !Int
54+ , _merr_name :: !T.Text
4855 , _merr_message :: !T.Text
49− } deriving Show
56+ } deriving (Show, Eq)
5057
5158makeLenses ''MandrillError
5259deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillError
@@ -71,6 +78,7 @@ data MandrillRejectReason = RR_HardBounce
7178 | RR_InvalidSender
7279 | RR_Invalid
7380 | RR_TestModeLimit
81+ | RR_Unsigned
7482 | RR_Rule deriving Show
7583
7684deriveJSON defaultOptions {
@@ -83,7 +91,7 @@ deriveJSON defaultOptions {
8391-- which can be either a success or a failure.
8492data MandrillResponse k =
8593 MandrillSuccess k
86− | MandrillFailure MandrillError deriving Show
94+ | MandrillFailure MandrillError deriving (Show, Eq, Functor, Foldable, Traversable)
8795
8896instance FromJSON k => FromJSON (MandrillResponse k) where
8997 parseJSON v = case (parseMaybe parseJSON v) :: Maybe k of
@@ -101,14 +109,27 @@ data MandrillRecipientTag = To | Cc | Bcc deriving Show
101109deriveJSON defaultOptions { constructorTagModifier = map toLower } ''MandrillRecipientTag
102110
103111
112+--------------------------------------------------------------------------------
113+newtype MandrillEmail = MandrillEmail EmailAddress deriving Show
114+
115+instance ToJSON MandrillEmail where
116+ toJSON (MandrillEmail e) = String . TL.decodeUtf8 . toByteString $ e
117+
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
123+
124+
104125--------------------------------------------------------------------------------
105126-- | An array of recipient information.
106127data MandrillRecipient = MandrillRecipient {
107− _mrec_email :: EmailAddress
128+ _mrec_email :: MandrillEmail
108129 -- ^ The email address of the recipient
109− , _mrec_name :: Maybe T.Text
130+ , _mrec_name :: Maybe T.Text
110131 -- ^ The optional display name to use for the recipient
111− , _mrec_type :: Maybe MandrillRecipientTag
132+ , _mrec_type :: Maybe MandrillRecipientTag
112133 -- ^ The header type to use for the recipient.
113134 -- defaults to "to" if not provided
114135 } deriving Show
@@ -117,11 +138,11 @@ makeLenses ''MandrillRecipient
117138deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillRecipient
118139
119140newRecipient :: EmailAddress -> MandrillRecipient
120−newRecipient email = MandrillRecipient email Nothing Nothing
141+newRecipient email = MandrillRecipient (MandrillEmail email) Nothing Nothing
121142
122143instance Arbitrary MandrillRecipient where
123144 arbitrary = pure MandrillRecipient {
124− _mrec_email = fromJust (emailAddress "test@example.com")
145+ _mrec_email = MandrillEmail $ fromJust (emailAddress "test@example.com")
125146 , _mrec_name = Nothing
126147 , _mrec_type = Nothing
127148 }
@@ -137,6 +158,11 @@ unsafeMkMandrillHtml = MandrillHtml . Blaze.preEscapedToHtml
137158mkMandrillHtml :: Blaze.Html -> MandrillHtml
138159mkMandrillHtml = MandrillHtml
139160
161+#if MIN_VERSION_base(4,11,0)
162+instance Semigroup MandrillHtml where
163+ MandrillHtml m1 <> MandrillHtml m2 = MandrillHtml (m1 <> m2)
164+#endif
165+
140166instance Monoid MandrillHtml where
141167 mempty = MandrillHtml mempty
142168 mappend (MandrillHtml m1) (MandrillHtml m2) = MandrillHtml (m1 <> m2)
@@ -159,17 +185,23 @@ type MandrillTags = T.Text
159185
160186
161187--------------------------------------------------------------------------------
162−type MandrillHeaders = Value
188+type MandrillHeaders = Object
163189
164190
165191--------------------------------------------------------------------------------
166−type MandrillVars = Value
167192
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
168200
169201--------------------------------------------------------------------------------
170202data MandrillMergeVars = MandrillMergeVars {
171203 _mmvr_rcpt :: !T.Text
172− , _mmvr_vars :: [MandrillVars]
204+ , _mmvr_vars :: [MergeVar]
173205 } deriving Show
174206
175207makeLenses ''MandrillMergeVars
@@ -177,29 +209,33 @@ deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillMergeVars
177209
178210--------------------------------------------------------------------------------
179211data MandrillMetadata = MandrillMetadata {
180− _mmdt_rcpt :: !T.Text
181− , _mmdt_values :: MandrillVars
212+ _mmdt_rcpt :: !T.Text
213+ , _mmdt_values :: Object
182214 } deriving Show
183215
184216makeLenses ''MandrillMetadata
185217deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillMetadata
186218
187219
188−newtype Base64ByteString = B64BS B.ByteString deriving Show
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.
225+ deriving Show
189226
190227instance ToJSON Base64ByteString where
191− toJSON (B64BS bs) = String . TL.decodeUtf8 . Base64.encode $ bs
228+ toJSON (PlainBS bs) = String . TL.decodeUtf8 . Base64.encode $ bs
229+ toJSON (EncodedB64BS bs) = String . TL.decodeUtf8 $ bs
192230
193231instance FromJSON Base64ByteString where
194− parseJSON (String v) = case Base64.decode (TL.encodeUtf8 v) of
195− Left err -> fail err
196− Right rs -> return $ B64BS rs
232+ parseJSON (String v) = pure $ EncodedB64BS (TL.encodeUtf8 v)
197233 parseJSON rest = typeMismatch "Base64ByteString must be a String." rest
198234
199235--------------------------------------------------------------------------------
200236data MandrillWebContent = MandrillWebContent {
201− _mwct_type :: !T.Text
202− , _mwct_name :: !T.Text
237+ _mwct_type :: !T.Text
238+ , _mwct_name :: !T.Text
203239 -- ^ [for images] the Content ID of the image
204240 -- - use <img src="cid:THIS_VALUE"> to reference the image
205241 -- in your HTML content
@@ -212,67 +248,67 @@ deriveJSON defaultOptions { fieldLabelModifier = drop 6 } ''MandrillWebContent
212248--------------------------------------------------------------------------------
213249-- | The information on the message to send
214250data MandrillMessage = MandrillMessage {
215− _mmsg_html :: MandrillHtml
251+ _mmsg_html :: MandrillHtml
216252 -- ^ The full HTML content to be sent
217− , _mmsg_text :: Maybe T.Text
253+ , _mmsg_text :: Maybe T.Text
218254 -- ^ Optional full text content to be sent
219− , _mmsg_subject :: !T.Text
255+ , _mmsg_subject :: !T.Text
220256 -- ^ The message subject
221− , _mmsg_from_email :: EmailAddress
257+ , _mmsg_from_email :: MandrillEmail
222258 -- ^ The sender email address
223− , _mmsg_from_name :: Maybe T.Text
259+ , _mmsg_from_name :: Maybe T.Text
224260 -- ^ Optional from name to be used
225− , _mmsg_to :: [MandrillRecipient]
261+ , _mmsg_to :: [MandrillRecipient]
226262 -- ^ A list of recipient information
227− , _mmsg_headers :: MandrillHeaders
263+ , _mmsg_headers :: MandrillHeaders
228264 -- ^ optional extra headers to add to the message (most headers are allowed)
229− , _mmsg_important :: Maybe Bool
265+ , _mmsg_important :: Maybe Bool
230266 -- ^ whether or not this message is important, and should be delivered ahead
231267 -- of non-important messages
232− , _mmsg_track_opens :: Maybe Bool
268+ , _mmsg_track_opens :: Maybe Bool
233269 -- ^ whether or not to turn on open tracking for the message
234− , _mmsg_track_clicks :: Maybe Bool
270+ , _mmsg_track_clicks :: Maybe Bool
235271 -- ^ whether or not to turn on click tracking for the message
236− , _mmsg_auto_text :: Maybe Bool
272+ , _mmsg_auto_text :: Maybe Bool
237273 -- ^ whether or not to automatically generate a text part for messages that are not given text
238− , _mmsg_auto_html :: Maybe Bool
274+ , _mmsg_auto_html :: Maybe Bool
239275 -- ^ whether or not to automatically generate an HTML part for messages that are not given HTML
240− , _mmsg_inline_css :: Maybe Bool
276+ , _mmsg_inline_css :: Maybe Bool
241277 -- ^ whether or not to automatically inline all CSS styles provided in the message HTML
242278 -- - only for HTML documents less than 256KB in size
243− , _mmsg_url_strip_qs :: Maybe Bool
279+ , _mmsg_url_strip_qs :: Maybe Bool
244280 -- ^ whether or not to strip the query string from URLs when aggregating tracked URL data
245− , _mmsg_preserve_recipients :: Maybe Bool
281+ , _mmsg_preserve_recipients :: Maybe Bool
246282 -- ^ whether or not to expose all recipients in to "To" header for each email
247− , _mmsg_view_content_link :: Maybe Bool
283+ , _mmsg_view_content_link :: Maybe Bool
248284 -- ^ set to false to remove content logging for sensitive emails
249− , _mmsg_bcc_address :: Maybe T.Text
285+ , _mmsg_bcc_address :: Maybe T.Text
250286 -- ^ an optional address to receive an exact copy of each recipient's email
251− , _mmsg_tracking_domain :: Maybe T.Text
287+ , _mmsg_tracking_domain :: Maybe T.Text
252288 -- ^ a custom domain to use for tracking opens and clicks instead of mandrillapp.com
253− , _mmsg_signing_domain :: Maybe Bool
254− -- ^ 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
255291 -- (for "via" or "on behalf of" in email clients)
256− , _mmsg_return_path_domain :: Maybe Bool
292+ , _mmsg_return_path_domain :: Maybe Bool
257293 -- ^ a custom domain to use for the messages's return-path
258− , _mmsg_merge :: Maybe Bool
294+ , _mmsg_merge :: Maybe Bool
259295 -- ^ whether to evaluate merge tags in the message.
260296 -- Will automatically be set to true if either merge_vars
261297 -- or global_merge_vars are provided.
262− , _mmsg_global_merge_vars :: [MandrillVars]
298+ , _mmsg_global_merge_vars :: [MergeVar]
263299 -- ^ global merge variables to use for all recipients. You can override these per recipient.
264− , _mmsg_merge_vars :: [MandrillMergeVars]
300+ , _mmsg_merge_vars :: [MandrillMergeVars]
265301 -- ^ per-recipient merge variables, which override global merge variables with the same name.
266− , _mmsg_tags :: [MandrillTags]
302+ , _mmsg_tags :: [MandrillTags]
267303 -- ^ an array of string to tag the message with. Stats are accumulated using tags,
268304 -- though we only store the first 100 we see, so this should not be unique
269305 -- or change frequently. Tags should be 50 characters or less.
270306 -- Any tags starting with an underscore are reserved for internal use
271307 -- and will cause errors.
272− , _mmsg_subaccount :: Maybe T.Text
308+ , _mmsg_subaccount :: Maybe T.Text
273309 -- ^ the unique id of a subaccount for this message
274310 -- - must already exist or will fail with an error
275− , _mmsg_google_analytics_domains :: [T.Text]
311+ , _mmsg_google_analytics_domains :: [T.Text]
276312 -- ^ an array of strings indicating for which any matching URLs
277313 -- will automatically have Google Analytics parameters appended
278314 -- to their query string automatically.
@@ -280,17 +316,17 @@ data MandrillMessage = MandrillMessage {
280316 -- ^ optional string indicating the value to set for the utm_campaign
281317 -- tracking parameter. If this isn't provided the email's from address
282318 -- will be used instead.
283− , _mmsg_metadata :: MandrillVars
319+ , _mmsg_metadata :: Object
284320 -- ^ metadata an associative array of user metadata. Mandrill will store
285321 -- this metadata and make it available for retrieval.
286322 -- In addition, you can select up to 10 metadata fields to index
287323 -- and make searchable using the Mandrill search api.
288− , _mmsg_recipient_metadata :: [MandrillMetadata]
324+ , _mmsg_recipient_metadata :: [MandrillMetadata]
289325 -- ^ Per-recipient metadata that will override the global values
290326 -- specified in the metadata parameter.
291− , _mmsg_attachments :: [MandrillWebContent]
327+ , _mmsg_attachments :: [MandrillWebContent]
292328 -- ^ an array of supported attachments to add to the message
293− , _mmsg_images :: [MandrillWebContent]
329+ , _mmsg_images :: [MandrillWebContent]
294330 -- ^ an array of embedded images to add to the message
295331 } deriving Show
296332
@@ -301,10 +337,10 @@ instance Arbitrary MandrillMessage where
301337 arbitrary = MandrillMessage <$> arbitrary
302338 <*> pure Nothing
303339 <*> pure "Test Subject"
304− <*> pure (fromJust $ emailAddress "sender@example.com")
340+ <*> pure (MandrillEmail . fromJust $ emailAddress "sender@example.com")
305341 <*> pure Nothing
306342 <*> resize 2 arbitrary
307− <*> pure emptyObject
343+ <*> pure H.empty
308344 <*> pure Nothing
309345 <*> pure Nothing
310346 <*> pure Nothing
@@ -325,7 +361,7 @@ instance Arbitrary MandrillMessage where
325361 <*> pure Nothing
326362 <*> pure []
327363 <*> pure Nothing
328− <*> pure emptyObject
364+ <*> pure H.empty
329365 <*> pure []
330366 <*> pure []
331367 <*> pure []