Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Network.Google.Gmail
Contents
- Service Configuration
- OAuth Scopes
- API Declaration
- Resources
- gmail.users.drafts.create
- gmail.users.drafts.delete
- gmail.users.drafts.get
- gmail.users.drafts.list
- gmail.users.drafts.send
- gmail.users.drafts.update
- gmail.users.getProfile
- gmail.users.history.list
- gmail.users.labels.create
- gmail.users.labels.delete
- gmail.users.labels.get
- gmail.users.labels.list
- gmail.users.labels.patch
- gmail.users.labels.update
- gmail.users.messages.attachments.get
- gmail.users.messages.batchDelete
- gmail.users.messages.batchModify
- gmail.users.messages.delete
- gmail.users.messages.get
- gmail.users.messages.import
- gmail.users.messages.insert
- gmail.users.messages.list
- gmail.users.messages.modify
- gmail.users.messages.send
- gmail.users.messages.trash
- gmail.users.messages.untrash
- gmail.users.settings.delegates.create
- gmail.users.settings.delegates.delete
- gmail.users.settings.delegates.get
- gmail.users.settings.delegates.list
- gmail.users.settings.filters.create
- gmail.users.settings.filters.delete
- gmail.users.settings.filters.get
- gmail.users.settings.filters.list
- gmail.users.settings.forwardingAddresses.create
- gmail.users.settings.forwardingAddresses.delete
- gmail.users.settings.forwardingAddresses.get
- gmail.users.settings.forwardingAddresses.list
- gmail.users.settings.getAutoForwarding
- gmail.users.settings.getImap
- gmail.users.settings.getPop
- gmail.users.settings.getVacation
- gmail.users.settings.sendAs.create
- gmail.users.settings.sendAs.delete
- gmail.users.settings.sendAs.get
- gmail.users.settings.sendAs.list
- gmail.users.settings.sendAs.patch
- gmail.users.settings.sendAs.smimeInfo.delete
- gmail.users.settings.sendAs.smimeInfo.get
- gmail.users.settings.sendAs.smimeInfo.insert
- gmail.users.settings.sendAs.smimeInfo.list
- gmail.users.settings.sendAs.smimeInfo.setDefault
- gmail.users.settings.sendAs.update
- gmail.users.settings.sendAs.verify
- gmail.users.settings.updateAutoForwarding
- gmail.users.settings.updateImap
- gmail.users.settings.updatePop
- gmail.users.settings.updateVacation
- gmail.users.stop
- gmail.users.threads.delete
- gmail.users.threads.get
- gmail.users.threads.list
- gmail.users.threads.modify
- gmail.users.threads.trash
- gmail.users.threads.untrash
- gmail.users.watch
- Types
- BatchDeleteMessagesRequest
- FilterCriteriaSizeComparison
- Delegate
- UsersMessagesGetFormat
- ModifyThreadRequest
- ListFiltersResponse
- ModifyMessageRequest
- ListForwardingAddressesResponse
- PopSettings
- PopSettingsAccessWindow
- History
- ListDelegatesResponse
- ForwardingAddressVerificationStatus
- LabelColor
- FilterCriteria
- ProFile
- AutoForwardingDisPosition
- MessagePartHeader
- UsersHistoryListHistoryTypes
- SendAsVerificationStatus
- ListHistoryResponse
- SendAs
- LabelType
- UsersDraftsGetFormat
- UsersMessagesImportInternalDateSource
- LabelMessageListVisibility
- ListThreadsResponse
- MessagePart
- HistoryLabelAdded
- ListLabelsResponse
- VacationSettings
- LabelLabelListVisibility
- HistoryMessageDeleted
- MessagePartBody
- AutoForwarding
- ListDraftsResponse
- ListSendAsResponse
- WatchResponse
- DelegateVerificationStatus
- UsersThreadsGetFormat
- BatchModifyMessagesRequest
- Draft
- SmtpMsa
- ForwardingAddress
- PopSettingsDisPosition
- Filter
- WatchRequest
- WatchRequestLabelFilterAction
- ImapSettings
- ImapSettingsExpungeBehavior
- ListSmimeInfoResponse
- SmtpMsaSecurityMode
- Message
- UsersMessagesInsertInternalDateSource
- HistoryLabelRemoved
- Thread
- FilterAction
- Label
- SmimeInfo
- ListMessagesResponse
- HistoryMessageAdded
Description
Access Gmail mailboxes including sending user email.
See: Gmail API Reference
Synopsis
- gmailService :: ServiceConfig
- gmailSettingsBasicScope :: Proxy '["https://www.googleapis.com/auth/gmail.settings.basic"]
- mailGoogleComScope :: Proxy '["https://mail.google.com/"]
- gmailModifyScope :: Proxy '["https://www.googleapis.com/auth/gmail.modify"]
- gmailMetadataScope :: Proxy '["https://www.googleapis.com/auth/gmail.metadata"]
- gmailLabelsScope :: Proxy '["https://www.googleapis.com/auth/gmail.labels"]
- gmailSettingsSharingScope :: Proxy '["https://www.googleapis.com/auth/gmail.settings.sharing"]
- gmailSendScope :: Proxy '["https://www.googleapis.com/auth/gmail.send"]
- gmailInsertScope :: Proxy '["https://www.googleapis.com/auth/gmail.insert"]
- gmailComposeScope :: Proxy '["https://www.googleapis.com/auth/gmail.compose"]
- gmailReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/gmail.readonly"]
- type GmailAPI = UsersHistoryListResource :<|> (UsersSettingsDelegatesListResource :<|> (UsersSettingsDelegatesGetResource :<|> (UsersSettingsDelegatesCreateResource :<|> (UsersSettingsDelegatesDeleteResource :<|> (UsersSettingsForwardingAddressesListResource :<|> (UsersSettingsForwardingAddressesGetResource :<|> (UsersSettingsForwardingAddressesCreateResource :<|> (UsersSettingsForwardingAddressesDeleteResource :<|> (UsersSettingsFiltersListResource :<|> (UsersSettingsFiltersGetResource :<|> (UsersSettingsFiltersCreateResource :<|> (UsersSettingsFiltersDeleteResource :<|> (UsersSettingsSendAsSmimeInfoInsertResource :<|> (UsersSettingsSendAsSmimeInfoListResource :<|> (UsersSettingsSendAsSmimeInfoGetResource :<|> (UsersSettingsSendAsSmimeInfoSetDefaultResource :<|> (UsersSettingsSendAsSmimeInfoDeleteResource :<|> (UsersSettingsSendAsVerifyResource :<|> (UsersSettingsSendAsListResource :<|> (UsersSettingsSendAsPatchResource :<|> (UsersSettingsSendAsGetResource :<|> (UsersSettingsSendAsCreateResource :<|> (UsersSettingsSendAsDeleteResource :<|> (UsersSettingsSendAsUpdateResource :<|> (UsersSettingsUpdateImapResource :<|> (UsersSettingsGetVacationResource :<|> (UsersSettingsGetAutoForwardingResource :<|> (UsersSettingsUpdateAutoForwardingResource :<|> (UsersSettingsUpdateVacationResource :<|> (UsersSettingsGetImapResource :<|> (UsersSettingsUpdatePopResource :<|> (UsersSettingsGetPopResource :<|> (UsersDraftsListResource :<|> (UsersDraftsGetResource :<|> (UsersDraftsCreateResource :<|> (UsersDraftsSendResource :<|> (UsersDraftsDeleteResource :<|> (UsersDraftsUpdateResource :<|> (UsersLabelsListResource :<|> (UsersLabelsPatchResource :<|> (UsersLabelsGetResource :<|> (UsersLabelsCreateResource :<|> (UsersLabelsDeleteResource :<|> (UsersLabelsUpdateResource :<|> (UsersThreadsListResource :<|> (UsersThreadsGetResource :<|> (UsersThreadsTrashResource :<|> (UsersThreadsUntrashResource :<|> (UsersThreadsModifyResource :<|> (UsersThreadsDeleteResource :<|> (UsersMessagesAttachmentsGetResource :<|> (UsersMessagesInsertResource :<|> (UsersMessagesListResource :<|> (UsersMessagesGetResource :<|> (UsersMessagesTrashResource :<|> (UsersMessagesSendResource :<|> (UsersMessagesBatchModifyResource :<|> (UsersMessagesUntrashResource :<|> (UsersMessagesImportResource :<|> (UsersMessagesBatchDeleteResource :<|> (UsersMessagesModifyResource :<|> (UsersMessagesDeleteResource :<|> (UsersGetProFileResource :<|> (UsersStopResource :<|> UsersWatchResource))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))
- module Network.Google.Resource.Gmail.Users.Drafts.Create
- module Network.Google.Resource.Gmail.Users.Drafts.Delete
- module Network.Google.Resource.Gmail.Users.Drafts.Get
- module Network.Google.Resource.Gmail.Users.Drafts.List
- module Network.Google.Resource.Gmail.Users.Drafts.Send
- module Network.Google.Resource.Gmail.Users.Drafts.Update
- module Network.Google.Resource.Gmail.Users.GetProFile
- module Network.Google.Resource.Gmail.Users.History.List
- module Network.Google.Resource.Gmail.Users.Labels.Create
- module Network.Google.Resource.Gmail.Users.Labels.Delete
- module Network.Google.Resource.Gmail.Users.Labels.Get
- module Network.Google.Resource.Gmail.Users.Labels.List
- module Network.Google.Resource.Gmail.Users.Labels.Patch
- module Network.Google.Resource.Gmail.Users.Labels.Update
- module Network.Google.Resource.Gmail.Users.Messages.Attachments.Get
- module Network.Google.Resource.Gmail.Users.Messages.BatchDelete
- module Network.Google.Resource.Gmail.Users.Messages.BatchModify
- module Network.Google.Resource.Gmail.Users.Messages.Delete
- module Network.Google.Resource.Gmail.Users.Messages.Get
- module Network.Google.Resource.Gmail.Users.Messages.Import
- module Network.Google.Resource.Gmail.Users.Messages.Insert
- module Network.Google.Resource.Gmail.Users.Messages.List
- module Network.Google.Resource.Gmail.Users.Messages.Modify
- module Network.Google.Resource.Gmail.Users.Messages.Send
- module Network.Google.Resource.Gmail.Users.Messages.Trash
- module Network.Google.Resource.Gmail.Users.Messages.Untrash
- module Network.Google.Resource.Gmail.Users.Settings.Delegates.Create
- module Network.Google.Resource.Gmail.Users.Settings.Delegates.Delete
- module Network.Google.Resource.Gmail.Users.Settings.Delegates.Get
- module Network.Google.Resource.Gmail.Users.Settings.Delegates.List
- module Network.Google.Resource.Gmail.Users.Settings.Filters.Create
- module Network.Google.Resource.Gmail.Users.Settings.Filters.Delete
- module Network.Google.Resource.Gmail.Users.Settings.Filters.Get
- module Network.Google.Resource.Gmail.Users.Settings.Filters.List
- module Network.Google.Resource.Gmail.Users.Settings.ForwardingAddresses.Create
- module Network.Google.Resource.Gmail.Users.Settings.ForwardingAddresses.Delete
- module Network.Google.Resource.Gmail.Users.Settings.ForwardingAddresses.Get
- module Network.Google.Resource.Gmail.Users.Settings.ForwardingAddresses.List
- module Network.Google.Resource.Gmail.Users.Settings.GetAutoForwarding
- module Network.Google.Resource.Gmail.Users.Settings.GetImap
- module Network.Google.Resource.Gmail.Users.Settings.GetPop
- module Network.Google.Resource.Gmail.Users.Settings.GetVacation
- module Network.Google.Resource.Gmail.Users.Settings.SendAs.Create
- module Network.Google.Resource.Gmail.Users.Settings.SendAs.Delete
- module Network.Google.Resource.Gmail.Users.Settings.SendAs.Get
- module Network.Google.Resource.Gmail.Users.Settings.SendAs.List
- module Network.Google.Resource.Gmail.Users.Settings.SendAs.Patch
- module Network.Google.Resource.Gmail.Users.Settings.SendAs.SmimeInfo.Delete
- module Network.Google.Resource.Gmail.Users.Settings.SendAs.SmimeInfo.Get
- module Network.Google.Resource.Gmail.Users.Settings.SendAs.SmimeInfo.Insert
- module Network.Google.Resource.Gmail.Users.Settings.SendAs.SmimeInfo.List
- module Network.Google.Resource.Gmail.Users.Settings.SendAs.SmimeInfo.SetDefault
- module Network.Google.Resource.Gmail.Users.Settings.SendAs.Update
- module Network.Google.Resource.Gmail.Users.Settings.SendAs.Verify
- module Network.Google.Resource.Gmail.Users.Settings.UpdateAutoForwarding
- module Network.Google.Resource.Gmail.Users.Settings.UpdateImap
- module Network.Google.Resource.Gmail.Users.Settings.UpdatePop
- module Network.Google.Resource.Gmail.Users.Settings.UpdateVacation
- module Network.Google.Resource.Gmail.Users.Stop
- module Network.Google.Resource.Gmail.Users.Threads.Delete
- module Network.Google.Resource.Gmail.Users.Threads.Get
- module Network.Google.Resource.Gmail.Users.Threads.List
- module Network.Google.Resource.Gmail.Users.Threads.Modify
- module Network.Google.Resource.Gmail.Users.Threads.Trash
- module Network.Google.Resource.Gmail.Users.Threads.Untrash
- module Network.Google.Resource.Gmail.Users.Watch
- data BatchDeleteMessagesRequest
- batchDeleteMessagesRequest :: BatchDeleteMessagesRequest
- bdmrIds :: Lens' BatchDeleteMessagesRequest [Text]
- data FilterCriteriaSizeComparison
- = Larger
- | Smaller
- | Unspecified
- data Delegate
- delegate :: Delegate
- dVerificationStatus :: Lens' Delegate (Maybe DelegateVerificationStatus)
- dDelegateEmail :: Lens' Delegate (Maybe Text)
- data UsersMessagesGetFormat
- data ModifyThreadRequest
- modifyThreadRequest :: ModifyThreadRequest
- mtrRemoveLabelIds :: Lens' ModifyThreadRequest [Text]
- mtrAddLabelIds :: Lens' ModifyThreadRequest [Text]
- data ListFiltersResponse
- listFiltersResponse :: ListFiltersResponse
- lfrFilter :: Lens' ListFiltersResponse [Filter]
- data ModifyMessageRequest
- modifyMessageRequest :: ModifyMessageRequest
- mmrRemoveLabelIds :: Lens' ModifyMessageRequest [Text]
- mmrAddLabelIds :: Lens' ModifyMessageRequest [Text]
- data ListForwardingAddressesResponse
- listForwardingAddressesResponse :: ListForwardingAddressesResponse
- lfarForwardingAddresses :: Lens' ListForwardingAddressesResponse [ForwardingAddress]
- data PopSettings
- popSettings :: PopSettings
- psAccessWindow :: Lens' PopSettings (Maybe PopSettingsAccessWindow)
- psDisPosition :: Lens' PopSettings (Maybe PopSettingsDisPosition)
- data PopSettingsAccessWindow
- data History
- history :: History
- hLabelsRemoved :: Lens' History [HistoryLabelRemoved]
- hMessagesDeleted :: Lens' History [HistoryMessageDeleted]
- hMessagesAdded :: Lens' History [HistoryMessageAdded]
- hLabelsAdded :: Lens' History [HistoryLabelAdded]
- hId :: Lens' History (Maybe Word64)
- hMessages :: Lens' History [Message]
- data ListDelegatesResponse
- listDelegatesResponse :: ListDelegatesResponse
- ldrDelegates :: Lens' ListDelegatesResponse [Delegate]
- data ForwardingAddressVerificationStatus
- data LabelColor
- labelColor :: LabelColor
- lcBackgRoundColor :: Lens' LabelColor (Maybe Text)
- lcTextColor :: Lens' LabelColor (Maybe Text)
- data FilterCriteria
- filterCriteria :: FilterCriteria
- fcSizeComparison :: Lens' FilterCriteria (Maybe FilterCriteriaSizeComparison)
- fcSubject :: Lens' FilterCriteria (Maybe Text)
- fcSize :: Lens' FilterCriteria (Maybe Int32)
- fcExcludeChats :: Lens' FilterCriteria (Maybe Bool)
- fcTo :: Lens' FilterCriteria (Maybe Text)
- fcFrom :: Lens' FilterCriteria (Maybe Text)
- fcQuery :: Lens' FilterCriteria (Maybe Text)
- fcNegatedQuery :: Lens' FilterCriteria (Maybe Text)
- fcHasAttachment :: Lens' FilterCriteria (Maybe Bool)
- data ProFile
- proFile :: ProFile
- pfMessagesTotal :: Lens' ProFile (Maybe Int32)
- pfThreadsTotal :: Lens' ProFile (Maybe Int32)
- pfHistoryId :: Lens' ProFile (Maybe Word64)
- pfEmailAddress :: Lens' ProFile (Maybe Text)
- data AutoForwardingDisPosition
- data MessagePartHeader
- messagePartHeader :: MessagePartHeader
- mphValue :: Lens' MessagePartHeader (Maybe Text)
- mphName :: Lens' MessagePartHeader (Maybe Text)
- data UsersHistoryListHistoryTypes
- data SendAsVerificationStatus
- data ListHistoryResponse
- listHistoryResponse :: ListHistoryResponse
- lhrNextPageToken :: Lens' ListHistoryResponse (Maybe Text)
- lhrHistory :: Lens' ListHistoryResponse [History]
- lhrHistoryId :: Lens' ListHistoryResponse (Maybe Word64)
- data SendAs
- sendAs :: SendAs
- saSignature :: Lens' SendAs (Maybe Text)
- saReplyToAddress :: Lens' SendAs (Maybe Text)
- saTreatAsAlias :: Lens' SendAs (Maybe Bool)
- saSendAsEmail :: Lens' SendAs (Maybe Text)
- saDisplayName :: Lens' SendAs (Maybe Text)
- saVerificationStatus :: Lens' SendAs (Maybe SendAsVerificationStatus)
- saSmtpMsa :: Lens' SendAs (Maybe SmtpMsa)
- saIsPrimary :: Lens' SendAs (Maybe Bool)
- saIsDefault :: Lens' SendAs (Maybe Bool)
- data LabelType
- data UsersDraftsGetFormat
- data UsersMessagesImportInternalDateSource
- data LabelMessageListVisibility
- data ListThreadsResponse
- listThreadsResponse :: ListThreadsResponse
- ltrNextPageToken :: Lens' ListThreadsResponse (Maybe Text)
- ltrResultSizeEstimate :: Lens' ListThreadsResponse (Maybe Word32)
- ltrThreads :: Lens' ListThreadsResponse [Thread]
- data MessagePart
- messagePart :: MessagePart
- mpParts :: Lens' MessagePart [MessagePart]
- mpBody :: Lens' MessagePart (Maybe MessagePartBody)
- mpMimeType :: Lens' MessagePart (Maybe Text)
- mpHeaders :: Lens' MessagePart [MessagePartHeader]
- mpPartId :: Lens' MessagePart (Maybe Text)
- mpFilename :: Lens' MessagePart (Maybe Text)
- data HistoryLabelAdded
- historyLabelAdded :: HistoryLabelAdded
- hlaLabelIds :: Lens' HistoryLabelAdded [Text]
- hlaMessage :: Lens' HistoryLabelAdded (Maybe Message)
- data ListLabelsResponse
- listLabelsResponse :: ListLabelsResponse
- llrLabels :: Lens' ListLabelsResponse [Label]
- data VacationSettings
- vacationSettings :: VacationSettings
- vsEnableAutoReply :: Lens' VacationSettings (Maybe Bool)
- vsResponseBodyPlainText :: Lens' VacationSettings (Maybe Text)
- vsRestrictToDomain :: Lens' VacationSettings (Maybe Bool)
- vsStartTime :: Lens' VacationSettings (Maybe Int64)
- vsResponseBodyHTML :: Lens' VacationSettings (Maybe Text)
- vsRestrictToContacts :: Lens' VacationSettings (Maybe Bool)
- vsResponseSubject :: Lens' VacationSettings (Maybe Text)
- vsEndTime :: Lens' VacationSettings (Maybe Int64)
- data LabelLabelListVisibility
- data HistoryMessageDeleted
- historyMessageDeleted :: HistoryMessageDeleted
- hmdMessage :: Lens' HistoryMessageDeleted (Maybe Message)
- data MessagePartBody
- messagePartBody :: MessagePartBody
- mpbSize :: Lens' MessagePartBody (Maybe Int32)
- mpbData :: Lens' MessagePartBody (Maybe ByteString)
- mpbAttachmentId :: Lens' MessagePartBody (Maybe Text)
- data AutoForwarding
- autoForwarding :: AutoForwarding
- afEnabled :: Lens' AutoForwarding (Maybe Bool)
- afDisPosition :: Lens' AutoForwarding (Maybe AutoForwardingDisPosition)
- afEmailAddress :: Lens' AutoForwarding (Maybe Text)
- data ListDraftsResponse
- listDraftsResponse :: ListDraftsResponse
- ldrNextPageToken :: Lens' ListDraftsResponse (Maybe Text)
- ldrResultSizeEstimate :: Lens' ListDraftsResponse (Maybe Word32)
- ldrDrafts :: Lens' ListDraftsResponse [Draft]
- data ListSendAsResponse
- listSendAsResponse :: ListSendAsResponse
- lsarSendAs :: Lens' ListSendAsResponse [SendAs]
- data WatchResponse
- watchResponse :: WatchResponse
- wrExpiration :: Lens' WatchResponse (Maybe Int64)
- wrHistoryId :: Lens' WatchResponse (Maybe Word64)
- data DelegateVerificationStatus
- data UsersThreadsGetFormat
- data BatchModifyMessagesRequest
- batchModifyMessagesRequest :: BatchModifyMessagesRequest
- bmmrIds :: Lens' BatchModifyMessagesRequest [Text]
- bmmrRemoveLabelIds :: Lens' BatchModifyMessagesRequest [Text]
- bmmrAddLabelIds :: Lens' BatchModifyMessagesRequest [Text]
- data Draft
- draft :: Draft
- dId :: Lens' Draft (Maybe Text)
- dMessage :: Lens' Draft (Maybe Message)
- data SmtpMsa
- smtpMsa :: SmtpMsa
- smSecurityMode :: Lens' SmtpMsa (Maybe SmtpMsaSecurityMode)
- smUsername :: Lens' SmtpMsa (Maybe Text)
- smPassword :: Lens' SmtpMsa (Maybe Text)
- smHost :: Lens' SmtpMsa (Maybe Text)
- smPort :: Lens' SmtpMsa (Maybe Int32)
- data ForwardingAddress
- forwardingAddress :: ForwardingAddress
- faForwardingEmail :: Lens' ForwardingAddress (Maybe Text)
- faVerificationStatus :: Lens' ForwardingAddress (Maybe ForwardingAddressVerificationStatus)
- data PopSettingsDisPosition
- data Filter
- filter' :: Filter
- fAction :: Lens' Filter (Maybe FilterAction)
- fId :: Lens' Filter (Maybe Text)
- fCriteria :: Lens' Filter (Maybe FilterCriteria)
- data WatchRequest
- watchRequest :: WatchRequest
- wrLabelFilterAction :: Lens' WatchRequest (Maybe WatchRequestLabelFilterAction)
- wrTopicName :: Lens' WatchRequest (Maybe Text)
- wrLabelIds :: Lens' WatchRequest [Text]
- data WatchRequestLabelFilterAction
- data ImapSettings
- imapSettings :: ImapSettings
- isEnabled :: Lens' ImapSettings (Maybe Bool)
- isExpungeBehavior :: Lens' ImapSettings (Maybe ImapSettingsExpungeBehavior)
- isAutoExpunge :: Lens' ImapSettings (Maybe Bool)
- isMaxFolderSize :: Lens' ImapSettings (Maybe Int32)
- data ImapSettingsExpungeBehavior
- data ListSmimeInfoResponse
- listSmimeInfoResponse :: ListSmimeInfoResponse
- lsirSmimeInfo :: Lens' ListSmimeInfoResponse [SmimeInfo]
- data SmtpMsaSecurityMode
- data Message
- message :: Message
- mRaw :: Lens' Message (Maybe ByteString)
- mSnippet :: Lens' Message (Maybe Text)
- mSizeEstimate :: Lens' Message (Maybe Int32)
- mPayload :: Lens' Message (Maybe MessagePart)
- mHistoryId :: Lens' Message (Maybe Word64)
- mId :: Lens' Message (Maybe Text)
- mLabelIds :: Lens' Message [Text]
- mThreadId :: Lens' Message (Maybe Text)
- mInternalDate :: Lens' Message (Maybe Int64)
- data UsersMessagesInsertInternalDateSource
- data HistoryLabelRemoved
- historyLabelRemoved :: HistoryLabelRemoved
- hlrLabelIds :: Lens' HistoryLabelRemoved [Text]
- hlrMessage :: Lens' HistoryLabelRemoved (Maybe Message)
- data Thread
- thread :: Thread
- tSnippet :: Lens' Thread (Maybe Text)
- tHistoryId :: Lens' Thread (Maybe Word64)
- tId :: Lens' Thread (Maybe Text)
- tMessages :: Lens' Thread [Message]
- data FilterAction
- filterAction :: FilterAction
- faForward :: Lens' FilterAction (Maybe Text)
- faRemoveLabelIds :: Lens' FilterAction [Text]
- faAddLabelIds :: Lens' FilterAction [Text]
- data Label
- label :: Label
- lThreadsUnread :: Lens' Label (Maybe Int32)
- lMessageListVisibility :: Lens' Label (Maybe LabelMessageListVisibility)
- lMessagesTotal :: Lens' Label (Maybe Int32)
- lColor :: Lens' Label (Maybe LabelColor)
- lMessagesUnread :: Lens' Label (Maybe Int32)
- lName :: Lens' Label (Maybe Text)
- lThreadsTotal :: Lens' Label (Maybe Int32)
- lLabelListVisibility :: Lens' Label (Maybe LabelLabelListVisibility)
- lId :: Lens' Label (Maybe Text)
- lType :: Lens' Label (Maybe LabelType)
- data SmimeInfo
- smimeInfo :: SmimeInfo
- siPem :: Lens' SmimeInfo (Maybe Text)
- siExpiration :: Lens' SmimeInfo (Maybe Int64)
- siEncryptedKeyPassword :: Lens' SmimeInfo (Maybe Text)
- siId :: Lens' SmimeInfo (Maybe Text)
- siPkcs12 :: Lens' SmimeInfo (Maybe ByteString)
- siIssuerCn :: Lens' SmimeInfo (Maybe Text)
- siIsDefault :: Lens' SmimeInfo (Maybe Bool)
- data ListMessagesResponse
- listMessagesResponse :: ListMessagesResponse
- lmrNextPageToken :: Lens' ListMessagesResponse (Maybe Text)
- lmrResultSizeEstimate :: Lens' ListMessagesResponse (Maybe Word32)
- lmrMessages :: Lens' ListMessagesResponse [Message]
- data HistoryMessageAdded
- historyMessageAdded :: HistoryMessageAdded
- hmaMessage :: Lens' HistoryMessageAdded (Maybe Message)
Service Configuration
gmailService :: ServiceConfig Source #
Default request referring to version v1
of the Gmail API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
gmailSettingsBasicScope :: Proxy '["https://www.googleapis.com/auth/gmail.settings.basic"] Source #
Manage your basic mail settings
mailGoogleComScope :: Proxy '["https://mail.google.com/"] Source #
Read, compose, send, and permanently delete all your email from Gmail
gmailModifyScope :: Proxy '["https://www.googleapis.com/auth/gmail.modify"] Source #
View and modify but not delete your email
gmailMetadataScope :: Proxy '["https://www.googleapis.com/auth/gmail.metadata"] Source #
View your email message metadata such as labels and headers, but not the email body
gmailLabelsScope :: Proxy '["https://www.googleapis.com/auth/gmail.labels"] Source #
Manage mailbox labels
gmailSettingsSharingScope :: Proxy '["https://www.googleapis.com/auth/gmail.settings.sharing"] Source #
Manage your sensitive mail settings, including who can manage your mail
gmailSendScope :: Proxy '["https://www.googleapis.com/auth/gmail.send"] Source #
Send email on your behalf
gmailInsertScope :: Proxy '["https://www.googleapis.com/auth/gmail.insert"] Source #
Insert mail into your mailbox
gmailComposeScope :: Proxy '["https://www.googleapis.com/auth/gmail.compose"] Source #
Manage drafts and send emails
gmailReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/gmail.readonly"] Source #
View your email messages and settings
API Declaration
type GmailAPI = UsersHistoryListResource :<|> (UsersSettingsDelegatesListResource :<|> (UsersSettingsDelegatesGetResource :<|> (UsersSettingsDelegatesCreateResource :<|> (UsersSettingsDelegatesDeleteResource :<|> (UsersSettingsForwardingAddressesListResource :<|> (UsersSettingsForwardingAddressesGetResource :<|> (UsersSettingsForwardingAddressesCreateResource :<|> (UsersSettingsForwardingAddressesDeleteResource :<|> (UsersSettingsFiltersListResource :<|> (UsersSettingsFiltersGetResource :<|> (UsersSettingsFiltersCreateResource :<|> (UsersSettingsFiltersDeleteResource :<|> (UsersSettingsSendAsSmimeInfoInsertResource :<|> (UsersSettingsSendAsSmimeInfoListResource :<|> (UsersSettingsSendAsSmimeInfoGetResource :<|> (UsersSettingsSendAsSmimeInfoSetDefaultResource :<|> (UsersSettingsSendAsSmimeInfoDeleteResource :<|> (UsersSettingsSendAsVerifyResource :<|> (UsersSettingsSendAsListResource :<|> (UsersSettingsSendAsPatchResource :<|> (UsersSettingsSendAsGetResource :<|> (UsersSettingsSendAsCreateResource :<|> (UsersSettingsSendAsDeleteResource :<|> (UsersSettingsSendAsUpdateResource :<|> (UsersSettingsUpdateImapResource :<|> (UsersSettingsGetVacationResource :<|> (UsersSettingsGetAutoForwardingResource :<|> (UsersSettingsUpdateAutoForwardingResource :<|> (UsersSettingsUpdateVacationResource :<|> (UsersSettingsGetImapResource :<|> (UsersSettingsUpdatePopResource :<|> (UsersSettingsGetPopResource :<|> (UsersDraftsListResource :<|> (UsersDraftsGetResource :<|> (UsersDraftsCreateResource :<|> (UsersDraftsSendResource :<|> (UsersDraftsDeleteResource :<|> (UsersDraftsUpdateResource :<|> (UsersLabelsListResource :<|> (UsersLabelsPatchResource :<|> (UsersLabelsGetResource :<|> (UsersLabelsCreateResource :<|> (UsersLabelsDeleteResource :<|> (UsersLabelsUpdateResource :<|> (UsersThreadsListResource :<|> (UsersThreadsGetResource :<|> (UsersThreadsTrashResource :<|> (UsersThreadsUntrashResource :<|> (UsersThreadsModifyResource :<|> (UsersThreadsDeleteResource :<|> (UsersMessagesAttachmentsGetResource :<|> (UsersMessagesInsertResource :<|> (UsersMessagesListResource :<|> (UsersMessagesGetResource :<|> (UsersMessagesTrashResource :<|> (UsersMessagesSendResource :<|> (UsersMessagesBatchModifyResource :<|> (UsersMessagesUntrashResource :<|> (UsersMessagesImportResource :<|> (UsersMessagesBatchDeleteResource :<|> (UsersMessagesModifyResource :<|> (UsersMessagesDeleteResource :<|> (UsersGetProFileResource :<|> (UsersStopResource :<|> UsersWatchResource)))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))) Source #
Represents the entirety of the methods and resources available for the Gmail API service.
Resources
gmail.users.drafts.create
gmail.users.drafts.delete
gmail.users.drafts.get
gmail.users.drafts.list
gmail.users.drafts.send
gmail.users.drafts.update
gmail.users.getProfile
gmail.users.history.list
gmail.users.labels.create
gmail.users.labels.delete
gmail.users.labels.get
gmail.users.labels.list
gmail.users.labels.patch
gmail.users.labels.update
gmail.users.messages.attachments.get
gmail.users.messages.batchDelete
gmail.users.messages.batchModify
gmail.users.messages.delete
gmail.users.messages.get
gmail.users.messages.import
gmail.users.messages.insert
gmail.users.messages.list
gmail.users.messages.modify
gmail.users.messages.send
gmail.users.messages.trash
gmail.users.messages.untrash
gmail.users.settings.delegates.create
gmail.users.settings.delegates.delete
gmail.users.settings.delegates.get
gmail.users.settings.delegates.list
gmail.users.settings.filters.create
gmail.users.settings.filters.delete
gmail.users.settings.filters.get
gmail.users.settings.filters.list
gmail.users.settings.forwardingAddresses.create
gmail.users.settings.forwardingAddresses.delete
gmail.users.settings.forwardingAddresses.get
gmail.users.settings.forwardingAddresses.list
gmail.users.settings.getAutoForwarding
gmail.users.settings.getImap
gmail.users.settings.getPop
gmail.users.settings.getVacation
gmail.users.settings.sendAs.create
gmail.users.settings.sendAs.delete
gmail.users.settings.sendAs.get
gmail.users.settings.sendAs.list
gmail.users.settings.sendAs.patch
gmail.users.settings.sendAs.smimeInfo.delete
gmail.users.settings.sendAs.smimeInfo.get
gmail.users.settings.sendAs.smimeInfo.insert
gmail.users.settings.sendAs.smimeInfo.list
gmail.users.settings.sendAs.smimeInfo.setDefault
gmail.users.settings.sendAs.update
gmail.users.settings.sendAs.verify
gmail.users.settings.updateAutoForwarding
gmail.users.settings.updateImap
gmail.users.settings.updatePop
gmail.users.settings.updateVacation
gmail.users.stop
gmail.users.threads.delete
gmail.users.threads.get
gmail.users.threads.list
gmail.users.threads.modify
gmail.users.threads.trash
gmail.users.threads.untrash
gmail.users.watch
Types
BatchDeleteMessagesRequest
data BatchDeleteMessagesRequest Source #
Instances
batchDeleteMessagesRequest :: BatchDeleteMessagesRequest Source #
Creates a value of BatchDeleteMessagesRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
FilterCriteriaSizeComparison
data FilterCriteriaSizeComparison Source #
How the message size in bytes should be in relation to the size field.
Constructors
Larger | larger |
Smaller | smaller |
Unspecified | unspecified |
Instances
Delegate
Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator's account. See "Set up mail delegation" for more information about delegates.
See: delegate
smart constructor.
Instances
Eq Delegate Source # | |
Data Delegate Source # | |
Defined in Network.Google.Gmail.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Delegate -> c Delegate # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Delegate # toConstr :: Delegate -> Constr # dataTypeOf :: Delegate -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Delegate) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Delegate) # gmapT :: (forall b. Data b => b -> b) -> Delegate -> Delegate # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Delegate -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Delegate -> r # gmapQ :: (forall d. Data d => d -> u) -> Delegate -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Delegate -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Delegate -> m Delegate # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Delegate -> m Delegate # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Delegate -> m Delegate # | |
Show Delegate Source # | |
Generic Delegate Source # | |
ToJSON Delegate Source # | |
Defined in Network.Google.Gmail.Types.Product | |
FromJSON Delegate Source # | |
type Rep Delegate Source # | |
Defined in Network.Google.Gmail.Types.Product type Rep Delegate = D1 (MetaData "Delegate" "Network.Google.Gmail.Types.Product" "gogol-gmail-0.4.0-EDJmLuxza63I9QV4rXNgT4" False) (C1 (MetaCons "Delegate'" PrefixI True) (S1 (MetaSel (Just "_dVerificationStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DelegateVerificationStatus)) :*: S1 (MetaSel (Just "_dDelegateEmail") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) |
Creates a value of Delegate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dVerificationStatus :: Lens' Delegate (Maybe DelegateVerificationStatus) Source #
Indicates whether this address has been verified and can act as a delegate for the account. Read-only.
UsersMessagesGetFormat
data UsersMessagesGetFormat Source #
The format to return the message in.
Instances
ModifyThreadRequest
data ModifyThreadRequest Source #
Instances
modifyThreadRequest :: ModifyThreadRequest Source #
Creates a value of ModifyThreadRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mtrRemoveLabelIds :: Lens' ModifyThreadRequest [Text] Source #
A list of IDs of labels to remove from this thread.
mtrAddLabelIds :: Lens' ModifyThreadRequest [Text] Source #
A list of IDs of labels to add to this thread.
ListFiltersResponse
data ListFiltersResponse Source #
Response for the ListFilters method.
See: listFiltersResponse
smart constructor.
Instances
listFiltersResponse :: ListFiltersResponse Source #
Creates a value of ListFiltersResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ModifyMessageRequest
data ModifyMessageRequest Source #
Instances
modifyMessageRequest :: ModifyMessageRequest Source #
Creates a value of ModifyMessageRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mmrRemoveLabelIds :: Lens' ModifyMessageRequest [Text] Source #
A list IDs of labels to remove from this message.
mmrAddLabelIds :: Lens' ModifyMessageRequest [Text] Source #
A list of IDs of labels to add to this message.
ListForwardingAddressesResponse
data ListForwardingAddressesResponse Source #
Response for the ListForwardingAddresses method.
See: listForwardingAddressesResponse
smart constructor.
Instances
listForwardingAddressesResponse :: ListForwardingAddressesResponse Source #
Creates a value of ListForwardingAddressesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lfarForwardingAddresses :: Lens' ListForwardingAddressesResponse [ForwardingAddress] Source #
List of addresses that may be used for forwarding.
PopSettings
data PopSettings Source #
POP settings for an account.
See: popSettings
smart constructor.
Instances
popSettings :: PopSettings Source #
Creates a value of PopSettings
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
psAccessWindow :: Lens' PopSettings (Maybe PopSettingsAccessWindow) Source #
The range of messages which are accessible via POP.
psDisPosition :: Lens' PopSettings (Maybe PopSettingsDisPosition) Source #
The action that will be executed on a message after it has been fetched via POP.
PopSettingsAccessWindow
data PopSettingsAccessWindow Source #
The range of messages which are accessible via POP.
Constructors
AccessWindowUnspecified | accessWindowUnspecified |
AllMail | allMail |
Disabled | disabled |
FromNowOn | fromNowOn |
Instances
History
A record of a change to the user's mailbox. Each history change may affect multiple messages in multiple ways.
See: history
smart constructor.
Instances
Creates a value of History
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
hLabelsRemoved :: Lens' History [HistoryLabelRemoved] Source #
Labels removed from messages in this history record.
hMessagesDeleted :: Lens' History [HistoryMessageDeleted] Source #
Messages deleted (not Trashed) from the mailbox in this history record.
hMessagesAdded :: Lens' History [HistoryMessageAdded] Source #
Messages added to the mailbox in this history record.
hLabelsAdded :: Lens' History [HistoryLabelAdded] Source #
Labels added to messages in this history record.
hMessages :: Lens' History [Message] Source #
List of messages changed in this history record. The fields for specific change types, such as messagesAdded may duplicate messages in this field. We recommend using the specific change-type fields instead of this.
ListDelegatesResponse
data ListDelegatesResponse Source #
Response for the ListDelegates method.
See: listDelegatesResponse
smart constructor.
Instances
listDelegatesResponse :: ListDelegatesResponse Source #
Creates a value of ListDelegatesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ldrDelegates :: Lens' ListDelegatesResponse [Delegate] Source #
List of the user's delegates (with any verification status).
ForwardingAddressVerificationStatus
data ForwardingAddressVerificationStatus Source #
Indicates whether this address has been verified and is usable for forwarding. Read-only.
Constructors
Accepted | accepted |
Pending | pending |
VerificationStatusUnspecified | verificationStatusUnspecified |
Instances
LabelColor
data LabelColor Source #
Instances
labelColor :: LabelColor Source #
Creates a value of LabelColor
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lcBackgRoundColor :: Lens' LabelColor (Maybe Text) Source #
The background color represented as hex string 000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: 434343, 999999, efefef, ffffff, ffad47, 16a766, 4a86e8, f691b3, ffe6c7, b9e4d0, c9daf8, fcdee8, ffd6a2, 89d3b2, a4c2f4, fbc8d9, ffbc6b, 44b984, 6d9eeb, f7a7c0, eaa041, 149e60, 3c78d8, e07798, cf8933, 0b804b, 285bac, b65775, a46a21, 076239, 1c4587, 83334c
lcTextColor :: Lens' LabelColor (Maybe Text) Source #
The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: 434343, #666666, cccccc, f3f3f3, fb4c2f, fad165, 43d692, a479e2, f6c5be, fef1d1, c6f3de, e4d7f5, efa093, fce8b3, a0eac9, d0bcf1, e66550, fcda83, 68dfa9, b694e8, cc3a21, f2c960, 3dc789, 8e63ce, ac2b16, d5ae49, 2a9c68, 653e9b, 822111, aa8831, 1a764d, 41236d, #83334c
FilterCriteria
data FilterCriteria Source #
Message matching criteria.
See: filterCriteria
smart constructor.
Instances
filterCriteria :: FilterCriteria Source #
Creates a value of FilterCriteria
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fcSizeComparison :: Lens' FilterCriteria (Maybe FilterCriteriaSizeComparison) Source #
How the message size in bytes should be in relation to the size field.
fcSubject :: Lens' FilterCriteria (Maybe Text) Source #
Case-insensitive phrase found in the message's subject. Trailing and leading whitespace are be trimmed and adjacent spaces are collapsed.
fcSize :: Lens' FilterCriteria (Maybe Int32) Source #
The size of the entire RFC822 message in bytes, including all headers and attachments.
fcExcludeChats :: Lens' FilterCriteria (Maybe Bool) Source #
Whether the response should exclude chats.
fcTo :: Lens' FilterCriteria (Maybe Text) Source #
The recipient's display name or email address. Includes recipients in the "to", "cc", and "bcc" header fields. You can use simply the local part of the email address. For example, "example" and "example'" both match "example'gmail.com". This field is case-insensitive.
fcQuery :: Lens' FilterCriteria (Maybe Text) Source #
Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser'example.com rfc822msgid: is:unread".
fcNegatedQuery :: Lens' FilterCriteria (Maybe Text) Source #
Only return messages not matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser'example.com rfc822msgid: is:unread".
fcHasAttachment :: Lens' FilterCriteria (Maybe Bool) Source #
Whether the message has any attachment.
ProFile
Profile for a Gmail user.
See: proFile
smart constructor.
Instances
Eq ProFile Source # | |
Data ProFile Source # | |
Defined in Network.Google.Gmail.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProFile -> c ProFile # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProFile # toConstr :: ProFile -> Constr # dataTypeOf :: ProFile -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProFile) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProFile) # gmapT :: (forall b. Data b => b -> b) -> ProFile -> ProFile # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProFile -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProFile -> r # gmapQ :: (forall d. Data d => d -> u) -> ProFile -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ProFile -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProFile -> m ProFile # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProFile -> m ProFile # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProFile -> m ProFile # | |
Show ProFile Source # | |
Generic ProFile Source # | |
ToJSON ProFile Source # | |
Defined in Network.Google.Gmail.Types.Product | |
FromJSON ProFile Source # | |
type Rep ProFile Source # | |
Defined in Network.Google.Gmail.Types.Product type Rep ProFile = D1 (MetaData "ProFile" "Network.Google.Gmail.Types.Product" "gogol-gmail-0.4.0-EDJmLuxza63I9QV4rXNgT4" False) (C1 (MetaCons "ProFile'" PrefixI True) ((S1 (MetaSel (Just "_pfMessagesTotal") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_pfThreadsTotal") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))) :*: (S1 (MetaSel (Just "_pfHistoryId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word64))) :*: S1 (MetaSel (Just "_pfEmailAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) |
Creates a value of ProFile
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
AutoForwardingDisPosition
data AutoForwardingDisPosition Source #
The state that a message should be left in after it has been forwarded.
Constructors
Archive | archive |
DisPositionUnspecified | dispositionUnspecified |
LeaveInInbox | leaveInInbox |
MarkRead | markRead |
Trash | trash |
Instances
MessagePartHeader
data MessagePartHeader Source #
Instances
messagePartHeader :: MessagePartHeader Source #
Creates a value of MessagePartHeader
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mphValue :: Lens' MessagePartHeader (Maybe Text) Source #
The value of the header after the : separator. For example, someuser'example.com.
mphName :: Lens' MessagePartHeader (Maybe Text) Source #
The name of the header before the : separator. For example, To.
UsersHistoryListHistoryTypes
data UsersHistoryListHistoryTypes Source #
History types to be returned by the function
Constructors
LabelAdded | labelAdded |
LabelRemoved | labelRemoved |
MessageAdded | messageAdded |
MessageDeleted | messageDeleted |
Instances
SendAsVerificationStatus
data SendAsVerificationStatus Source #
Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
Constructors
SAVSAccepted | accepted |
SAVSPending | pending |
SAVSVerificationStatusUnspecified | verificationStatusUnspecified |
Instances
ListHistoryResponse
data ListHistoryResponse Source #
Instances
listHistoryResponse :: ListHistoryResponse Source #
Creates a value of ListHistoryResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lhrNextPageToken :: Lens' ListHistoryResponse (Maybe Text) Source #
Page token to retrieve the next page of results in the list.
lhrHistory :: Lens' ListHistoryResponse [History] Source #
List of history records. Any messages contained in the response will typically only have id and threadId fields populated.
lhrHistoryId :: Lens' ListHistoryResponse (Maybe Word64) Source #
The ID of the mailbox's current history record.
SendAs
Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface.
See: sendAs
smart constructor.
Instances
Creates a value of SendAs
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
saSignature :: Lens' SendAs (Maybe Text) Source #
An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
saReplyToAddress :: Lens' SendAs (Maybe Text) Source #
An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header.
saTreatAsAlias :: Lens' SendAs (Maybe Bool) Source #
Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases.
saSendAsEmail :: Lens' SendAs (Maybe Text) Source #
The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
saDisplayName :: Lens' SendAs (Maybe Text) Source #
A name that appears in the "From:" header for mail sent using this alias. For custom "from" addresses, when this is empty, Gmail will populate the "From:" header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
saVerificationStatus :: Lens' SendAs (Maybe SendAsVerificationStatus) Source #
Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
saSmtpMsa :: Lens' SendAs (Maybe SmtpMsa) Source #
An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom "from" aliases.
saIsPrimary :: Lens' SendAs (Maybe Bool) Source #
Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.
saIsDefault :: Lens' SendAs (Maybe Bool) Source #
Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true. Changing this from false to true for an address will result in this field becoming false for the other previous default address.
LabelType
The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the INBOX and UNREAD labels from messages and threads, but cannot apply or remove the DRAFTS or SENT labels from messages or threads.
Instances
UsersDraftsGetFormat
data UsersDraftsGetFormat Source #
The format to return the draft in.
Constructors
UDGFFull | full |
UDGFMetadata | metadata |
UDGFMinimal | minimal |
UDGFRaw | raw |
Instances
UsersMessagesImportInternalDateSource
data UsersMessagesImportInternalDateSource Source #
Source for Gmail's internal date of the message.
Constructors
DateHeader | dateHeader |
ReceivedTime | receivedTime |
Instances
LabelMessageListVisibility
data LabelMessageListVisibility Source #
The visibility of the label in the message list in the Gmail web interface.
Instances
ListThreadsResponse
data ListThreadsResponse Source #
Instances
listThreadsResponse :: ListThreadsResponse Source #
Creates a value of ListThreadsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ltrNextPageToken :: Lens' ListThreadsResponse (Maybe Text) Source #
Page token to retrieve the next page of results in the list.
ltrResultSizeEstimate :: Lens' ListThreadsResponse (Maybe Word32) Source #
Estimated total number of results.
ltrThreads :: Lens' ListThreadsResponse [Thread] Source #
List of threads.
MessagePart
data MessagePart Source #
A single MIME message part.
See: messagePart
smart constructor.
Instances
Eq MessagePart Source # | |
Defined in Network.Google.Gmail.Types.Product Methods (==) :: MessagePart -> MessagePart -> |