package gapi-ocaml

  1. Overview
  2. Docs
package gapi-ocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
module SmimeInfo : sig ... end

Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.

This method is only available to service account clients that have been delegated domain-wide authority.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/gmail/v1/users/").

  • parameter std_params

    Optional standard parameters.

  • parameter userId

    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 -> sendAsEmail:string -> GapiConversation.Session.t -> unit * GapiConversation.Session.t

Deletes the specified send-as alias. Revokes any verification that may have been required for using it.

This method is only available to service account clients that have been delegated domain-wide authority.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/gmail/v1/users/").

  • parameter std_params

    Optional standard parameters.

  • parameter userId

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

  • parameter sendAsEmail

    The send-as alias to be deleted.

val get : ?base_url:string -> ?etag:string -> ?std_params:GapiService.StandardParameters.t -> userId:string -> sendAsEmail:string -> GapiConversation.Session.t -> GapiGmailV1Model.SendAs.t * GapiConversation.Session.t

Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection.

  • 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 userId

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

  • parameter sendAsEmail

    The send-as alias to be retrieved.

Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom "from" aliases.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/gmail/v1/users/").

  • parameter std_params

    Optional standard parameters.

  • parameter userId

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

val patch : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> userId:string -> sendAsEmail:string -> GapiGmailV1Model.SendAs.t -> GapiConversation.Session.t -> GapiGmailV1Model.SendAs.t * GapiConversation.Session.t

Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.

Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority. This method supports patch semantics.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/gmail/v1/users/").

  • parameter std_params

    Optional standard parameters.

  • parameter userId

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

  • parameter sendAsEmail

    The send-as alias to be updated.

val update : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> userId:string -> sendAsEmail:string -> GapiGmailV1Model.SendAs.t -> GapiConversation.Session.t -> GapiGmailV1Model.SendAs.t * GapiConversation.Session.t

Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.

Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/gmail/v1/users/").

  • parameter std_params

    Optional standard parameters.

  • parameter userId

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

  • parameter sendAsEmail

    The send-as alias to be updated.

val verify : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> userId:string -> sendAsEmail:string -> GapiConversation.Session.t -> unit * GapiConversation.Session.t

Sends a verification email to the specified send-as alias address. The verification status must be pending.

This method is only available to service account clients that have been delegated domain-wide authority.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/gmail/v1/users/").

  • parameter std_params

    Optional standard parameters.

  • parameter userId

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

  • parameter sendAsEmail

    The send-as alias to be verified.