Module UsersResource.Messages
module Attachments : sig ... end
module InternalDateSource : sig ... end
module Format : sig ... end
val batchDelete : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> userId:string -> GapiGmailV1Model.BatchDeleteMessagesRequest.t -> GapiConversation.Session.t -> unit * GapiConversation.Session.t
Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all.
- parameter base_url
Service endpoint base URL (defaults to
"https://www.googleapis.com/gmail/v1/users/"
).
- parameter std_params
Optional standard parameters.
- parameter userId
The user's email address. The special value me can be used to indicate the authenticated user.
val batchModify : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> userId:string -> GapiGmailV1Model.BatchModifyMessagesRequest.t -> GapiConversation.Session.t -> unit * GapiConversation.Session.t
Modifies the labels on the specified messages.
- parameter base_url
Service endpoint base URL (defaults to
"https://www.googleapis.com/gmail/v1/users/"
).
- parameter std_params
Optional standard parameters.
- parameter userId
The user's email address. The special value me can be used to indicate the authenticated user.
val delete : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> userId:string -> id:string -> GapiConversation.Session.t -> unit * GapiConversation.Session.t
Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer messages.trash instead.
- parameter base_url
Service endpoint base URL (defaults to
"https://www.googleapis.com/gmail/v1/users/"
).
- parameter std_params
Optional standard parameters.
- parameter userId
The user's email address. The special value me can be used to indicate the authenticated user.
- parameter id
The ID of the message to delete.
val get : ?base_url:string -> ?etag:string -> ?std_params:GapiService.StandardParameters.t -> ?format:Format.t -> ?metadataHeaders:string list -> userId:string -> id:string -> GapiConversation.Session.t -> GapiGmailV1Model.Message.t * GapiConversation.Session.t
Gets the specified message.
- parameter base_url
Service endpoint base URL (defaults to
"https://www.googleapis.com/gmail/v1/users/"
).
- parameter etag
Optional ETag.
- parameter std_params
Optional standard parameters.
- parameter format
The format to return the message in.
- parameter metadataHeaders
When given and format is METADATA, only include headers specified.
- parameter userId
The user's email address. The special value me can be used to indicate the authenticated user.
- parameter id
The ID of the message to retrieve.
val import : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?media_source:GapiMediaResource.t -> ?deleted:bool -> ?internalDateSource:InternalDateSource.t -> ?neverMarkSpam:bool -> ?processForCalendar:bool -> userId:string -> GapiGmailV1Model.Message.t -> GapiConversation.Session.t -> GapiGmailV1Model.Message.t * GapiConversation.Session.t
Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message.
- parameter base_url
Service endpoint base URL (defaults to
"https://www.googleapis.com/gmail/v1/users/"
).
- parameter std_params
Optional standard parameters.
- parameter deleted
Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts.
- parameter internalDateSource
Source for Gmail's internal date of the message.
- parameter neverMarkSpam
Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.
- parameter processForCalendar
Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.
- parameter userId
The user's email address. The special value me can be used to indicate the authenticated user.
val insert : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?media_source:GapiMediaResource.t -> ?deleted:bool -> ?internalDateSource:InternalDateSource.t -> userId:string -> GapiGmailV1Model.Message.t -> GapiConversation.Session.t -> GapiGmailV1Model.Message.t * GapiConversation.Session.t
Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message.
- parameter base_url
Service endpoint base URL (defaults to
"https://www.googleapis.com/gmail/v1/users/"
).
- parameter std_params
Optional standard parameters.
- parameter deleted
Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts.
- parameter internalDateSource
Source for Gmail's internal date of the message.
- parameter userId
The user's email address. The special value me can be used to indicate the authenticated user.
val list : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?includeSpamTrash:bool -> ?maxResults:int -> ?labelIds:string list -> ?pageToken:string -> ?q:string -> userId:string -> GapiConversation.Session.t -> GapiGmailV1Model.ListMessagesResponse.t * GapiConversation.Session.t
Lists the messages in the user's mailbox.
- parameter base_url
Service endpoint base URL (defaults to
"https://www.googleapis.com/gmail/v1/users/"
).
- parameter std_params
Optional standard parameters.
- parameter includeSpamTrash
Include messages from SPAM and TRASH in the results.
- parameter maxResults
Maximum number of messages to return.
- parameter labelIds
Only return messages with labels that match all of the specified label IDs.
- parameter pageToken
Page token to retrieve a specific page of results in the list.
- parameter q
Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread". Parameter cannot be used when accessing the api using the gmail.metadata scope.
- parameter userId
The user's email address. The special value me can be used to indicate the authenticated user.
val modify : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> userId:string -> id:string -> GapiGmailV1Model.ModifyMessageRequest.t -> GapiConversation.Session.t -> GapiGmailV1Model.Message.t * GapiConversation.Session.t
Modifies the labels on the specified message.
- parameter base_url
Service endpoint base URL (defaults to
"https://www.googleapis.com/gmail/v1/users/"
).
- parameter std_params
Optional standard parameters.
- parameter userId
The user's email address. The special value me can be used to indicate the authenticated user.
- parameter id
The ID of the message to modify.
val send : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?media_source:GapiMediaResource.t -> userId:string -> GapiGmailV1Model.Message.t -> GapiConversation.Session.t -> GapiGmailV1Model.Message.t * GapiConversation.Session.t
Sends the specified message to the recipients in the To, Cc, and Bcc headers.
- parameter base_url
Service endpoint base URL (defaults to
"https://www.googleapis.com/gmail/v1/users/"
).
- parameter std_params
Optional standard parameters.
- parameter userId
The user's email address. The special value me can be used to indicate the authenticated user.
val trash : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> userId:string -> id:string -> GapiConversation.Session.t -> GapiGmailV1Model.Message.t * GapiConversation.Session.t
Moves the specified message to the trash.
- parameter base_url
Service endpoint base URL (defaults to
"https://www.googleapis.com/gmail/v1/users/"
).
- parameter std_params
Optional standard parameters.
- parameter userId
The user's email address. The special value me can be used to indicate the authenticated user.
- parameter id
The ID of the message to Trash.
val untrash : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> userId:string -> id:string -> GapiConversation.Session.t -> GapiGmailV1Model.Message.t * GapiConversation.Session.t
Removes the specified message from the trash.
- parameter base_url
Service endpoint base URL (defaults to
"https://www.googleapis.com/gmail/v1/users/"
).
- parameter std_params
Optional standard parameters.
- parameter userId
The user's email address. The special value me can be used to indicate the authenticated user.
- parameter id
The ID of the message to remove from Trash.