Safe Haskell	None
Language	Haskell2010

Network.SendGridV3.Api

Description

Module that implements the Mail API of SendGrid v3. https://sendgrid.com/docs/API_Reference/api_v3.html

{-# LANGUAGE OverloadedStrings #-}

import Data.List.NonEmpty (fromList)
import Network.SendGridV3.Api
import Control.Lens ((^.))
import Network.Wreq (responseStatus, statusCode)

sendGridApiKey :: ApiKey
sendGridApiKey = ApiKey "SG..."

testMail :: Mail () ()
testMail =
  let to = personalization $ fromList [MailAddress "john@example.com" "John Doe"]
      from = MailAddress "jane@example.com" "Jane Smith"
      subject = "Email Subject"
      content = fromList [mailContentText "Example Content"]
  in mail [to] from subject content

main :: IO ()
main = do
  -- Send an email, overriding options as needed
  eResponse <- sendMail sendGridApiKey (testMail { _mailSendAt = Just 1516468000 })
  case eResponse of
    Left httpException -> error $ show httpException
    Right response -> print (response ^. responseStatus . statusCode)

Synopsis

sendGridAPI :: Text
data ApiKey = ApiKey {
- _apiKey :: Text
}
data MailAddress = MailAddress {
- _mailAddressEmail :: Text
- _mailAddressName :: Text
}
data MailContent = MailContent {
- _mailContentType :: Text
- _mailContentValue :: Text
}
mailContentText :: Text -> MailContent
mailContentHtml :: Text -> MailContent
data Personalization = Personalization {
- _personalizationTo :: NonEmpty MailAddress
- _personalizationCc :: Maybe [MailAddress]
- _personalizationBcc :: Maybe [MailAddress]
- _personalizationSubject :: Maybe Text
- _personalizationHeaders :: Maybe [(Text, Text)]
- _personalizationSubstitutions :: Maybe Object
- _personalizationSendAt :: Maybe Int
- _personalizationDynamicTemplateData :: Maybe Value
}
personalization :: NonEmpty MailAddress -> Personalization
data Disposition
- = Inline
- | Attachment
data MailAttachment = MailAttachment {
- _mailAttachmentContent :: Text
- _mailAttachmentType :: Maybe Text
- _mailAttachmentFilename :: Text
- _mailAttachmentDisposition :: Maybe Disposition
- _mailAttachmentContentId :: Text
}
data Asm = Asm {
- _asmGroupId :: Int
- _asmGroupsToDisplay :: Maybe [Int]
}
data Bcc = Bcc {
- _bccEnable :: Maybe Bool
- _bccEmail :: Maybe Text
}
data BypassListManagement = BypassListManagement {
- _bypassListManagementEnable :: Bool
}
data Footer = Footer {
- _footerEnable :: Maybe Bool
- _footerText :: Maybe Text
- _footerHtml :: Maybe Text
}
data SandboxMode = SandboxMode {
- _sandboxModeEnable :: Bool
}
data SpamCheck = SpamCheck {
- _spamCheckEnable :: Maybe Bool
- _spamCheckThreshold :: Maybe Int
- _spamCheckPostToUrl :: Maybe Text
}
data ClickTracking = ClickTracking {
- _clickTrackingEnable :: Maybe Bool
- _clickTrackingEnableText :: Maybe Bool
}
data OpenTracking = OpenTracking {
- _openTrackingEnable :: Maybe Bool
- _openTrackingSubstitutionTag :: Maybe Text
}
data SubscriptionTracking = SubscriptionTracking {
- _subscriptionTrackingEnable :: Maybe Bool
- _subscriptionTrackingText :: Maybe Text
- _subscriptionTrackingHTML :: Maybe Text
- _subscriptionTrackingSubstitutionTag :: Maybe Text
}
data Ganalytics = Ganalytics {
- _ganalyticsEnable :: Maybe Bool
- _ganalyticsUTMSource :: Maybe Text
- _ganalyticsUTMMedium :: Maybe Text
- _ganalyticsUTMTerm :: Maybe Text
- _ganalyticsUTMContent :: Maybe Text
- _ganalyticsUTMCampaign :: Maybe Text
}
data TrackingSettings = TrackingSettings {
- _trackingSettingsClickTracking :: ClickTracking
- _trackingSettingsOpenTracking :: OpenTracking
- _trackingSettingsSubscriptionTracking :: SubscriptionTracking
- _trackingSettingsGanalytics :: Ganalytics
}
data MailSettings = MailSettings {
- _mailSettingsBcc :: Maybe Bcc
- _mailSettingsBypassListManagement :: Maybe BypassListManagement
- _mailSettingsFooter :: Maybe Footer
- _mailSettingsSandboxMode :: Maybe SandboxMode
- _mailSettingsSpamCheck :: Maybe SpamCheck
}
data Mail a b = Mail {
- _mailPersonalizations :: [Personalization]
- _mailFrom :: MailAddress
- _mailReplyTo :: Maybe MailAddress
- _mailSubject :: Text
- _mailContent :: Maybe (NonEmpty MailContent)
- _mailAttachments :: Maybe [MailAttachment]
- _mailTemplateId :: Maybe Text
- _mailSections :: Maybe a
- _mailHeaders :: Maybe [(Text, Text)]
- _mailCategories :: Maybe [Text]
- _mailCustomArgs :: Maybe b
- _mailSendAt :: Maybe Int
- _mailBatchId :: Maybe Text
- _mailAsm :: Maybe Asm
- _mailIpPoolName :: Maybe Text
- _mailMailSettings :: Maybe MailSettings
- _mailTrackingSettings :: Maybe TrackingSettings
}
mail :: (ToJSON a, ToJSON b) => [Personalization] -> MailAddress -> Text -> Maybe (NonEmpty MailContent) -> Mail a b
sendMail :: (ToJSON a, ToJSON b) => ApiKey -> Mail a b -> IO (Either HttpException (Response ByteString))

Documentation

sendGridAPI :: Text Source #

URL to SendGrid Mail API

data ApiKey Source #

Bearer Token for the API

Constructors

ApiKey
Fields _apiKey :: Text

Instances

Instances details

Eq ApiKey Source #
Instance details Defined in Network.SendGridV3.Api Methods (==) :: ApiKey -> ApiKey -> Bool # (/=) :: ApiKey -> ApiKey -> Bool #
Show ApiKey Source #
Instance details Defined in Network.SendGridV3.Api Methods showsPrec :: Int -> ApiKey -> ShowS # show :: ApiKey -> String # showList :: [ApiKey] -> ShowS #

data MailAddress Source #

Constructors

MailAddress
Fields _mailAddressEmail :: Text EmailAddress e.g. john@doe.com _mailAddressName :: Text The name of the person to whom you are sending an email. E.g. "John Doe"

Instances

Instances details

Eq MailAddress Source #
Instance details Defined in Network.SendGridV3.Api Methods (==) :: MailAddress -> MailAddress -> Bool # (/=) :: MailAddress -> MailAddress -> Bool #
Show MailAddress Source #
Instance details Defined in Network.SendGridV3.Api Methods showsPrec :: Int -> MailAddress -> ShowS # show :: MailAddress -> String # showList :: [MailAddress] -> ShowS #
ToJSON MailAddress Source #
Instance details Defined in Network.SendGridV3.Api Methods toJSON :: MailAddress -> Value # toEncoding :: MailAddress -> Encoding # toJSONList :: [MailAddress] -> Value # toEncodingList :: [MailAddress] -> Encoding #

data MailContent Source #

Constructors

MailContent
Fields _mailContentType :: Text The mime type of the content you are including in your email. For example, “textplain” or “texthtml”. _mailContentValue :: Text The actual content of the specified mime type that you are including in your email.

Instances

Instances details

Eq MailContent Source #
Instance details Defined in Network.SendGridV3.Api Methods (==) :: MailContent -> MailContent -> Bool # (/=) :: MailContent -> MailContent -> Bool #
Show MailContent Source #
Instance details Defined in Network.SendGridV3.Api Methods showsPrec :: Int -> MailContent -> ShowS # show :: MailContent -> String # showList :: [MailContent] -> ShowS #
ToJSON MailContent Source #
Instance details Defined in Network.SendGridV3.Api Methods toJSON :: MailContent -> Value # toEncoding :: MailContent -> Encoding # toJSONList :: [MailContent] -> Value # toEncodingList :: [MailContent] -> Encoding #

mailContentText :: Text -> MailContent Source #

M̀ailContent constructor for text/plain

mailContentHtml :: Text -> MailContent Source #

M̀ailContent constructor for text/html

data Personalization Source #

An array of messages and their metadata. Each object within personalizations can be thought of as an envelope - it defines who should receive an individual message and how that message should be handled.

Constructors

Personalization

Fields

_personalizationTo :: NonEmpty MailAddress
An array of recipients. Each object within this array may contain the name, but must always contain the email, of a recipient. Each object within personalizations can be thought of as an envelope - it defines who should receive an individual message and how that message should be handled.
_personalizationCc :: Maybe [MailAddress]
An array of recipients who will receive a copy of your email.
_personalizationBcc :: Maybe [MailAddress]
An array of recipients who will receive a blind carbon copy of your email. Each object within this array may contain the name, but must always contain the email, of a recipient.
_personalizationSubject :: Maybe Text
The subject of your email.
_personalizationHeaders :: Maybe [(Text, Text)]
A collection of JSON key/value pairs allowing you to specify specific handling instructions for your email.
_personalizationSubstitutions :: Maybe Object
A collection of key/value pairs following the pattern "substitution_tag":"value to substitute".
_personalizationSendAt :: Maybe Int
A unix timestamp allowing you to specify when you want your email to be delivered. Scheduling more than 72 hours in advance is forbidden.
_personalizationDynamicTemplateData :: Maybe Value
A JSON object to include as dynamic template data.

Instances

Instances details

Eq Personalization Source #
Instance details Defined in Network.SendGridV3.Api Methods (==) :: Personalization -> Personalization -> Bool # (/=) :: Personalization -> Personalization -> Bool #
Show Personalization Source #
Instance details Defined in Network.SendGridV3.Api Methods showsPrec :: Int -> Personalization -> ShowS # show :: Personalization -> String # showList :: [Personalization] -> ShowS #
ToJSON Personalization Source #
Instance details Defined in Network.SendGridV3.Api Methods toJSON :: Personalization -> Value # toEncoding :: Personalization -> Encoding # toJSONList :: [Personalization] -> Value # toEncodingList :: [Personalization] -> Encoding #

personalization :: NonEmpty MailAddress -> Personalization Source #

Personalization smart constructor only asking for the mandatory fields

data Disposition Source #

The content-disposition of the attachment specifying how you would like the attachment to be displayed.

Constructors

Inline	Results in the attached file being displayed automatically within the message.
Attachment	Results in the attached file requiring some action to be taken before it is displayed (e.g. opening or downloading the file).

Instances

Instances details

Eq Disposition Source #
Instance details Defined in Network.SendGridV3.Api Methods (==) :: Disposition -> Disposition -> Bool # (/=) :: Disposition -> Disposition -> Bool #
Show Disposition Source #
Instance details Defined in Network.SendGridV3.Api Methods showsPrec :: Int -> Disposition -> ShowS # show :: Disposition -> String # showList :: [Disposition] -> ShowS #
ToJSON Disposition Source #
Instance details Defined in Network.SendGridV3.Api Methods toJSON :: Disposition -> Value # toEncoding :: Disposition -> Encoding # toJSONList :: [Disposition] -> Value # toEncodingList :: [Disposition] -> Encoding #

data MailAttachment Source #

Constructors

MailAttachment

Fields

_mailAttachmentContent :: Text
The Base64 encoded content of the attachment.
_mailAttachmentType :: Maybe Text
The mime type of the content you are attaching. For example, “textplain” or “texthtml”.
_mailAttachmentFilename :: Text
The filename of the attachment.
_mailAttachmentDisposition :: Maybe Disposition
The content-disposition of the attachment specifying how you would like the attachment to be displayed.
_mailAttachmentContentId :: Text
The content id for the attachment. This is used when the disposition is set to “inline” and the attachment is an image, allowing the file to be displayed within the body of your email.

Instances

Instances details

Eq MailAttachment Source #
Instance details Defined in Network.SendGridV3.Api Methods (==) :: MailAttachment -> MailAttachment -> Bool # (/=) :: MailAttachment -> MailAttachment -> Bool #
Show MailAttachment Source #
Instance details Defined in Network.SendGridV3.Api Methods showsPrec :: Int -> MailAttachment -> ShowS # show :: MailAttachment -> String # showList :: [MailAttachment] -> ShowS #
ToJSON MailAttachment Source #
Instance details Defined in Network.SendGridV3.Api Methods toJSON :: MailAttachment -> Value # toEncoding :: MailAttachment -> Encoding # toJSONList :: [MailAttachment] -> Value # toEncodingList :: [MailAttachment] -> Encoding #

data Asm Source #

An object allowing you to specify how to handle unsubscribes.

Constructors

Asm
Fields _asmGroupId :: Int The unsubscribe group to associate with this email. _asmGroupsToDisplay :: Maybe [Int] An array containing the unsubscribe groups that you would like to be displayed on the unsubscribe preferences page.

Instances

Instances details

Eq Asm Source #
Instance details Defined in Network.SendGridV3.Api Methods (==) :: Asm -> Asm -> Bool # (/=) :: Asm -> Asm -> Bool #
Show Asm Source #
Instance details Defined in Network.SendGridV3.Api Methods showsPrec :: Int -> Asm -> ShowS # show :: Asm -> String # showList :: [Asm] -> ShowS #
ToJSON Asm Source #
Instance details Defined in Network.SendGridV3.Api Methods toJSON :: Asm -> Value # toEncoding :: Asm -> Encoding # toJSONList :: [Asm] -> Value # toEncodingList :: [Asm] -> Encoding #

data Bcc Source #

This allows you to have a blind carbon copy automatically sent to the specified email address for every email that is sent.

Constructors

Bcc
Fields _bccEnable :: Maybe Bool Indicates if this setting is enabled. _bccEmail :: Maybe Text The email address that you would like to receive the BCC.

Instances

Instances details

Eq Bcc Source #
Instance details Defined in Network.SendGridV3.Api Methods (==) :: Bcc -> Bcc -> Bool # (/=) :: Bcc -> Bcc -> Bool #
Show Bcc Source #
Instance details Defined in Network.SendGridV3.Api Methods showsPrec :: Int -> Bcc -> ShowS # show :: Bcc -> String # showList :: [Bcc] -> ShowS #
ToJSON Bcc Source #
Instance details Defined in Network.SendGridV3.Api Methods toJSON :: Bcc -> Value # toEncoding :: Bcc -> Encoding # toJSONList :: [Bcc] -> Value # toEncodingList :: [Bcc] -> Encoding #

data BypassListManagement Source #

Allows you to bypass all unsubscribe groups and suppressions to ensure that the email is delivered to every single recipient. This should only be used in emergencies when it is absolutely necessary that every recipient receives your email.

Constructors

BypassListManagement
Fields _bypassListManagementEnable :: Bool Indicates if this setting is enabled.

Instances

Instances details

Eq BypassListManagement Source #
Instance details Defined in Network.SendGridV3.Api Methods (==) :: BypassListManagement -> BypassListManagement -> Bool # (/=) :: BypassListManagement -> BypassListManagement -> Bool #
Show BypassListManagement Source #
Instance details Defined in Network.SendGridV3.Api Methods showsPrec :: Int -> BypassListManagement -> ShowS # show :: BypassListManagement -> String # showList :: [BypassListManagement] -> ShowS #
ToJSON BypassListManagement Source #
Instance details Defined in Network.SendGridV3.Api Methods toJSON :: BypassListManagement -> Value # toEncoding :: BypassListManagement -> Encoding # toJSONList :: [BypassListManagement] -> Value # toEncodingList :: [BypassListManagement] -> Encoding #

data Footer Source #

The default footer that you would like included on every email.

Constructors

Footer
Fields _footerEnable :: Maybe Bool Indicates if this setting is enabled. _footerText :: Maybe Text The plain text content of your footer. _footerHtml :: Maybe Text The HTML content of your footer.

Instances

data SandboxMode Source #

This allows you to send a test email to ensure that your request body is valid and formatted correctly.

Constructors

SandboxMode
Fields _sandboxModeEnable :: Bool Indicates if this setting is enabled.

Instances

Instances details

Eq SandboxMode Source #
Instance details Defined in Network.SendGridV3.Api Methods (==) :: SandboxMode -> SandboxMode -> Bool # (/=) :: SandboxMode -> SandboxMode -> Bool #
Show SandboxMode Source #
Instance details Defined in Network.SendGridV3.Api Methods showsPrec :: Int -> SandboxMode -> ShowS # show :: SandboxMode -> String # showList :: [SandboxMode] -> ShowS #
ToJSON SandboxMode Source #
Instance details Defined in Network.SendGridV3.Api Methods toJSON :: SandboxMode -> Value # toEncoding :: SandboxMode -> Encoding # toJSONList :: [SandboxMode] -> Value # toEncodingList :: [SandboxMode] -> Encoding #

data SpamCheck Source #

This allows you to test the content of your email for spam.

Constructors

SpamCheck

Fields

_spamCheckEnable :: Maybe Bool
Indicates if this setting is enabled.
_spamCheckThreshold :: Maybe Int
The threshold used to determine if your content qualifies as spam on a scale from 1 to 10, with 10 being most strict, or most likely to be considered as spam.
_spamCheckPostToUrl :: Maybe Text
An Inbound Parse URL that you would like a copy of your email along with the spam report to be sent to.

Instances

Instances details

Eq SpamCheck Source #
Instance details Defined in Network.SendGridV3.Api Methods (==) :: SpamCheck -> SpamCheck -> Bool # (/=) :: SpamCheck -> SpamCheck -> Bool #
Show SpamCheck Source #
Instance details Defined in Network.SendGridV3.Api Methods showsPrec :: Int -> SpamCheck -> ShowS # show :: SpamCheck -> String # showList :: [SpamCheck] -> ShowS #
ToJSON SpamCheck Source #
Instance details Defined in Network.SendGridV3.Api Methods toJSON :: SpamCheck -> Value # toEncoding :: SpamCheck -> Encoding # toJSONList :: [SpamCheck] -> Value # toEncodingList :: [SpamCheck] -> Encoding #

data ClickTracking Source #

Allows you to track whether a recipient clicked a link in your email.

Constructors

ClickTracking
Fields _clickTrackingEnable :: Maybe Bool Indicates if this setting is enabled. _clickTrackingEnableText :: Maybe Bool Indicates if this setting should be included in the text/plain portion of your email.

Instances

Instances details

Eq ClickTracking Source #
Instance details Defined in Network.SendGridV3.Api Methods (==) :: ClickTracking -> ClickTracking -> Bool # (/=) :: ClickTracking -> ClickTracking -> Bool #
Show ClickTracking Source #
Instance details Defined in Network.SendGridV3.Api Methods showsPrec :: Int -> ClickTracking -> ShowS # show :: ClickTracking -> String # showList :: [ClickTracking] -> ShowS #
ToJSON ClickTracking Source #
Instance details Defined in Network.SendGridV3.Api Methods toJSON :: ClickTracking -> Value # toEncoding :: ClickTracking -> Encoding # toJSONList :: [ClickTracking] -> Value # toEncodingList :: [ClickTracking] -> Encoding #

data OpenTracking Source #

Allows you to track whether the email was opened or not.

Constructors

OpenTracking
Fields _openTrackingEnable :: Maybe Bool Indicates if this setting is enabled. _openTrackingSubstitutionTag :: Maybe Text Allows you to specify a substitution tag that you can insert in the body of your email.

Instances

Instances details

Eq OpenTracking Source #
Instance details Defined in Network.SendGridV3.Api Methods (==) :: OpenTracking -> OpenTracking -> Bool # (/=) :: OpenTracking -> OpenTracking -> Bool #
Show OpenTracking Source #
Instance details Defined in Network.SendGridV3.Api Methods showsPrec :: Int -> OpenTracking -> ShowS # show :: OpenTracking -> String # showList :: [OpenTracking] -> ShowS #
ToJSON OpenTracking Source #
Instance details Defined in Network.SendGridV3.Api Methods toJSON :: OpenTracking -> Value # toEncoding :: OpenTracking -> Encoding # toJSONList :: [OpenTracking] -> Value # toEncodingList :: [OpenTracking] -> Encoding #

data SubscriptionTracking Source #

Allows you to insert a subscription management link.

Constructors

SubscriptionTracking

Fields

_subscriptionTrackingEnable :: Maybe Bool
Indicates if this setting is enabled.
_subscriptionTrackingText :: Maybe Text
Text to be appended to the email, with the subscription tracking link.
_subscriptionTrackingHTML :: Maybe Text
HTML to be appended to the email, with the subscription tracking link.
_subscriptionTrackingSubstitutionTag :: Maybe Text
A tag that will be replaced with the unsubscribe URL.

Instances

Instances details

Eq SubscriptionTracking Source #
Instance details Defined in Network.SendGridV3.Api Methods (==) :: SubscriptionTracking -> SubscriptionTracking -> Bool # (/=) :: SubscriptionTracking -> SubscriptionTracking -> Bool #
Show SubscriptionTracking Source #
Instance details Defined in Network.SendGridV3.Api Methods showsPrec :: Int -> SubscriptionTracking -> ShowS # show :: SubscriptionTracking -> String # showList :: [SubscriptionTracking] -> ShowS #
ToJSON SubscriptionTracking Source #
Instance details Defined in Network.SendGridV3.Api Methods toJSON :: SubscriptionTracking -> Value # toEncoding :: SubscriptionTracking -> Encoding # toJSONList :: [SubscriptionTracking] -> Value # toEncodingList :: [SubscriptionTracking] -> Encoding #

data Ganalytics Source #

Allows you to enable tracking provided by Google Analytics

Constructors

Ganalytics

Fields

_ganalyticsEnable :: Maybe Bool
Indicates if this setting is enabled.
_ganalyticsUTMSource :: Maybe Text
Name of the referrer source. (e.g. Google, SomeDomain.com, or Marketing Email)
_ganalyticsUTMMedium :: Maybe Text
Name of the marketing medium. (e.g. Email)
_ganalyticsUTMTerm :: Maybe Text
Used to identify any paid keywords.
_ganalyticsUTMContent :: Maybe Text
Used to differentiate your campaign from advertisements.
_ganalyticsUTMCampaign :: Maybe Text
The name of the campaign.

Instances

Instances details

Eq Ganalytics Source #
Instance details Defined in Network.SendGridV3.Api Methods (==) :: Ganalytics -> Ganalytics -> Bool # (/=) :: Ganalytics -> Ganalytics -> Bool #
Show Ganalytics Source #
Instance details Defined in Network.SendGridV3.Api Methods showsPrec :: Int -> Ganalytics -> ShowS # show :: Ganalytics -> String # showList :: [Ganalytics] -> ShowS #
ToJSON Ganalytics Source #
Instance details Defined in Network.SendGridV3.Api Methods toJSON :: Ganalytics -> Value # toEncoding :: Ganalytics -> Encoding # toJSONList :: [Ganalytics] -> Value # toEncodingList :: [Ganalytics] -> Encoding #

data TrackingSettings Source #

Constructors

TrackingSettings

Fields

_trackingSettingsClickTracking :: ClickTracking
Allows you to track whether a recipient clicked a link in your email.
_trackingSettingsOpenTracking :: OpenTracking
Allows you to track whether the email was opened or not.
_trackingSettingsSubscriptionTracking :: SubscriptionTracking
Allows you to insert a subscription management link
_trackingSettingsGanalytics :: Ganalytics
Allows you to enable tracking provided by Google Analytics.

Instances

Instances details

Eq TrackingSettings Source #
Instance details Defined in Network.SendGridV3.Api Methods (==) :: TrackingSettings -> TrackingSettings -> Bool # (/=) :: TrackingSettings -> TrackingSettings -> Bool #
Show TrackingSettings Source #
Instance details Defined in Network.SendGridV3.Api Methods showsPrec :: Int -> TrackingSettings -> ShowS # show :: TrackingSettings -> String # showList :: [TrackingSettings] -> ShowS #
ToJSON TrackingSettings Source #
Instance details Defined in Network.SendGridV3.Api Methods toJSON :: TrackingSettings -> Value # toEncoding :: TrackingSettings -> Encoding # toJSONList :: [TrackingSettings] -> Value # toEncodingList :: [TrackingSettings] -> Encoding #

data MailSettings Source #

A collection of different mail settings that you can use to specify how you would like this email to be handled.

Constructors

MailSettings

Fields

_mailSettingsBcc :: Maybe Bcc
This allows you to have a blind carbon copy automatically sent to the specified email address for every email that is sent.
_mailSettingsBypassListManagement :: Maybe BypassListManagement
Allows you to bypass all unsubscribe groups and suppressions.
_mailSettingsFooter :: Maybe Footer
The default footer that you would like included on every email.
_mailSettingsSandboxMode :: Maybe SandboxMode
This allows you to send a test email to ensure that your request body is valid and formatted correctly.
_mailSettingsSpamCheck :: Maybe SpamCheck
This allows you to test the content of your email for spam.

Instances

Instances details

Eq MailSettings Source #
Instance details Defined in Network.SendGridV3.Api Methods (==) :: MailSettings -> MailSettings -> Bool # (/=) :: MailSettings -> MailSettings -> Bool #
Show MailSettings Source #
Instance details Defined in Network.SendGridV3.Api Methods showsPrec :: Int -> MailSettings -> ShowS # show :: MailSettings -> String # showList :: [MailSettings] -> ShowS #
ToJSON MailSettings Source #
Instance details Defined in Network.SendGridV3.Api Methods toJSON :: MailSettings -> Value # toEncoding :: MailSettings -> Encoding # toJSONList :: [MailSettings] -> Value # toEncodingList :: [MailSettings] -> Encoding #

data Mail a b Source #

Constructors

Mail

Fields

_mailPersonalizations :: [Personalization]
An array of messages and their metadata. Each object within personalizations can be thought of as an envelope - it defines who should receive an individual message and how that message should be handled.
_mailFrom :: MailAddress
Address details of the person to whom you are sending an email.
_mailReplyTo :: Maybe MailAddress
Address details of the person to whom you are sending an email.
_mailSubject :: Text
The subject of your email.
_mailContent :: Maybe (NonEmpty MailContent)
An array in which you may specify the content of your email. You can include multiple mime types of content, but you must specify at least one mime type.
_mailAttachments :: Maybe [MailAttachment]
An array of objects in which you can specify any attachments you want to include.
_mailTemplateId :: Maybe Text
The id of a template that you would like to use. If you use a template that contains a subject and content (either text or html), you do not need to specify those at the personalizations nor message level.
_mailSections :: Maybe a
An object of key/value pairs that define block sections of code to be used as substitutions.
_mailHeaders :: Maybe [(Text, Text)]
An object containing key/value pairs of header names and the value to substitute for them. You must ensure these are properly encoded if they contain unicode characters. Must not be one of the reserved headers.
_mailCategories :: Maybe [Text]
An array of category names for this message. Each category name may not exceed 255 characters.
_mailCustomArgs :: Maybe b
Values that are specific to the entire send that will be carried along with | the email and its activity data.
_mailSendAt :: Maybe Int
A unix timestamp allowing you to specify when you want your email to be delivered.
_mailBatchId :: Maybe Text
This ID represents a batch of emails to be sent at the same time. Including a batch_id in your request allows you include this email in that batch, and also enables you to cancel or pause the delivery of that batch. For more information, see https://sendgrid.com/docs/API_Reference/Web_API_v3/cancel_schedule_send.html
_mailAsm :: Maybe Asm
An object allowing you to specify how to handle unsubscribes.
_mailIpPoolName :: Maybe Text
The IP Pool that you would like to send this email from.
_mailMailSettings :: Maybe MailSettings
A collection of different mail settings that you can use to specify how you would like this email to be handled.
_mailTrackingSettings :: Maybe TrackingSettings
Settings to determine how you would like to track the metrics of how your recipients interact with your email.

Instances

Instances details

(Eq a, Eq b) => Eq (Mail a b) Source #
Instance details Defined in Network.SendGridV3.Api Methods (==) :: Mail a b -> Mail a b -> Bool # (/=) :: Mail a b -> Mail a b -> Bool #
(Show a, Show b) => Show (Mail a b) Source #
Instance details Defined in Network.SendGridV3.Api Methods showsPrec :: Int -> Mail a b -> ShowS # show :: Mail a b -> String # showList :: [Mail a b] -> ShowS #
(ToJSON a, ToJSON b) => ToJSON (Mail a b) Source #
Instance details Defined in Network.SendGridV3.Api Methods toJSON :: Mail a b -> Value # toEncoding :: Mail a b -> Encoding # toJSONList :: [Mail a b] -> Value # toEncodingList :: [Mail a b] -> Encoding #

mail :: (ToJSON a, ToJSON b) => [Personalization] -> MailAddress -> Text -> Maybe (NonEmpty MailContent) -> Mail a b Source #

Smart constructor for Mail, asking only for the mandatory Mail parameters.

sendMail :: (ToJSON a, ToJSON b) => ApiKey -> Mail a b -> IO (Either HttpException (Response ByteString)) Source #

Send an email via the SendGrid API.

a: Type of Mail Section, see _mailSections for details.
b: Type of Custom Arg, see _mailCustomArgs for details.

Returns either: - A successful Response from the SendGrid API - An HttpException, thrown from postWith

Eq Footer Source #
Instance details Defined in Network.SendGridV3.Api Methods (==) :: Footer -> Footer -> Bool # (/=) :: Footer -> Footer -> Bool #
Show Footer Source #
Instance details Defined in Network.SendGridV3.Api Methods showsPrec :: Int -> Footer -> ShowS # show :: Footer -> String # showList :: [Footer] -> ShowS #
ToJSON Footer Source #
Instance details Defined in Network.SendGridV3.Api Methods toJSON :: Footer -> Value # toEncoding :: Footer -> Encoding # toJSONList :: [Footer] -> Value # toEncodingList :: [Footer] -> Encoding #