Safe Haskell	Safe-Inferred
Language	Haskell2010

Network.Mail.Mailtrap

Contents

Tokens
Accounts
Attachments
Templates
Testing inboxes
Sending e-mails

Description

Mailtrap API.

Synopsis

newtype Token = Token Text
data Exception
- = MultipleErrors Int [Text]
- | SingleError Int Text
- | ParsingError ByteString String
newtype AccountID = AccountID Int
data Account = Account {
- account_id :: AccountID
- account_name :: Text
}
getAllAccounts :: Token -> IO [Account]
data Disposition
- = Inline Text
- | Attached
setDisposition :: Disposition -> Attachment -> Attachment
data Attachment = Attachment {
- attachment_name :: Text
- attachment_type :: MimeType
- attachment_content :: ByteString
- attachment_disposition :: Disposition
}
attachmentFromFile :: FilePath -> IO Attachment
data Template = Template {
- template_id :: UUID
- template_variables :: Object
}
template :: UUID -> Template
setTemplateVariable :: ToJSON a => Text -> a -> Template -> Template
newtype InboxID = InboxID Int
data Inbox = Inbox {
- inbox_id :: InboxID
- inbox_name :: Text
- inbox_emailCount :: Int
- inbox_unreadCount :: Int
- inbox_maxSize :: Int
}
getInboxes :: Token -> AccountID -> IO [Inbox]
newtype InboxMessageID = InboxMessageID Int
data InboxMessage = InboxMessage {
- inboxMessage_id :: InboxMessageID
- inboxMessage_inbox :: InboxID
- inboxMessage_sentAt :: UTCTime
- inboxMessage_from :: EmailAddress
- inboxMessage_to :: EmailAddress
- inboxMessage_subject :: Text
- inboxMessage_isRead :: Bool
}
getInboxMessages :: Token -> AccountID -> InboxID -> IO [InboxMessage]
downloadMessageRaw :: Token -> AccountID -> InboxID -> InboxMessageID -> IO Text
downloadMessageEML :: Token -> AccountID -> InboxID -> InboxMessageID -> IO Text
downloadMessageText :: Token -> AccountID -> InboxID -> InboxMessageID -> IO Text
downloadMessageHTML :: Token -> AccountID -> InboxID -> InboxMessageID -> IO Text
data EmailAddress
parseEmailAddress :: ByteString -> Either String EmailAddress
data NamedEmailAddress = NamedEmailAddress {
- emailAddress :: EmailAddress
- emailAddressName :: Text
}
newtype MessageID = MessageID UUID
data Message = Message {
- message_subject :: Text
- message_body :: EmailBody
- message_category :: Text
}
data EmailBody
- = PlainTextBody Text
- | HTMLOnlyBody Html
- | HTMLBody Html Text
data Email = Email {
- email_from :: NamedEmailAddress
- email_to :: [NamedEmailAddress]
- email_cc :: [NamedEmailAddress]
- email_bcc :: [NamedEmailAddress]
- email_attachments :: [Attachment]
- email_custom :: Object
- email_message :: Either Template Message
}
sendEmail :: Token -> Email -> IO [MessageID]
sendTestEmail :: Token -> InboxID -> Email -> IO [InboxMessageID]

Tokens

newtype Token Source #

Authorization token.

Constructors

Token Text

Instances

Instances details

FromJSON Token Source #
Instance details Defined in Network.Mail.Mailtrap Methods parseJSON :: Value -> Parser Token # parseJSONList :: Value -> Parser [Token] # omittedField :: Maybe Token #
ToJSON Token Source #
Instance details Defined in Network.Mail.Mailtrap Methods toJSON :: Token -> Value # toEncoding :: Token -> Encoding # toJSONList :: [Token] -> Value # toEncodingList :: [Token] -> Encoding # omitField :: Token -> Bool #
Show Token Source #
Instance details Defined in Network.Mail.Mailtrap Methods showsPrec :: Int -> Token -> ShowS # show :: Token -> String # showList :: [Token] -> ShowS #
Eq Token Source #
Instance details Defined in Network.Mail.Mailtrap Methods (==) :: Token -> Token -> Bool # (/=) :: Token -> Token -> Bool #

data Exception Source #

Exceptions thrown by functions from this module.

Constructors

MultipleErrors Int [Text]	API request returned list of errors. HTTP status code and error messages.
SingleError Int Text	API request returned a single error message. HTTP status code and error message.
ParsingError ByteString String	Parsing failed. Input that failed to parse plus error message.

Instances

Instances details

Exception Exception Source #
Instance details Defined in Network.Mail.Mailtrap Methods toException :: Exception -> SomeException # fromException :: SomeException -> Maybe Exception # displayException :: Exception -> String #
Show Exception Source #
Instance details Defined in Network.Mail.Mailtrap Methods showsPrec :: Int -> Exception -> ShowS # show :: Exception -> String # showList :: [Exception] -> ShowS #

Accounts

newtype AccountID Source #

Mailtrap account ID.

Constructors

AccountID Int

Instances

Instances details

FromJSON AccountID Source #
Instance details Defined in Network.Mail.Mailtrap Methods parseJSON :: Value -> Parser AccountID # parseJSONList :: Value -> Parser [AccountID] # omittedField :: Maybe AccountID #
Show AccountID Source #
Instance details Defined in Network.Mail.Mailtrap Methods showsPrec :: Int -> AccountID -> ShowS # show :: AccountID -> String # showList :: [AccountID] -> ShowS #
Eq AccountID Source #
Instance details Defined in Network.Mail.Mailtrap Methods (==) :: AccountID -> AccountID -> Bool # (/=) :: AccountID -> AccountID -> Bool #

data Account Source #

Mailtrap account.

Constructors

Account
Fields account_id :: AccountID account_name :: Text

Instances

Instances details

FromJSON Account Source #
Instance details Defined in Network.Mail.Mailtrap Methods parseJSON :: Value -> Parser Account # parseJSONList :: Value -> Parser [Account] # omittedField :: Maybe Account #
Show Account Source #
Instance details Defined in Network.Mail.Mailtrap Methods showsPrec :: Int -> Account -> ShowS # show :: Account -> String # showList :: [Account] -> ShowS #

getAllAccounts :: Token -> IO [Account] Source #

Get all the accounts the given token has access to.

Attachments

data Disposition Source #

Attachment disposition.

Constructors

Inline Text	Inline with identifier.
Attached

Instances

Instances details

Show Disposition Source #
Instance details Defined in Network.Mail.Mailtrap Methods showsPrec :: Int -> Disposition -> ShowS # show :: Disposition -> String # showList :: [Disposition] -> ShowS #

setDisposition :: Disposition -> Attachment -> Attachment Source #

Set an attachment's disposition.

data Attachment Source #

File that can be attached to an e-mail.

Constructors

Attachment
Fields attachment_name :: Text File name. attachment_type :: MimeType MIME type of the content. attachment_content :: ByteString Attachment content. attachment_disposition :: Disposition Attachment disposition.

Instances

Instances details

ToJSON Attachment Source #
Instance details Defined in Network.Mail.Mailtrap Methods toJSON :: Attachment -> Value # toEncoding :: Attachment -> Encoding # toJSONList :: [Attachment] -> Value # toEncodingList :: [Attachment] -> Encoding # omitField :: Attachment -> Bool #
Show Attachment Source #
Instance details Defined in Network.Mail.Mailtrap Methods showsPrec :: Int -> Attachment -> ShowS # show :: Attachment -> String # showList :: [Attachment] -> ShowS #

attachmentFromFile :: FilePath -> IO Attachment Source #

Create an attachment from a file. It guesses the mime type from the file extension. Disposition is set to Attached. The file is read strictly.

Templates

data Template Source #

Template that can be used when sending e-mails.

Constructors

Template
Fields template_id :: UUID ID of the template. template_variables :: Object Template variable assignments.

Instances

Instances details

Show Template Source #
Instance details Defined in Network.Mail.Mailtrap Methods showsPrec :: Int -> Template -> ShowS # show :: Template -> String # showList :: [Template] -> ShowS #

template :: UUID -> Template Source #

Template with no variable set.

setTemplateVariable :: ToJSON a => Text -> a -> Template -> Template Source #

Set template variable.

Testing inboxes

newtype InboxID Source #

Testing inbox identifier.

Constructors

InboxID Int

Instances

Instances details

FromJSON InboxID Source #
Instance details Defined in Network.Mail.Mailtrap Methods parseJSON :: Value -> Parser InboxID # parseJSONList :: Value -> Parser [InboxID] # omittedField :: Maybe InboxID #
Show InboxID Source #
Instance details Defined in Network.Mail.Mailtrap Methods showsPrec :: Int -> InboxID -> ShowS # show :: InboxID -> String # showList :: [InboxID] -> ShowS #
Eq InboxID Source #
Instance details Defined in Network.Mail.Mailtrap Methods (==) :: InboxID -> InboxID -> Bool # (/=) :: InboxID -> InboxID -> Bool #

data Inbox Source #

Testing inbox.

Constructors

Inbox
Fields inbox_id :: InboxID inbox_name :: Text inbox_emailCount :: Int Number of emails in the inbox. inbox_unreadCount :: Int Number of unread emails in the inbox. inbox_maxSize :: Int

Instances

Instances details

FromJSON Inbox Source #
Instance details Defined in Network.Mail.Mailtrap Methods parseJSON :: Value -> Parser Inbox # parseJSONList :: Value -> Parser [Inbox] # omittedField :: Maybe Inbox #
Show Inbox Source #
Instance details Defined in Network.Mail.Mailtrap Methods showsPrec :: Int -> Inbox -> ShowS # show :: Inbox -> String # showList :: [Inbox] -> ShowS #

getInboxes :: Token -> AccountID -> IO [Inbox] Source #

Get all inboxes from an account.

newtype InboxMessageID Source #

Inbox message identifier.

Constructors

InboxMessageID Int

Instances

Instances details

FromJSON InboxMessageID Source #
Instance details Defined in Network.Mail.Mailtrap Methods parseJSON :: Value -> Parser InboxMessageID # parseJSONList :: Value -> Parser [InboxMessageID] # omittedField :: Maybe InboxMessageID #
Show InboxMessageID Source #
Instance details Defined in Network.Mail.Mailtrap Methods showsPrec :: Int -> InboxMessageID -> ShowS # show :: InboxMessageID -> String # showList :: [InboxMessageID] -> ShowS #
Eq InboxMessageID Source #
Instance details Defined in Network.Mail.Mailtrap Methods (==) :: InboxMessageID -> InboxMessageID -> Bool # (/=) :: InboxMessageID -> InboxMessageID -> Bool #

data InboxMessage Source #

A message in a testing inbox.

Constructors

InboxMessage
Fields inboxMessage_id :: InboxMessageID inboxMessage_inbox :: InboxID inboxMessage_sentAt :: UTCTime inboxMessage_from :: EmailAddress inboxMessage_to :: EmailAddress inboxMessage_subject :: Text inboxMessage_isRead :: Bool

Instances

Instances details

FromJSON InboxMessage Source #
Instance details Defined in Network.Mail.Mailtrap Methods parseJSON :: Value -> Parser InboxMessage # parseJSONList :: Value -> Parser [InboxMessage] # omittedField :: Maybe InboxMessage #
Show InboxMessage Source #
Instance details Defined in Network.Mail.Mailtrap Methods showsPrec :: Int -> InboxMessage -> ShowS # show :: InboxMessage -> String # showList :: [InboxMessage] -> ShowS #

getInboxMessages :: Token -> AccountID -> InboxID -> IO [InboxMessage] Source #

Get all inbox messages from an testing inbox.

downloadMessageRaw :: Token -> AccountID -> InboxID -> InboxMessageID -> IO Text Source #

Download inbox message raw email body.

downloadMessageEML :: Token -> AccountID -> InboxID -> InboxMessageID -> IO Text Source #

Download inbox message in EML format.

downloadMessageText :: Token -> AccountID -> InboxID -> InboxMessageID -> IO Text Source #

Download inbox message text part.

downloadMessageHTML :: Token -> AccountID -> InboxID -> InboxMessageID -> IO Text Source #

Download inbox message HTML part.

Sending e-mails

data EmailAddress #

Represents an email address.

Instances

Instances details

Data EmailAddress
Instance details Defined in Text.Email.Parser Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EmailAddress -> c EmailAddress # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EmailAddress # toConstr :: EmailAddress -> Constr # dataTypeOf :: EmailAddress -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c EmailAddress) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EmailAddress) # gmapT :: (forall b. Data b => b -> b) -> EmailAddress -> EmailAddress # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EmailAddress -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EmailAddress -> r # gmapQ :: (forall d. Data d => d -> u) -> EmailAddress -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> EmailAddress -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> EmailAddress -> m EmailAddress # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EmailAddress -> m EmailAddress # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EmailAddress -> m EmailAddress #
Generic EmailAddress
Instance details Defined in Text.Email.Parser Associated Types type Rep EmailAddress :: Type -> Type # Methods from :: EmailAddress -> Rep EmailAddress x # to :: Rep EmailAddress x -> EmailAddress #
Read EmailAddress
Instance details Defined in Text.Email.Parser Methods readsPrec :: Int -> ReadS EmailAddress # readList :: ReadS [EmailAddress] # readPrec :: ReadPrec EmailAddress # readListPrec :: ReadPrec [EmailAddress] #
Show EmailAddress
Instance details Defined in Text.Email.Parser Methods showsPrec :: Int -> EmailAddress -> ShowS # show :: EmailAddress -> String # showList :: [EmailAddress] -> ShowS #
Eq EmailAddress
Instance details Defined in Text.Email.Parser Methods (==) :: EmailAddress -> EmailAddress -> Bool # (/=) :: EmailAddress -> EmailAddress -> Bool #
Ord EmailAddress
Instance details Defined in Text.Email.Parser Methods compare :: EmailAddress -> EmailAddress -> Ordering # (<) :: EmailAddress -> EmailAddress -> Bool # (<=) :: EmailAddress -> EmailAddress -> Bool # (>) :: EmailAddress -> EmailAddress -> Bool # (>=) :: EmailAddress -> EmailAddress -> Bool # max :: EmailAddress -> EmailAddress -> EmailAddress # min :: EmailAddress -> EmailAddress -> EmailAddress #
type Rep EmailAddress
Instance details Defined in Text.Email.Parser type Rep EmailAddress = D1 ('MetaData "EmailAddress" "Text.Email.Parser" "email-validate-2.3.2.20-1Vy9fpOYeovBfF4uThfL4t" 'False) (C1 ('MetaCons "EmailAddress" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

parseEmailAddress :: ByteString -> Either String EmailAddress Source #

Attempt to parse an e-mail address

data NamedEmailAddress Source #

An e-mail address with a name.

Constructors

NamedEmailAddress
Fields emailAddress :: EmailAddress emailAddressName :: Text

Instances

Instances details

ToJSON NamedEmailAddress Source #
Instance details Defined in Network.Mail.Mailtrap Methods toJSON :: NamedEmailAddress -> Value # toEncoding :: NamedEmailAddress -> Encoding # toJSONList :: [NamedEmailAddress] -> Value # toEncodingList :: [NamedEmailAddress] -> Encoding # omitField :: NamedEmailAddress -> Bool #
Show NamedEmailAddress Source #
Instance details Defined in Network.Mail.Mailtrap Methods showsPrec :: Int -> NamedEmailAddress -> ShowS # show :: NamedEmailAddress -> String # showList :: [NamedEmailAddress] -> ShowS #

newtype MessageID Source #

Production message identifier.

Constructors

MessageID UUID

Instances

Instances details

FromJSON MessageID Source #
Instance details Defined in Network.Mail.Mailtrap Methods parseJSON :: Value -> Parser MessageID # parseJSONList :: Value -> Parser [MessageID] # omittedField :: Maybe MessageID #
Show MessageID Source #
Instance details Defined in Network.Mail.Mailtrap Methods showsPrec :: Int -> MessageID -> ShowS # show :: MessageID -> String # showList :: [MessageID] -> ShowS #
Eq MessageID Source #
Instance details Defined in Network.Mail.Mailtrap Methods (==) :: MessageID -> MessageID -> Bool # (/=) :: MessageID -> MessageID -> Bool #

data Message Source #

E-mail message, including subject and body.

Constructors

Message
Fields message_subject :: Text message_body :: EmailBody message_category :: Text Message category.

data EmailBody Source #

An e-mail body.

Constructors

PlainTextBody Text	Plain-text body.
HTMLOnlyBody Html	HTML-only body.
HTMLBody Html Text	HTML body with text fallback.

data Email Source #

E-mail that can be sent using sendEmail.

Constructors

Email
Fields email_from :: NamedEmailAddress Sender address. email_to :: [NamedEmailAddress] Recipient list. Max 1000. email_cc :: [NamedEmailAddress] Carbon Copy recipients. email_bcc :: [NamedEmailAddress] Blind Carbon Copy recipients. email_attachments :: [Attachment] Files attached to the e-mail. email_custom :: Object Custom JSON object. email_message :: Either Template Message Message to send.

Instances

Instances details

ToJSON Email Source #
Instance details Defined in Network.Mail.Mailtrap Methods toJSON :: Email -> Value # toEncoding :: Email -> Encoding # toJSONList :: [Email] -> Value # toEncodingList :: [Email] -> Encoding # omitField :: Email -> Bool #

sendEmail :: Token -> Email -> IO [MessageID] Source #

Send an e-mail and return the list of IDs of the messages sent (one per recipient).

sendTestEmail :: Token -> InboxID -> Email -> IO [InboxMessageID] Source #

Send a testing e-mail to the given inbox and return the list of IDs of the messages sent (one per recipient).