Safe Haskell	None
Language	Haskell2010

Network.API.Mandrill.Types

Synopsis

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

Show MandrillError Source #
Methods showsPrec :: Int -> MandrillError -> ShowS # show :: MandrillError -> String # showList :: [MandrillError] -> ShowS #
ToJSON MandrillError Source #
Methods toJSON :: MandrillError -> Value # toEncoding :: MandrillError -> Encoding #
FromJSON MandrillError Source #
Methods parseJSON :: 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 #
Methods showsPrec :: Int -> MandrillEmailStatus -> ShowS # show :: MandrillEmailStatus -> String # showList :: [MandrillEmailStatus] -> ShowS #
ToJSON MandrillEmailStatus Source #
Methods toJSON :: MandrillEmailStatus -> Value # toEncoding :: MandrillEmailStatus -> Encoding #
FromJSON MandrillEmailStatus Source #
Methods parseJSON :: 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 #
Methods showsPrec :: Int -> MandrillRejectReason -> ShowS # show :: MandrillRejectReason -> String # showList :: [MandrillRejectReason] -> ShowS #
ToJSON MandrillRejectReason Source #
Methods toJSON :: MandrillRejectReason -> Value # toEncoding :: MandrillRejectReason -> Encoding #
FromJSON MandrillRejectReason Source #
Methods parseJSON :: 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

Show k => Show (MandrillResponse k) Source #
Methods showsPrec :: Int -> MandrillResponse k -> ShowS # show :: MandrillResponse k -> String # showList :: [MandrillResponse k] -> ShowS #
FromJSON k => FromJSON (MandrillResponse k) Source #
Methods parseJSON :: Value -> Parser (MandrillResponse k) #

data MandrillRecipientTag Source #

Constructors

To
Cc
Bcc

Instances

Show MandrillRecipientTag Source #
Methods showsPrec :: Int -> MandrillRecipientTag -> ShowS # show :: MandrillRecipientTag -> String # showList :: [MandrillRecipientTag] -> ShowS #
ToJSON MandrillRecipientTag Source #
Methods toJSON :: MandrillRecipientTag -> Value # toEncoding :: MandrillRecipientTag -> Encoding #
FromJSON MandrillRecipientTag Source #
Methods parseJSON :: Value -> Parser MandrillRecipientTag #

newtype MandrillEmail Source #

Constructors

MandrillEmail EmailAddress

Instances

Show MandrillEmail Source #
Methods showsPrec :: Int -> MandrillEmail -> ShowS # show :: MandrillEmail -> String # showList :: [MandrillEmail] -> ShowS #
ToJSON MandrillEmail Source #
Methods toJSON :: MandrillEmail -> Value # toEncoding :: MandrillEmail -> Encoding #
FromJSON MandrillEmail Source #
Methods parseJSON :: 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 #
Methods showsPrec :: Int -> MandrillRecipient -> ShowS # show :: MandrillRecipient -> String # showList :: [MandrillRecipient] -> ShowS #
Arbitrary MandrillRecipient Source #
Methods arbitrary :: Gen MandrillRecipient # shrink :: MandrillRecipient -> [MandrillRecipient] #
ToJSON MandrillRecipient Source #
Methods toJSON :: MandrillRecipient -> Value # toEncoding :: MandrillRecipient -> Encoding #
FromJSON MandrillRecipient Source #
Methods parseJSON :: 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 #
Methods showsPrec :: Int -> MandrillHtml -> ShowS # show :: MandrillHtml -> String # showList :: [MandrillHtml] -> ShowS #
Monoid MandrillHtml Source #
Methods mempty :: MandrillHtml # mappend :: MandrillHtml -> MandrillHtml -> MandrillHtml # mconcat :: [MandrillHtml] -> MandrillHtml #
Arbitrary MandrillHtml Source #
Methods arbitrary :: Gen MandrillHtml # shrink :: MandrillHtml -> [MandrillHtml] #
ToJSON MandrillHtml Source #
Methods toJSON :: MandrillHtml -> Value # toEncoding :: MandrillHtml -> Encoding #
FromJSON MandrillHtml Source #
Methods parseJSON :: 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 #
Methods showsPrec :: Int -> MergeVar -> ShowS # show :: MergeVar -> String # showList :: [MergeVar] -> ShowS #
ToJSON MergeVar Source #
Methods toJSON :: MergeVar -> Value # toEncoding :: MergeVar -> Encoding #
FromJSON MergeVar Source #
Methods parseJSON :: 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 #
Methods showsPrec :: Int -> MandrillMergeVars -> ShowS # show :: MandrillMergeVars -> String # showList :: [MandrillMergeVars] -> ShowS #
ToJSON MandrillMergeVars Source #
Methods toJSON :: MandrillMergeVars -> Value # toEncoding :: MandrillMergeVars -> Encoding #
FromJSON MandrillMergeVars Source #
Methods parseJSON :: 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 #
Methods showsPrec :: Int -> MandrillMetadata -> ShowS # show :: MandrillMetadata -> String # showList :: [MandrillMetadata] -> ShowS #
ToJSON MandrillMetadata Source #
Methods toJSON :: MandrillMetadata -> Value # toEncoding :: MandrillMetadata -> Encoding #
FromJSON MandrillMetadata Source #
Methods parseJSON :: 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 #
Methods showsPrec :: Int -> Base64ByteString -> ShowS # show :: Base64ByteString -> String # showList :: [Base64ByteString] -> ShowS #
ToJSON Base64ByteString Source #
Methods toJSON :: Base64ByteString -> Value # toEncoding :: Base64ByteString -> Encoding #
FromJSON Base64ByteString Source #
Methods parseJSON :: 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 #
Methods showsPrec :: Int -> MandrillWebContent -> ShowS # show :: MandrillWebContent -> String # showList :: [MandrillWebContent] -> ShowS #
ToJSON MandrillWebContent Source #
Methods toJSON :: MandrillWebContent -> Value # toEncoding :: MandrillWebContent -> Encoding #
FromJSON MandrillWebContent Source #
Methods parseJSON :: 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 :: !Text
The message subject
_mmsg_from_email :: 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 #
Methods showsPrec :: Int -> MandrillMessage -> ShowS # show :: MandrillMessage -> String # showList :: [MandrillMessage] -> ShowS #
Arbitrary MandrillMessage Source #
Methods arbitrary :: Gen MandrillMessage # shrink :: MandrillMessage -> [MandrillMessage] #
ToJSON MandrillMessage Source #
Methods toJSON :: MandrillMessage -> Value # toEncoding :: MandrillMessage -> Encoding #
FromJSON MandrillMessage Source #
Methods parseJSON :: 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 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 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 #
Methods showsPrec :: Int -> MandrillTemplateContent -> ShowS # show :: MandrillTemplateContent -> String # showList :: [MandrillTemplateContent] -> ShowS #
ToJSON MandrillTemplateContent Source #
Methods toJSON :: MandrillTemplateContent -> Value # toEncoding :: MandrillTemplateContent -> Encoding #
FromJSON MandrillTemplateContent Source #
Methods parseJSON :: 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 #
Methods showsPrec :: Int -> MandrillDate -> ShowS # show :: MandrillDate -> String # showList :: [MandrillDate] -> ShowS #
ToJSON MandrillDate Source #
Methods toJSON :: MandrillDate -> Value # toEncoding :: MandrillDate -> Encoding #
FromJSON MandrillDate Source #
Methods parseJSON :: Value -> Parser MandrillDate #