package gapi-ocaml

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Format : sig ... end

Creates a new draft with the DRAFT label.

  • 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 draft. Does not simply trash it.

  • 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 draft to delete.

val get : ?base_url:string -> ?etag:string -> ?std_params:GapiService.StandardParameters.t -> ?format:Format.t -> userId:string -> id:string -> GapiConversation.Session.t -> GapiGmailV1Model.Draft.t * GapiConversation.Session.t

Gets the specified draft.

  • 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 draft in.

  • 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 draft to retrieve.

val list : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?includeSpamTrash:bool -> ?maxResults:int -> ?pageToken:string -> ?q:string -> userId:string -> GapiConversation.Session.t -> GapiGmailV1Model.ListDraftsResponse.t * GapiConversation.Session.t

Lists the drafts 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 drafts from SPAM and TRASH in the results.

  • parameter maxResults

    Maximum number of drafts to return.

  • parameter pageToken

    Page token to retrieve a specific page of results in the list.

  • parameter q

    Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread".

  • parameter userId

    The user's email address. The special value me can be used to indicate the authenticated user.

Sends the specified, existing draft 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 update : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?media_source:GapiMediaResource.t -> userId:string -> id:string -> GapiGmailV1Model.Draft.t -> GapiConversation.Session.t -> GapiGmailV1Model.Draft.t * GapiConversation.Session.t

Replaces a draft's content.

  • 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 draft to update.