Module UsersResource.Threads
module Format : sig ... end
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 thread. This operation cannot be undone. Prefer threads.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
ID of the Thread 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.Thread.t * GapiConversation.Session.t
Gets the specified thread.
- 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 messages 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 thread to retrieve.
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.ListThreadsResponse.t * GapiConversation.Session.t
Lists the threads 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 threads from SPAM and TRASH in the results.
- parameter maxResults
Maximum number of threads to return.
- parameter labelIds
Only return threads 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 threads matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: 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.ModifyThreadRequest.t -> GapiConversation.Session.t -> GapiGmailV1Model.Thread.t * GapiConversation.Session.t
Modifies the labels applied to the thread. This applies to all messages in the thread.
- 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 thread to modify.
val trash : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> userId:string -> id:string -> GapiConversation.Session.t -> GapiGmailV1Model.Thread.t * GapiConversation.Session.t
Moves the specified thread 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 thread to Trash.
val untrash : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> userId:string -> id:string -> GapiConversation.Session.t -> GapiGmailV1Model.Thread.t * GapiConversation.Session.t
Removes the specified thread 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 thread to remove from Trash.