Safe Haskell	None
Language	Haskell2010

Network.API.Mandrill.Types

Synopsis

timeParse :: ParseTime t => TimeLocale -> String -> String -> Maybe t
data MandrillError = MandrillError {
- _merr_status :: !Text
- _merr_code :: !Int
- _merr_name :: !Text
- _merr_message :: !Text
}
merr_status :: Lens' MandrillError Text
merr_name :: Lens' MandrillError Text
merr_message :: Lens' MandrillError Text
merr_code :: Lens' MandrillError Int
data MandrillEmailStatus
- = ES_Sent
- | ES_Queued
- | ES_Scheduled
- | ES_Rejected
- | ES_Invalid
data MandrillRejectReason
- = RR_HardBounce
- | RR_SoftBounce
- | RR_Spam
- | RR_Unsub
- | RR_Custom
- | RR_InvalidSender
- | RR_Invalid
- | RR_TestModeLimit
- | RR_Unsigned
- | RR_Rule
data MandrillResponse k
- = MandrillSuccess k
- | MandrillFailure MandrillError
data MandrillRecipientTag
- = To
- | Cc
- | Bcc
newtype MandrillEmail = MandrillEmail EmailAddress
data MandrillRecipient = MandrillRecipient {
- _mrec_email :: MandrillEmail
- _mrec_name :: Maybe Text
- _mrec_type :: Maybe MandrillRecipientTag
}
mrec_type :: Lens' MandrillRecipient (Maybe MandrillRecipientTag)
mrec_name :: Lens' MandrillRecipient (Maybe Text)
mrec_email :: Lens' MandrillRecipient MandrillEmail
newRecipient :: EmailAddress -> MandrillRecipient
newtype MandrillHtml = MandrillHtml Html
unsafeMkMandrillHtml :: Text -> MandrillHtml
mkMandrillHtml :: Html -> MandrillHtml
type MandrillTags = Text
type MandrillHeaders = Object
data MergeVar = MergeVar {
- _mv_name :: !Text
- _mv_content :: Value
}
mv_name :: Lens' MergeVar Text
mv_content :: Lens' MergeVar Value
data MandrillMergeVars = MandrillMergeVars {
- _mmvr_rcpt :: !Text
- _mmvr_vars :: [MergeVar]
}
mmvr_vars :: Lens' MandrillMergeVars [MergeVar]
mmvr_rcpt :: Lens' MandrillMergeVars Text
data MandrillMetadata = MandrillMetadata {
- _mmdt_rcpt :: !Text
- _mmdt_values :: Object
}
mmdt_values :: Lens' MandrillMetadata Object
mmdt_rcpt :: Lens' MandrillMetadata Text
data Base64ByteString
- = EncodedB64BS ByteString
- | PlainBS ByteString
data MandrillWebContent = MandrillWebContent {
- _mwct_type :: !Text
- _mwct_name :: !Text
- _mwct_content :: !Base64ByteString
}
mwct_type :: Lens' MandrillWebContent Text
mwct_name :: Lens' MandrillWebContent Text
mwct_content :: Lens' MandrillWebContent Base64ByteString
data MandrillMessage = MandrillMessage {
- _mmsg_html :: MandrillHtml
- _mmsg_text :: Maybe Text
- _mmsg_subject :: !(Maybe Text)
- _mmsg_from_email :: Maybe MandrillEmail
- _mmsg_from_name :: Maybe Text
- _mmsg_to :: [MandrillRecipient]
- _mmsg_headers :: MandrillHeaders
- _mmsg_important :: Maybe Bool
- _mmsg_track_opens :: Maybe Bool
- _mmsg_track_clicks :: Maybe Bool
- _mmsg_auto_text :: Maybe Bool
- _mmsg_auto_html :: Maybe Bool
- _mmsg_inline_css :: Maybe Bool
- _mmsg_url_strip_qs :: Maybe Bool
- _mmsg_preserve_recipients :: Maybe Bool
- _mmsg_view_content_link :: Maybe Bool
- _mmsg_bcc_address :: Maybe Text
- _mmsg_tracking_domain :: Maybe Text
- _mmsg_signing_domain :: Maybe Bool
- _mmsg_return_path_domain :: Maybe Bool
- _mmsg_merge :: Maybe Bool
- _mmsg_global_merge_vars :: [MergeVar]
- _mmsg_merge_vars :: [MandrillMergeVars]
- _mmsg_tags :: [MandrillTags]
- _mmsg_subaccount :: Maybe Text
- _mmsg_google_analytics_domains :: [Text]
- _mmsg_google_analytics_campaign :: Maybe Text
- _mmsg_metadata :: Object
- _mmsg_recipient_metadata :: [MandrillMetadata]
- _mmsg_attachments :: [MandrillWebContent]
- _mmsg_images :: [MandrillWebContent]
}
mmsg_view_content_link :: Lens' MandrillMessage (Maybe Bool)
mmsg_url_strip_qs :: Lens' MandrillMessage (Maybe Bool)
mmsg_tracking_domain :: Lens' MandrillMessage (Maybe Text)
mmsg_track_opens :: Lens' MandrillMessage (Maybe Bool)
mmsg_track_clicks :: Lens' MandrillMessage (Maybe Bool)
mmsg_to :: Lens' MandrillMessage [MandrillRecipient]
mmsg_text :: Lens' MandrillMessage (Maybe Text)
mmsg_tags :: Lens' MandrillMessage [MandrillTags]
mmsg_subject :: Lens' MandrillMessage (Maybe Text)
mmsg_subaccount :: Lens' MandrillMessage (Maybe Text)
mmsg_signing_domain :: Lens' MandrillMessage (Maybe Bool)
mmsg_return_path_domain :: Lens' MandrillMessage (Maybe Bool)
mmsg_recipient_metadata :: Lens' MandrillMessage [MandrillMetadata]
mmsg_preserve_recipients :: Lens' MandrillMessage (Maybe Bool)
mmsg_metadata :: Lens' MandrillMessage Object
mmsg_merge_vars :: Lens' MandrillMessage [MandrillMergeVars]
mmsg_merge :: Lens' MandrillMessage (Maybe Bool)
mmsg_inline_css :: Lens' MandrillMessage (Maybe Bool)
mmsg_important :: Lens' MandrillMessage (Maybe Bool)
mmsg_images :: Lens' MandrillMessage [MandrillWebContent]
mmsg_html :: Lens' MandrillMessage MandrillHtml
mmsg_headers :: Lens' MandrillMessage MandrillHeaders
mmsg_google_analytics_domains :: Lens' MandrillMessage [Text]
mmsg_google_analytics_campaign :: Lens' MandrillMessage (Maybe Text)
mmsg_global_merge_vars :: Lens' MandrillMessage [MergeVar]
mmsg_from_name :: Lens' MandrillMessage (Maybe Text)
mmsg_from_email :: Lens' MandrillMessage (Maybe MandrillEmail)
mmsg_bcc_address :: Lens' MandrillMessage (Maybe Text)
mmsg_auto_text :: Lens' MandrillMessage (Maybe Bool)
mmsg_auto_html :: Lens' MandrillMessage (Maybe Bool)
mmsg_attachments :: Lens' MandrillMessage [MandrillWebContent]
data MandrillTemplateContent = MandrillTemplateContent {
- _mtc_name :: Text
- _mtc_content :: Text
}
mtc_name :: Lens' MandrillTemplateContent Text
mtc_content :: Lens' MandrillTemplateContent Text
type MandrillKey = Text
type MandrillTemplate = Text
newtype MandrillDate = MandrillDate {
- fromMandrillDate :: UTCTime
}

Documentation

timeParse :: ParseTime t => TimeLocale -> String -> String -> Maybe t Source #

data MandrillError Source #

Constructors

MandrillError
Fields _merr_status :: !Text _merr_code :: !Int _merr_name :: !Text _merr_message :: !Text

Instances

Eq MandrillError Source #
Instance details Defined in Network.API.Mandrill.Types Methods (==) :: MandrillError -> MandrillError -> Bool # (/=) :: MandrillError -> MandrillError -> Bool #
Show MandrillError Source #
Instance details Defined in Network.API.Mandrill.Types Methods showsPrec :: Int -> MandrillError -> ShowS # show :: MandrillError -> String # showList :: [MandrillError] -> ShowS #
ToJSON MandrillError Source #
Instance details Defined in Network.API.Mandrill.Types Methods toJSON :: MandrillError -> Value # toEncoding :: MandrillError -> Encoding # toJSONList :: [MandrillError] -> Value # toEncodingList :: [MandrillError] -> Encoding #
FromJSON MandrillError Source #
Instance details Defined in Network.API.Mandrill.Types Methods parseJSON :: Value -> Parser MandrillError # parseJSONList :: Value -> Parser [MandrillError] #

merr_status :: Lens' MandrillError Text Source #

merr_name :: Lens' MandrillError Text Source #

merr_message :: Lens' MandrillError Text Source #

merr_code :: Lens' MandrillError Int Source #

data MandrillEmailStatus Source #

Constructors

ES_Sent
ES_Queued
ES_Scheduled
ES_Rejected
ES_Invalid

Instances

Show MandrillEmailStatus Source #
Instance details Defined in Network.API.Mandrill.Types Methods showsPrec :: Int -> MandrillEmailStatus -> ShowS # show :: MandrillEmailStatus -> String # showList :: [MandrillEmailStatus] -> ShowS #
ToJSON MandrillEmailStatus Source #
Instance details Defined in Network.API.Mandrill.Types Methods toJSON :: MandrillEmailStatus -> Value # toEncoding :: MandrillEmailStatus -> Encoding # toJSONList :: [MandrillEmailStatus] -> Value # toEncodingList :: [MandrillEmailStatus] -> Encoding #
FromJSON MandrillEmailStatus Source #
Instance details Defined in Network.API.Mandrill.Types Methods parseJSON :: Value -> Parser MandrillEmailStatus # parseJSONList :: Value -> Parser [MandrillEmailStatus] #

data MandrillRejectReason Source #

Constructors

RR_HardBounce
RR_SoftBounce
RR_Spam
RR_Unsub
RR_Custom
RR_InvalidSender
RR_Invalid
RR_TestModeLimit
RR_Unsigned
RR_Rule

Instances

Show MandrillRejectReason Source #
Instance details Defined in Network.API.Mandrill.Types Methods showsPrec :: Int -> MandrillRejectReason -> ShowS # show :: MandrillRejectReason -> String # showList :: [MandrillRejectReason] -> ShowS #
ToJSON MandrillRejectReason Source #
Instance details Defined in Network.API.Mandrill.Types Methods toJSON :: MandrillRejectReason -> Value # toEncoding :: MandrillRejectReason -> Encoding # toJSONList :: [MandrillRejectReason] -> Value # toEncodingList :: [MandrillRejectReason] -> Encoding #
FromJSON MandrillRejectReason Source #
Instance details Defined in Network.API.Mandrill.Types Methods parseJSON :: Value -> Parser MandrillRejectReason # parseJSONList :: Value -> Parser [MandrillRejectReason] #

data MandrillResponse k Source #

The main datatypes which models the response from the Mandrill API, which can be either a success or a failure.

Constructors

MandrillSuccess k
MandrillFailure MandrillError

Instances

Functor MandrillResponse Source #
Instance details Defined in Network.API.Mandrill.Types Methods fmap :: (a -> b) -> MandrillResponse a -> MandrillResponse b # (<$) :: a -> MandrillResponse b -> MandrillResponse a #
Foldable MandrillResponse Source #
Instance details Defined in Network.API.Mandrill.Types Methods fold :: Monoid m => MandrillResponse m -> m # foldMap :: Monoid m => (a -> m) -> MandrillResponse a -> m # foldr :: (a -> b -> b) -> b -> MandrillResponse a -> b # foldr' :: (a -> b -> b) -> b -> MandrillResponse a -> b # foldl :: (b -> a -> b) -> b -> MandrillResponse a -> b # foldl' :: (b -> a -> b) -> b -> MandrillResponse a -> b # foldr1 :: (a -> a -> a) -> MandrillResponse a -> a # foldl1 :: (a -> a -> a) -> MandrillResponse a -> a # toList :: MandrillResponse a -> [a] # null :: MandrillResponse a -> Bool # length :: MandrillResponse a -> Int # elem :: Eq a => a -> MandrillResponse a -> Bool # maximum :: Ord a => MandrillResponse a -> a # minimum :: Ord a => MandrillResponse a -> a # sum :: Num a => MandrillResponse a -> a # product :: Num a => MandrillResponse a -> a #
Traversable MandrillResponse Source #
Instance details Defined in Network.API.Mandrill.Types Methods traverse :: Applicative f => (a -> f b) -> MandrillResponse a -> f (MandrillResponse b) # sequenceA :: Applicative f => MandrillResponse (f a) -> f (MandrillResponse a) # mapM :: Monad m => (a -> m b) -> MandrillResponse a -> m (MandrillResponse b) # sequence :: Monad m => MandrillResponse (m a) -> m (MandrillResponse a) #
Eq k => Eq (MandrillResponse k) Source #
Instance details Defined in Network.API.Mandrill.Types Methods (==) :: MandrillResponse k -> MandrillResponse k -> Bool # (/=) :: MandrillResponse k -> MandrillResponse k -> Bool #
Show k => Show (MandrillResponse k) Source #
Instance details Defined in Network.API.Mandrill.Types Methods showsPrec :: Int -> MandrillResponse k -> ShowS # show :: MandrillResponse k -> String # showList :: [MandrillResponse k] -> ShowS #
FromJSON k => FromJSON (MandrillResponse k) Source #
Instance details Defined in Network.API.Mandrill.Types Methods parseJSON :: Value -> Parser (MandrillResponse k) # parseJSONList :: Value -> Parser [MandrillResponse k] #

data MandrillRecipientTag Source #

Constructors

To
Cc
Bcc

Instances

Show MandrillRecipientTag Source #
Instance details Defined in Network.API.Mandrill.Types Methods showsPrec :: Int -> MandrillRecipientTag -> ShowS # show :: MandrillRecipientTag -> String # showList :: [MandrillRecipientTag] -> ShowS #
ToJSON MandrillRecipientTag Source #
Instance details Defined in Network.API.Mandrill.Types Methods toJSON :: MandrillRecipientTag -> Value # toEncoding :: MandrillRecipientTag -> Encoding # toJSONList :: [MandrillRecipientTag] -> Value # toEncodingList :: [MandrillRecipientTag] -> Encoding #
FromJSON MandrillRecipientTag Source #
Instance details Defined in Network.API.Mandrill.Types Methods parseJSON :: Value -> Parser MandrillRecipientTag # parseJSONList :: Value -> Parser [MandrillRecipientTag] #

newtype MandrillEmail Source #

Constructors

MandrillEmail EmailAddress

Instances

Show MandrillEmail Source #
Instance details Defined in Network.API.Mandrill.Types Methods showsPrec :: Int -> MandrillEmail -> ShowS # show :: MandrillEmail -> String # showList :: [MandrillEmail] -> ShowS #
ToJSON MandrillEmail Source #
Instance details Defined in Network.API.Mandrill.Types Methods toJSON :: MandrillEmail -> Value # toEncoding :: MandrillEmail -> Encoding # toJSONList :: [MandrillEmail] -> Value # toEncodingList :: [MandrillEmail] -> Encoding #
FromJSON MandrillEmail Source #
Instance details Defined in Network.API.Mandrill.Types Methods parseJSON :: Value -> Parser MandrillEmail # parseJSONList :: Value -> Parser [MandrillEmail] #

data MandrillRecipient Source #

An array of recipient information.

Constructors

MandrillRecipient
Fields _mrec_email :: MandrillEmail The email address of the recipient _mrec_name :: Maybe Text The optional display name to use for the recipient _mrec_type :: Maybe MandrillRecipientTag The header type to use for the recipient. defaults to "to" if not provided

Instances

Show MandrillRecipient Source #
Instance details Defined in Network.API.Mandrill.Types Methods showsPrec :: Int -> MandrillRecipient -> ShowS # show :: MandrillRecipient -> String # showList :: [MandrillRecipient] -> ShowS #
Arbitrary MandrillRecipient Source #
Instance details Defined in Network.API.Mandrill.Types Methods arbitrary :: Gen MandrillRecipient # shrink :: MandrillRecipient -> [MandrillRecipient] #
ToJSON MandrillRecipient Source #
Instance details Defined in Network.API.Mandrill.Types Methods toJSON :: MandrillRecipient -> Value # toEncoding :: MandrillRecipient -> Encoding # toJSONList :: [MandrillRecipient] -> Value # toEncodingList :: [MandrillRecipient] -> Encoding #
FromJSON MandrillRecipient Source #
Instance details Defined in Network.API.Mandrill.Types Methods parseJSON :: Value -> Parser MandrillRecipient # parseJSONList :: Value -> Parser [MandrillRecipient] #

mrec_type :: Lens' MandrillRecipient (Maybe MandrillRecipientTag) Source #

mrec_name :: Lens' MandrillRecipient (Maybe Text) Source #

mrec_email :: Lens' MandrillRecipient MandrillEmail Source #

newRecipient :: EmailAddress -> MandrillRecipient Source #

newtype MandrillHtml Source #

Constructors

MandrillHtml Html

Instances

Show MandrillHtml Source #
Instance details Defined in Network.API.Mandrill.Types Methods showsPrec :: Int -> MandrillHtml -> ShowS # show :: MandrillHtml -> String # showList :: [MandrillHtml] -> ShowS #
Semigroup MandrillHtml Source #
Instance details Defined in Network.API.Mandrill.Types Methods (<>) :: MandrillHtml -> MandrillHtml -> MandrillHtml # sconcat :: NonEmpty MandrillHtml -> MandrillHtml # stimes :: Integral b => b -> MandrillHtml -> MandrillHtml #
Monoid MandrillHtml Source #
Instance details Defined in Network.API.Mandrill.Types Methods mempty :: MandrillHtml # mappend :: MandrillHtml -> MandrillHtml -> MandrillHtml # mconcat :: [MandrillHtml] -> MandrillHtml #
Arbitrary MandrillHtml Source #
Instance details Defined in Network.API.Mandrill.Types Methods arbitrary :: Gen MandrillHtml # shrink :: MandrillHtml -> [MandrillHtml] #
ToJSON MandrillHtml Source #
Instance details Defined in Network.API.Mandrill.Types Methods toJSON :: MandrillHtml -> Value # toEncoding :: MandrillHtml -> Encoding # toJSONList :: [MandrillHtml] -> Value # toEncodingList :: [MandrillHtml] -> Encoding #
FromJSON MandrillHtml Source #
Instance details Defined in Network.API.Mandrill.Types Methods parseJSON :: Value -> Parser MandrillHtml # parseJSONList :: Value -> Parser [MandrillHtml] #

unsafeMkMandrillHtml :: Text -> MandrillHtml Source #

mkMandrillHtml :: Html -> MandrillHtml Source #

type MandrillTags = Text Source #

type MandrillHeaders = Object Source #

data MergeVar Source #

Constructors

MergeVar
Fields _mv_name :: !Text _mv_content :: Value

Instances

Show MergeVar Source #
Instance details Defined in Network.API.Mandrill.Types Methods showsPrec :: Int -> MergeVar -> ShowS # show :: MergeVar -> String # showList :: [MergeVar] -> ShowS #
ToJSON MergeVar Source #
Instance details Defined in Network.API.Mandrill.Types Methods toJSON :: MergeVar -> Value # toEncoding :: MergeVar -> Encoding # toJSONList :: [MergeVar] -> Value # toEncodingList :: [MergeVar] -> Encoding #
FromJSON MergeVar Source #
Instance details Defined in Network.API.Mandrill.Types Methods parseJSON :: Value -> Parser MergeVar # parseJSONList :: Value -> Parser [MergeVar] #

mv_name :: Lens' MergeVar Text Source #

mv_content :: Lens' MergeVar Value Source #

data MandrillMergeVars Source #

Constructors

MandrillMergeVars
Fields _mmvr_rcpt :: !Text _mmvr_vars :: [MergeVar]

Instances

Show MandrillMergeVars Source #
Instance details Defined in Network.API.Mandrill.Types Methods showsPrec :: Int -> MandrillMergeVars -> ShowS # show :: MandrillMergeVars -> String # showList :: [MandrillMergeVars] -> ShowS #
ToJSON MandrillMergeVars Source #
Instance details Defined in Network.API.Mandrill.Types Methods toJSON :: MandrillMergeVars -> Value # toEncoding :: MandrillMergeVars -> Encoding # toJSONList :: [MandrillMergeVars] -> Value # toEncodingList :: [MandrillMergeVars] -> Encoding #
FromJSON MandrillMergeVars Source #
Instance details Defined in Network.API.Mandrill.Types Methods parseJSON :: Value -> Parser MandrillMergeVars # parseJSONList :: Value -> Parser [MandrillMergeVars] #

mmvr_vars :: Lens' MandrillMergeVars [MergeVar] Source #

mmvr_rcpt :: Lens' MandrillMergeVars Text Source #

data MandrillMetadata Source #

Constructors

MandrillMetadata
Fields _mmdt_rcpt :: !Text _mmdt_values :: Object

Instances

Show MandrillMetadata Source #
Instance details Defined in Network.API.Mandrill.Types Methods showsPrec :: Int -> MandrillMetadata -> ShowS # show :: MandrillMetadata -> String # showList :: [MandrillMetadata] -> ShowS #
ToJSON MandrillMetadata Source #
Instance details Defined in Network.API.Mandrill.Types Methods toJSON :: MandrillMetadata -> Value # toEncoding :: MandrillMetadata -> Encoding # toJSONList :: [MandrillMetadata] -> Value # toEncodingList :: [MandrillMetadata] -> Encoding #
FromJSON MandrillMetadata Source #
Instance details Defined in Network.API.Mandrill.Types Methods parseJSON :: Value -> Parser MandrillMetadata # parseJSONList :: Value -> Parser [MandrillMetadata] #

mmdt_values :: Lens' MandrillMetadata Object Source #

mmdt_rcpt :: Lens' MandrillMetadata Text Source #

data Base64ByteString Source #

Constructors

EncodedB64BS ByteString	An already-encoded Base64 ByteString.
PlainBS ByteString	A plain Base64 ByteString which requires encoding.

Instances

Show Base64ByteString Source #
Instance details Defined in Network.API.Mandrill.Types Methods showsPrec :: Int -> Base64ByteString -> ShowS # show :: Base64ByteString -> String # showList :: [Base64ByteString] -> ShowS #
ToJSON Base64ByteString Source #
Instance details Defined in Network.API.Mandrill.Types Methods toJSON :: Base64ByteString -> Value # toEncoding :: Base64ByteString -> Encoding # toJSONList :: [Base64ByteString] -> Value # toEncodingList :: [Base64ByteString] -> Encoding #
FromJSON Base64ByteString Source #
Instance details Defined in Network.API.Mandrill.Types Methods parseJSON :: Value -> Parser Base64ByteString # parseJSONList :: Value -> Parser [Base64ByteString] #

data MandrillWebContent Source #

Constructors

MandrillWebContent
Fields _mwct_type :: !Text _mwct_name :: !Text for images the Content ID of the image - use src="cid:THIS_VALUE" to reference the image in your HTML content _mwct_content :: !Base64ByteString

Instances

Show MandrillWebContent Source #
Instance details Defined in Network.API.Mandrill.Types Methods showsPrec :: Int -> MandrillWebContent -> ShowS # show :: MandrillWebContent -> String # showList :: [MandrillWebContent] -> ShowS #
ToJSON MandrillWebContent Source #
Instance details Defined in Network.API.Mandrill.Types Methods toJSON :: MandrillWebContent -> Value # toEncoding :: MandrillWebContent -> Encoding # toJSONList :: [MandrillWebContent] -> Value # toEncodingList :: [MandrillWebContent] -> Encoding #
FromJSON MandrillWebContent Source #
Instance details Defined in Network.API.Mandrill.Types Methods parseJSON :: Value -> Parser MandrillWebContent # parseJSONList :: Value -> Parser [MandrillWebContent] #

mwct_type :: Lens' MandrillWebContent Text Source #

mwct_name :: Lens' MandrillWebContent Text Source #

mwct_content :: Lens' MandrillWebContent Base64ByteString Source #

data MandrillMessage Source #

The information on the message to send

Constructors

MandrillMessage

Fields

_mmsg_html :: MandrillHtml
The full HTML content to be sent
_mmsg_text :: Maybe Text
Optional full text content to be sent
_mmsg_subject :: !(Maybe Text)
The message subject
_mmsg_from_email :: Maybe MandrillEmail
The sender email address
_mmsg_from_name :: Maybe Text
Optional from name to be used
_mmsg_to :: [MandrillRecipient]
A list of recipient information
_mmsg_headers :: MandrillHeaders
optional extra headers to add to the message (most headers are allowed)
_mmsg_important :: Maybe Bool
whether or not this message is important, and should be delivered ahead of non-important messages
_mmsg_track_opens :: Maybe Bool
whether or not to turn on open tracking for the message
_mmsg_track_clicks :: Maybe Bool
whether or not to turn on click tracking for the message
_mmsg_auto_text :: Maybe Bool
whether or not to automatically generate a text part for messages that are not given text
_mmsg_auto_html :: Maybe Bool
whether or not to automatically generate an HTML part for messages that are not given HTML
_mmsg_inline_css :: Maybe Bool
whether or not to automatically inline all CSS styles provided in the message HTML - only for HTML documents less than 256KB in size
_mmsg_url_strip_qs :: Maybe Bool
whether or not to strip the query string from URLs when aggregating tracked URL data
_mmsg_preserve_recipients :: Maybe Bool
whether or not to expose all recipients in to To header for each email
_mmsg_view_content_link :: Maybe Bool
set to false to remove content logging for sensitive emails
_mmsg_bcc_address :: Maybe Text
an optional address to receive an exact copy of each recipient's email
_mmsg_tracking_domain :: Maybe Text
a custom domain to use for tracking opens and clicks instead of mandrillapp.com
_mmsg_signing_domain :: Maybe Bool
a custom domain to use for SPF/DKIM signing instead of mandrill (for "via" or "on behalf of" in email clients)
_mmsg_return_path_domain :: Maybe Bool
a custom domain to use for the messages's return-path
_mmsg_merge :: Maybe Bool
whether to evaluate merge tags in the message. Will automatically be set to true if either merge_vars or global_merge_vars are provided.
_mmsg_global_merge_vars :: [MergeVar]
global merge variables to use for all recipients. You can override these per recipient.
_mmsg_merge_vars :: [MandrillMergeVars]
per-recipient merge variables, which override global merge variables with the same name.
_mmsg_tags :: [MandrillTags]
an array of string to tag the message with. Stats are accumulated using tags, though we only store the first 100 we see, so this should not be unique or change frequently. Tags should be 50 characters or less. Any tags starting with an underscore are reserved for internal use and will cause errors.
_mmsg_subaccount :: Maybe Text
the unique id of a subaccount for this message - must already exist or will fail with an error
_mmsg_google_analytics_domains :: [Text]
an array of strings indicating for which any matching URLs will automatically have Google Analytics parameters appended to their query string automatically.
_mmsg_google_analytics_campaign :: Maybe Text
optional string indicating the value to set for the utm_campaign tracking parameter. If this isn't provided the email's from address will be used instead.
_mmsg_metadata :: Object
metadata an associative array of user metadata. Mandrill will store this metadata and make it available for retrieval. In addition, you can select up to 10 metadata fields to index and make searchable using the Mandrill search api.
_mmsg_recipient_metadata :: [MandrillMetadata]
Per-recipient metadata that will override the global values specified in the metadata parameter.
_mmsg_attachments :: [MandrillWebContent]
an array of supported attachments to add to the message
_mmsg_images :: [MandrillWebContent]
an array of embedded images to add to the message

Instances

Show MandrillMessage Source #
Instance details Defined in Network.API.Mandrill.Types Methods showsPrec :: Int -> MandrillMessage -> ShowS # show :: MandrillMessage -> String # showList :: [MandrillMessage] -> ShowS #
Arbitrary MandrillMessage Source #
Instance details Defined in Network.API.Mandrill.Types Methods arbitrary :: Gen MandrillMessage # shrink :: MandrillMessage -> [MandrillMessage] #
ToJSON MandrillMessage Source #
Instance details Defined in Network.API.Mandrill.Types Methods toJSON :: MandrillMessage -> Value # toEncoding :: MandrillMessage -> Encoding # toJSONList :: [MandrillMessage] -> Value # toEncodingList :: [MandrillMessage] -> Encoding #
FromJSON MandrillMessage Source #
Instance details Defined in Network.API.Mandrill.Types Methods parseJSON :: Value -> Parser MandrillMessage # parseJSONList :: Value -> Parser [MandrillMessage] #

mmsg_view_content_link :: Lens' MandrillMessage (Maybe Bool) Source #

mmsg_url_strip_qs :: Lens' MandrillMessage (Maybe Bool) Source #

mmsg_tracking_domain :: Lens' MandrillMessage (Maybe Text) Source #

mmsg_track_opens :: Lens' MandrillMessage (Maybe Bool) Source #

mmsg_track_clicks :: Lens' MandrillMessage (Maybe Bool) Source #

mmsg_to :: Lens' MandrillMessage [MandrillRecipient] Source #

mmsg_text :: Lens' MandrillMessage (Maybe Text) Source #

mmsg_tags :: Lens' MandrillMessage [MandrillTags] Source #

mmsg_subject :: Lens' MandrillMessage (Maybe Text) Source #

mmsg_subaccount :: Lens' MandrillMessage (Maybe Text) Source #

mmsg_signing_domain :: Lens' MandrillMessage (Maybe Bool) Source #

mmsg_return_path_domain :: Lens' MandrillMessage (Maybe Bool) Source #

mmsg_recipient_metadata :: Lens' MandrillMessage [MandrillMetadata] Source #

mmsg_preserve_recipients :: Lens' MandrillMessage (Maybe Bool) Source #

mmsg_metadata :: Lens' MandrillMessage Object Source #

mmsg_merge_vars :: Lens' MandrillMessage [MandrillMergeVars] Source #

mmsg_merge :: Lens' MandrillMessage (Maybe Bool) Source #

mmsg_inline_css :: Lens' MandrillMessage (Maybe Bool) Source #

mmsg_important :: Lens' MandrillMessage (Maybe Bool) Source #

mmsg_images :: Lens' MandrillMessage [MandrillWebContent] Source #

mmsg_html :: Lens' MandrillMessage MandrillHtml Source #

mmsg_headers :: Lens' MandrillMessage MandrillHeaders Source #

mmsg_google_analytics_domains :: Lens' MandrillMessage [Text] Source #

mmsg_google_analytics_campaign :: Lens' MandrillMessage (Maybe Text) Source #

mmsg_global_merge_vars :: Lens' MandrillMessage [MergeVar] Source #

mmsg_from_name :: Lens' MandrillMessage (Maybe Text) Source #

mmsg_from_email :: Lens' MandrillMessage (Maybe MandrillEmail) Source #

mmsg_bcc_address :: Lens' MandrillMessage (Maybe Text) Source #

mmsg_auto_text :: Lens' MandrillMessage (Maybe Bool) Source #

mmsg_auto_html :: Lens' MandrillMessage (Maybe Bool) Source #

mmsg_attachments :: Lens' MandrillMessage [MandrillWebContent] Source #

data MandrillTemplateContent Source #

Key value pair for replacing content in templates via 'Editable Regions'

Constructors

MandrillTemplateContent
Fields _mtc_name :: Text _mtc_content :: Text

Instances

Show MandrillTemplateContent Source #
Instance details Defined in Network.API.Mandrill.Types Methods showsPrec :: Int -> MandrillTemplateContent -> ShowS # show :: MandrillTemplateContent -> String # showList :: [MandrillTemplateContent] -> ShowS #
ToJSON MandrillTemplateContent Source #
Instance details Defined in Network.API.Mandrill.Types Methods toJSON :: MandrillTemplateContent -> Value # toEncoding :: MandrillTemplateContent -> Encoding # toJSONList :: [MandrillTemplateContent] -> Value # toEncodingList :: [MandrillTemplateContent] -> Encoding #
FromJSON MandrillTemplateContent Source #
Instance details Defined in Network.API.Mandrill.Types Methods parseJSON :: Value -> Parser MandrillTemplateContent # parseJSONList :: Value -> Parser [MandrillTemplateContent] #

mtc_name :: Lens' MandrillTemplateContent Text Source #

mtc_content :: Lens' MandrillTemplateContent Text Source #

type MandrillKey = Text Source #

type MandrillTemplate = Text Source #

newtype MandrillDate Source #

Constructors

MandrillDate
Fields fromMandrillDate :: UTCTime

Instances

Show MandrillDate Source #
Instance details Defined in Network.API.Mandrill.Types Methods showsPrec :: Int -> MandrillDate -> ShowS # show :: MandrillDate -> String # showList :: [MandrillDate] -> ShowS #
ToJSON MandrillDate Source #
Instance details Defined in Network.API.Mandrill.Types Methods toJSON :: MandrillDate -> Value # toEncoding :: MandrillDate -> Encoding # toJSONList :: [MandrillDate] -> Value # toEncodingList :: [MandrillDate] -> Encoding #
FromJSON MandrillDate Source #
Instance details Defined in Network.API.Mandrill.Types Methods parseJSON :: Value -> Parser MandrillDate # parseJSONList :: Value -> Parser [MandrillDate] #