Network.GMail.Simple

Interactions with GMail made simple.

Sending mails

For now, only mail sending is implemented. Here's an example:

First we read the Google key file.

do gkey <- readKeyFile "google-key.json"

Then we start a session. We provide the mail address of the user that will send the mail.

   session <- newSession gkey "[e-mail]"

Here's the mail description.

   let mail :: Mail Text
       mail = Mail
         { mail_sender = "Me"
         , mail_recipient = "[e-mail]"
         , mail_subject = "Example mail"
         , mail_body = "This is an example mail."
           }

Finally, we simply send the mail.

   sendMail session mail

That's it.

Importing this library

I would recommend importing this module qualified. For example:

import qualified Network.GMail.Simple as GMail

Key

data Key

Google API Key from a service account. You can create one inside your project in Google Cloud. Once you have it, you can download it to a file and read it using readKeyFile.

Constructors

Key

Fields

• private_key :: PrivateKey
• private_key_id :: Text
• client_email :: MailAddress

Instances

FromJSON Key

Defined in Network.GMail.Simple

Methods

parseJSON :: Value -> Parser Key

parseJSONList :: Value -> Parser [Key]

omittedField :: Maybe Key

readKeyFile :: FilePath -> IO Key

Read the key file provided by Google Cloud. It throws a FailedToParseKey exception when the file fails to parse.

If you don't want to read it from a local file, you can use the FromJSON instance of Key to read it. The function readKeyFile is just a wrapper around that.

Session

data Session

A session that can be used to send mails.

• It may be reused.
• Multiple threads can use it simultaneously.

newSession

Arguments

:: Key

Google API key

-> MailAddress

Mail address of the sender

-> IO Session

Create a new session for the given sender.

Mail

newtype MailAddress

A mail address as text.

Constructors

MailAddress Text

Instances

IsString MailAddress

Defined in Network.GMail.Simple

Methods

fromString :: String -> MailAddress

data Mail a

Mail datatype.

Constructors

Mail

Fields

• mail_sender :: Text

  Sender's alias.

• mail_recipient :: MailAddress

  The recipient of this mail.

• mail_subject :: Text

  The subject of this mail.

• mail_body :: a

  Polymorphic mail body.

Instances

Functor Mail

You can use fmap to map a function over the body of a mail.

Defined in Network.GMail.Simple

Methods

fmap :: (a -> b) -> Mail a -> Mail b

(<$) :: a -> Mail b -> Mail a

sendMail :: ToMailBody a => Session -> Mail a -> IO ()

Send mail using a session. It might throw a FailedToSend exception.

In order for this to work, the user must have permissions for the https://www.googleapis.com/auth/gmail.send scope.

Mail body

class ToMailBody a where

Class of types that can be used as mail body.

Methods

toMailBody :: a -> Text

Textual representation of the mail body.

mailContentType :: proxy a -> MediaType

Value for the Content-Type header.

Instances

ToMailBody Html

Defined in Network.GMail.Simple

Methods

toMailBody :: Html -> Text

mailContentType :: proxy Html -> MediaType

ToMailBody Text

Defined in Network.GMail.Simple

Methods

toMailBody :: Text -> Text

mailContentType :: proxy Text -> MediaType

Exceptions

data GMailException

Exceptions thrown by functions in this library.

Constructors

FailedToSend Value

A mail failed to be sent. The JSON value contains the error message as sent by Google.

FailedToParseKey String

A key file failed to parse. The string contains the parsing error.

Instances

Exception GMailException

Defined in Network.GMail.Simple

Methods

toException :: GMailException -> SomeException

fromException :: SomeException -> Maybe GMailException

displayException :: GMailException -> String

Show GMailException

Defined in Network.GMail.Simple

Methods

showsPrec :: Int -> GMailException -> ShowS

show :: GMailException -> String

showList :: [GMailException] -> ShowS