Network.Nylas.Types

Types

type Url = String

newtype AccessToken

The access token from Nylas to access data from a single inbox.

Constructors

AccessToken Text

Instances

Eq AccessToken

Show AccessToken

newtype NylasId

The unique ID for a Nylas object.

Constructors

NylasId

Fields

_nylasId :: Text

Instances

Eq NylasId

Show NylasId

Generic NylasId

FromJSON NylasId

type Rep NylasId

Nylas Object Types

data Mailbox

A tuple of an email address and the optional name accompanying it, for participants in Threads and Messages.

Constructors

Mailbox

Fields

_mailboxName :: Maybe Text

_mailboxEmail :: Text

Instances

Eq Mailbox

Show Mailbox

FromJSON Mailbox

data File

A file attached to a Message.

Constructors

File

Fields

_fileId :: NylasId

_fileContentType :: Text

_fileName :: Text

_fileSize :: Int

_fileContentId :: Maybe Text

Instances

Eq File

Show File

FromJSON File

newtype MessageTime

The time a message was sent.

Constructors

MessageTime

Fields

_utcTime :: UTCTime

Instances

Eq MessageTime

Show MessageTime

Generic MessageTime

FromJSON MessageTime

type Rep MessageTime

data ReadStatus

Whether a Message has been read in the inbox.

Constructors

MessageRead

MessageUnread

Instances

Eq ReadStatus

Show ReadStatus

data StarStatus

Whether a Message or Thread has been starred in the inbox.

Constructors

Starred

Unstarred

Instances

Eq StarStatus

Show StarStatus

FromJSON StarStatus

data Label

A Gmail-style label applied to a Message or Thread.

Constructors

Label

Fields

_labelId :: NylasId

_labelName :: Text

_labelDisplayName :: Text

Instances

Eq Label

Show Label

FromJSON Label

data Folder

An IMAP-style folder in which Messages can reside. A Thread can contain Messages spanning multiple folders.

Constructors

Folder

Fields

_folderId :: NylasId

_folderName :: Text

_folderDisplayName :: Text

Instances

Eq Folder

Show Folder

FromJSON Folder

data Message

An email message.

Constructors

Message

Fields

_messageId :: NylasId

_messageSubject :: Text

_messageSenders :: [Mailbox]

_messageToRecipients :: [Mailbox]

_messageCcRecipients :: [Mailbox]

_messageBccRecipients :: [Mailbox]

_messageTime :: MessageTime

_messageThreadId :: NylasId

_messageFiles :: [File]

_messageSnippet :: Text

_messageLabels :: Maybe [Label]

_messageFolder :: Maybe Folder

_messageBody :: Text

_messageRead :: ReadStatus

_messageStarred :: StarStatus

Instances

Eq Message

Show Message

FromJSON Message

data AttachmentsStatus

Whether a Thread contains any attached Files.

Constructors

HasAttachments

NoAttachments

Instances

Eq AttachmentsStatus

Show AttachmentsStatus

FromJSON AttachmentsStatus

data Thread

A chain of Messages.

Constructors

Thread

Fields

_threadId :: NylasId

_threadSubject :: Text

_threadFirstTimestamp :: MessageTime

_threadLastTimestamp :: MessageTime

_threadParticipants :: [Mailbox]

_threadSnippet :: Text

_threadLabels :: Maybe [Label]

_threadFolders :: Maybe [Folder]

_threadMessageIds :: [NylasId]

_threadDraftIds :: [NylasId]

_threadVersion :: Int

_threadStarred :: StarStatus

_threadAttachments :: AttachmentsStatus

Instances

Eq Thread

Show Thread

FromJSON Thread

Streaming Types

newtype Cursor

The transactional cursor as of a certain Delta. When requesting a stream of updates, clients should provide the Cursor for the last Delta they successfully consumed.

Constructors

Cursor

Fields

_cursorId :: Text

Instances

Eq Cursor

Show Cursor

Generic Cursor

FromJSON Cursor

type Rep Cursor

data StreamingError

An error in a streaming pipeline involving consumeDeltas.

Constructors

ParsingError DecodingError (Producer ByteString IO ())

An error in parsing JSON

ConsumerError Text

An error produced by clients while consuming Deltas

data Change a

The change operation wrapping the affected object in a Delta. If the object has been created or modified (as opposed to deleted), the object is nested within the Change.

Constructors

Create a

Modify a

Delete

Instances

Eq a => Eq (Change a)

Show a => Show (Change a)

data DeltaChange

The type of modification to the inbox the Delta contains.

Constructors

CalendarChange

ContactChange

EventChange

FileChange

MessageChange (Change Message)

DraftChange

ThreadChange (Change Thread)

LabelChange

FolderChange

Instances

Eq DeltaChange

Show DeltaChange

data Delta

A change to an inbox with a transactional Cursor to continue processing from this Delta in the future.

Constructors

Delta

Fields

_deltaCursor :: Cursor

_deltaObjectId :: NylasId

_deltaChange :: DeltaChange

Instances

Eq Delta

Show Delta

ToJSON Delta

FromJSON Delta

Lenses

nylasId :: Iso' NylasId Text

mailboxName :: Lens' Mailbox (Maybe Text)

mailboxEmail :: Lens' Mailbox Text

fileSize :: Lens' File Int

fileName :: Lens' File Text

fileId :: Lens' File NylasId

fileContentType :: Lens' File Text

fileContentId :: Lens' File (Maybe Text)

utcTime :: Iso' MessageTime UTCTime

_MessageUnread :: Prism' ReadStatus ()

_MessageRead :: Prism' ReadStatus ()

_Unstarred :: Prism' StarStatus ()

_Starred :: Prism' StarStatus ()

labelName :: Lens' Label Text

labelId :: Lens' Label NylasId

labelDisplayName :: Lens' Label Text

folderName :: Lens' Folder Text

folderId :: Lens' Folder NylasId

folderDisplayName :: Lens' Folder Text

messageToRecipients :: Lens' Message [Mailbox]

messageTime :: Lens' Message MessageTime

messageThreadId :: Lens' Message NylasId

messageSubject :: Lens' Message Text

messageStarred :: Lens' Message StarStatus

messageSnippet :: Lens' Message Text

messageSenders :: Lens' Message [Mailbox]

messageRead :: Lens' Message ReadStatus

messageLabels :: Lens' Message (Maybe [Label])

messageId :: Lens' Message NylasId

messageFolder :: Lens' Message (Maybe Folder)

messageFiles :: Lens' Message [File]

messageCcRecipients :: Lens' Message [Mailbox]

messageBody :: Lens' Message Text

messageBccRecipients :: Lens' Message [Mailbox]

_NoAttachments :: Prism' AttachmentsStatus ()

_HasAttachments :: Prism' AttachmentsStatus ()

threadVersion :: Lens' Thread Int

threadSubject :: Lens' Thread Text

threadStarred :: Lens' Thread StarStatus

threadSnippet :: Lens' Thread Text

threadParticipants :: Lens' Thread [Mailbox]

threadMessageIds :: Lens' Thread [NylasId]

threadLastTimestamp :: Lens' Thread MessageTime

threadLabels :: Lens' Thread (Maybe [Label])

threadId :: Lens' Thread NylasId

threadFolders :: Lens' Thread (Maybe [Folder])

threadFirstTimestamp :: Lens' Thread MessageTime

threadDraftIds :: Lens' Thread [NylasId]

threadAttachments :: Lens' Thread AttachmentsStatus

cursorId :: Iso' Cursor Text

_Delete :: forall a. Prism' (Change a) ()

_Modify :: forall a. Prism' (Change a) a

_Create :: forall a. Prism' (Change a) a

_FolderChange :: Prism' DeltaChange ()

_LabelChange :: Prism' DeltaChange ()

_ThreadChange :: Prism' DeltaChange (Change Thread)

_DraftChange :: Prism' DeltaChange ()

_MessageChange :: Prism' DeltaChange (Change Message)

_FileChange :: Prism' DeltaChange ()

_EventChange :: Prism' DeltaChange ()

_ContactChange :: Prism' DeltaChange ()

_CalendarChange :: Prism' DeltaChange ()

deltaObjectId :: Lens' Delta NylasId

deltaCursor :: Lens' Delta Cursor

deltaChange :: Lens' Delta DeltaChange

Utilities

recipients :: Message -> [Mailbox]

A list of the recipients of all types for a Message.