-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Simple library for Google Mail (GMail).
--   
--   Easy-to-use library to interact with the Google Mail API.
--   
--   Currently only supporting sending mails.
@package gmail-simple
@version 0.1.0.4


-- | Interactions with GMail made simple.
--   
--   <h2>Sending mails</h2>
--   
--   For now, only mail sending is implemented. Here's an example:
--   
--   First we read the Google key file.
--   
--   <pre>
--   do gkey &lt;- readKeyFile "google-key.json"
--   </pre>
--   
--   Then we start a session. We provide the mail address of the user that
--   will send the mail.
--   
--   <pre>
--   session &lt;- newSession gkey "sender@example.com"
--   </pre>
--   
--   Here's the mail description.
--   
--   <pre>
--   let mail :: Mail Text
--       mail = Mail
--         { mail_sender = "Me"
--         , mail_recipient = "recipient@example.com"
--         , mail_subject = "Example mail"
--         , mail_body = "This is an example mail."
--           }
--   </pre>
--   
--   Finally, we simply send the mail.
--   
--   <pre>
--   sendMail session mail
--   </pre>
--   
--   That's it.
--   
--   <h2>Importing this library</h2>
--   
--   I would recommend importing this module qualified. For example:
--   
--   <pre>
--   import qualified Network.GMail.Simple as GMail
--   </pre>
module Network.GMail.Simple

-- | Google API Key from a service account. You can create one inside your
--   project in <a>Google Cloud</a>. Once you have it, you can download it
--   to a file and read it using <a>readKeyFile</a>.
data Key
Key :: PrivateKey -> Text -> MailAddress -> Key
[private_key] :: Key -> PrivateKey
[private_key_id] :: Key -> Text
[client_email] :: Key -> MailAddress

-- | Read the key file provided by Google Cloud. It throws a
--   <a>FailedToParseKey</a> exception when the file fails to parse.
--   
--   If you don't want to read it from a local file, you can use the
--   <a>FromJSON</a> instance of <a>Key</a> to read it. The function
--   <a>readKeyFile</a> is just a wrapper around that.
readKeyFile :: FilePath -> IO Key

-- | A session that can be used to send mails.
--   
--   <ul>
--   <li>It may be reused.</li>
--   <li>Multiple threads can use it simultaneously.</li>
--   </ul>
data Session

-- | Create a new session for the given sender.
newSession :: Key -> MailAddress -> IO Session

-- | A mail address as text.
newtype MailAddress
MailAddress :: Text -> MailAddress

-- | Mail datatype.
data Mail a
Mail :: Text -> MailAddress -> Text -> a -> Mail a

-- | Sender's alias.
[mail_sender] :: Mail a -> Text

-- | The recipient of this mail.
[mail_recipient] :: Mail a -> MailAddress

-- | The subject of this mail.
[mail_subject] :: Mail a -> Text

-- | Polymorphic mail body.
[mail_body] :: Mail a -> a

-- | Send mail using a session. It might throw a <a>FailedToSend</a>
--   exception.
--   
--   In order for this to work, the user must have permissions for the
--   <tt><a>https://www.googleapis.com/auth/gmail.send</a></tt> scope.
sendMail :: ToMailBody a => Session -> Mail a -> IO ()

-- | Class of types that can be used as mail body.
class ToMailBody a

-- | Textual representation of the mail body.
toMailBody :: ToMailBody a => a -> Text

-- | Value for the <tt>Content-Type</tt> header.
mailContentType :: ToMailBody a => proxy a -> MediaType

-- | Exceptions thrown by functions in this library.
data GMailException

-- | A mail failed to be sent. The JSON value contains the error message as
--   sent by Google.
FailedToSend :: Value -> GMailException

-- | A key file failed to parse. The string contains the parsing error.
FailedToParseKey :: String -> GMailException
instance GHC.Show.Show Network.GMail.Simple.GMailException
instance Network.GMail.Simple.ToMailBody Data.Text.Internal.Text
instance Network.GMail.Simple.ToMailBody Text.Blaze.Html.Html
instance GHC.Exception.Type.Exception Network.GMail.Simple.GMailException
instance Data.Aeson.Types.FromJSON.FromJSON Network.GMail.Simple.OAuth
instance Data.Aeson.Types.FromJSON.FromJSON Network.GMail.Simple.Key
instance GHC.Base.Functor Network.GMail.Simple.Mail
instance Data.String.IsString Network.GMail.Simple.MailAddress