GoogleApi.Gmail.V1.Api.Users (google_api_gmail v0.17.0)

Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. This method doesn't perform SPF checks, so it might not work for some spam messages, such as those attempting to perform domain spoofing. This method does not send a message.

gmail_users_messages_import_iodata(connection, user_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

gmail_users_messages_import_resumable(connection, user_id, upload_type, optional_params \\ [], opts \\ [])

gmail_users_messages_import_simple(connection, user_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

gmail_users_messages_insert(connection, user_id, optional_params \\ [], opts \\ [])

Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message.

gmail_users_messages_insert_iodata(connection, user_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message.

gmail_users_messages_insert_resumable(connection, user_id, upload_type, optional_params \\ [], opts \\ [])

Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message.

gmail_users_messages_insert_simple(connection, user_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message.

gmail_users_messages_list(connection, user_id, optional_params \\ [], opts \\ [])

Lists the messages in the user's mailbox.

gmail_users_messages_modify(connection, user_id, id, optional_params \\ [], opts \\ [])

Modifies the labels on the specified message.

gmail_users_messages_send(connection, user_id, optional_params \\ [], opts \\ [])

Sends the specified message to the recipients in the To, Cc, and Bcc headers. For example usage, see Sending email.

gmail_users_messages_send_iodata(connection, user_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

Sends the specified message to the recipients in the To, Cc, and Bcc headers. For example usage, see Sending email.

gmail_users_messages_send_resumable(connection, user_id, upload_type, optional_params \\ [], opts \\ [])

Sends the specified message to the recipients in the To, Cc, and Bcc headers. For example usage, see Sending email.

gmail_users_messages_send_simple(connection, user_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

Sends the specified message to the recipients in the To, Cc, and Bcc headers. For example usage, see Sending email.

gmail_users_messages_trash(connection, user_id, id, optional_params \\ [], opts \\ [])

Moves the specified message to the trash.

gmail_users_messages_untrash(connection, user_id, id, optional_params \\ [], opts \\ [])

Removes the specified message from the trash.

gmail_users_settings_cse_identities_create(connection, user_id, optional_params \\ [], opts \\ [])

Creates and configures a client-side encryption identity that's authorized to send mail from the user account. Google publishes the S/MIME certificate to a shared domain-wide directory so that people within a Google Workspace organization can encrypt and send mail to the identity.

gmail_users_settings_cse_identities_delete(connection, user_id, cse_email_address, optional_params \\ [], opts \\ [])

Deletes a client-side encryption identity. The authenticated user can no longer use the identity to send encrypted messages. You cannot restore the identity after you delete it. Instead, use the CreateCseIdentity method to create another identity with the same configuration.

gmail_users_settings_cse_identities_get(connection, user_id, cse_email_address, optional_params \\ [], opts \\ [])

Retrieves a client-side encryption identity configuration.

gmail_users_settings_cse_identities_list(connection, user_id, optional_params \\ [], opts \\ [])

Lists the client-side encrypted identities for an authenticated user.

gmail_users_settings_cse_identities_patch(connection, user_id, email_address, optional_params \\ [], opts \\ [])

Associates a different key pair with an existing client-side encryption identity. The updated key pair must validate against Google's S/MIME certificate profiles.

gmail_users_settings_cse_keypairs_create(connection, user_id, optional_params \\ [], opts \\ [])

Creates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata for the authenticated user.

gmail_users_settings_cse_keypairs_disable(connection, user_id, key_pair_id, optional_params \\ [], opts \\ [])

Turns off a client-side encryption key pair. The authenticated user can no longer use the key pair to decrypt incoming CSE message texts or sign outgoing CSE mail. To regain access, use the EnableCseKeyPair to turn on the key pair. After 30 days, you can permanently delete the key pair by using the ObliterateCseKeyPair method.

gmail_users_settings_cse_keypairs_enable(connection, user_id, key_pair_id, optional_params \\ [], opts \\ [])

Turns on a client-side encryption key pair that was turned off. The key pair becomes active again for any associated client-side encryption identities.

gmail_users_settings_cse_keypairs_get(connection, user_id, key_pair_id, optional_params \\ [], opts \\ [])

Retrieves an existing client-side encryption key pair.

gmail_users_settings_cse_keypairs_list(connection, user_id, optional_params \\ [], opts \\ [])

Lists client-side encryption key pairs for an authenticated user.

gmail_users_settings_cse_keypairs_obliterate(connection, user_id, key_pair_id, optional_params \\ [], opts \\ [])

Deletes a client-side encryption key pair permanently and immediately. You can only permanently delete key pairs that have been turned off for more than 30 days. To turn off a key pair, use the DisableCseKeyPair method. Gmail can't restore or decrypt any messages that were encrypted by an obliterated key. Authenticated users and Google Workspace administrators lose access to reading the encrypted messages.

gmail_users_settings_delegates_create(connection, user_id, optional_params \\ [], opts \\ [])

Adds a delegate with its verification status set directly to accepted, without sending any verification email. The delegate user must be a member of the same Google Workspace organization as the delegator user. Gmail imposes limitations on the number of delegates and delegators each user in a Google Workspace organization can have. These limits depend on your organization, but in general each user can have up to 25 delegates and up to 10 delegators. Note that a delegate user must be referred to by their primary email address, and not an email alias. Also note that when a new delegate is created, there may be up to a one minute delay before the new delegate is available for use. This method is only available to service account clients that have been delegated domain-wide authority.

gmail_users_settings_delegates_delete(connection, user_id, delegate_email, optional_params \\ [], opts \\ [])

Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it. Note that a delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority.

gmail_users_settings_delegates_get(connection, user_id, delegate_email, optional_params \\ [], opts \\ [])

Gets the specified delegate. Note that a delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority.

gmail_users_settings_delegates_list(connection, user_id, optional_params \\ [], opts \\ [])

Lists the delegates for the specified account. This method is only available to service account clients that have been delegated domain-wide authority.

gmail_users_settings_filters_create(connection, user_id, optional_params \\ [], opts \\ [])

Creates a filter. Note: you can only create a maximum of 1,000 filters.

gmail_users_settings_filters_delete(connection, user_id, id, optional_params \\ [], opts \\ [])

Immediately and permanently deletes the specified filter.

gmail_users_settings_filters_get(connection, user_id, id, optional_params \\ [], opts \\ [])

Gets a filter.

gmail_users_settings_filters_list(connection, user_id, optional_params \\ [], opts \\ [])

Lists the message filters of a Gmail user.

gmail_users_settings_forwarding_addresses_create(connection, user_id, optional_params \\ [], opts \\ [])

Creates a forwarding address. If ownership verification is required, a message will be sent to the recipient and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. This method is only available to service account clients that have been delegated domain-wide authority.

gmail_users_settings_forwarding_addresses_delete(connection, user_id, forwarding_email, optional_params \\ [], opts \\ [])

Deletes the specified forwarding address and revokes any verification that may have been required. This method is only available to service account clients that have been delegated domain-wide authority.

gmail_users_settings_forwarding_addresses_get(connection, user_id, forwarding_email, optional_params \\ [], opts \\ [])

Gets the specified forwarding address.

gmail_users_settings_forwarding_addresses_list(connection, user_id, optional_params \\ [], opts \\ [])

Lists the forwarding addresses for the specified account.

gmail_users_settings_get_auto_forwarding(connection, user_id, optional_params \\ [], opts \\ [])

Gets the auto-forwarding setting for the specified account.

gmail_users_settings_get_imap(connection, user_id, optional_params \\ [], opts \\ [])

Gets IMAP settings.

gmail_users_settings_get_language(connection, user_id, optional_params \\ [], opts \\ [])

Gets language settings.

gmail_users_settings_get_pop(connection, user_id, optional_params \\ [], opts \\ [])

Gets POP settings.

gmail_users_settings_get_vacation(connection, user_id, optional_params \\ [], opts \\ [])

Gets vacation responder settings.

gmail_users_settings_send_as_create(connection, user_id, optional_params \\ [], opts \\ [])

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.

gmail_users_settings_send_as_delete(connection, user_id, send_as_email, optional_params \\ [], opts \\ [])

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.

gmail_users_settings_send_as_get(connection, user_id, send_as_email, optional_params \\ [], opts \\ [])

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

gmail_users_settings_send_as_list(connection, user_id, optional_params \\ [], opts \\ [])

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.

gmail_users_settings_send_as_patch(connection, user_id, send_as_email, optional_params \\ [], opts \\ [])

Patch the specified send-as alias.

gmail_users_settings_send_as_smime_info_delete(connection, user_id, send_as_email, id, optional_params \\ [], opts \\ [])

Deletes the specified S/MIME config for the specified send-as alias.

gmail_users_settings_send_as_smime_info_get(connection, user_id, send_as_email, id, optional_params \\ [], opts \\ [])

Gets the specified S/MIME config for the specified send-as alias.

gmail_users_settings_send_as_smime_info_insert(connection, user_id, send_as_email, optional_params \\ [], opts \\ [])

Insert (upload) the given S/MIME config for the specified send-as alias. Note that pkcs12 format is required for the key.

gmail_users_settings_send_as_smime_info_list(connection, user_id, send_as_email, optional_params \\ [], opts \\ [])

Lists S/MIME configs for the specified send-as alias.

gmail_users_settings_send_as_smime_info_set_default(connection, user_id, send_as_email, id, optional_params \\ [], opts \\ [])

Sets the default S/MIME config for the specified send-as alias.

gmail_users_settings_send_as_update(connection, user_id, send_as_email, optional_params \\ [], opts \\ [])

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.

gmail_users_settings_send_as_verify(connection, user_id, send_as_email, optional_params \\ [], opts \\ [])

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.

gmail_users_settings_update_auto_forwarding(connection, user_id, optional_params \\ [], opts \\ [])

Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. This method is only available to service account clients that have been delegated domain-wide authority.

gmail_users_settings_update_imap(connection, user_id, optional_params \\ [], opts \\ [])

Updates IMAP settings.

gmail_users_settings_update_language(connection, user_id, optional_params \\ [], opts \\ [])

Updates language settings. If successful, the return object contains the displayLanguage that was saved for the user, which may differ from the value passed into the request. This is because the requested displayLanguage may not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead.

gmail_users_settings_update_pop(connection, user_id, optional_params \\ [], opts \\ [])

Updates POP settings.

gmail_users_settings_update_vacation(connection, user_id, optional_params \\ [], opts \\ [])

Updates vacation responder settings.

gmail_users_stop(connection, user_id, optional_params \\ [], opts \\ [])

Stop receiving push notifications for the given user mailbox.

gmail_users_threads_delete(connection, user_id, id, optional_params \\ [], opts \\ [])

Immediately and permanently deletes the specified thread. Any messages that belong to the thread are also deleted. This operation cannot be undone. Prefer threads.trash instead.

gmail_users_threads_get(connection, user_id, id, optional_params \\ [], opts \\ [])

Gets the specified thread.

gmail_users_threads_list(connection, user_id, optional_params \\ [], opts \\ [])

Lists the threads in the user's mailbox.

gmail_users_threads_modify(connection, user_id, id, optional_params \\ [], opts \\ [])

Modifies the labels applied to the thread. This applies to all messages in the thread.

gmail_users_threads_trash(connection, user_id, id, optional_params \\ [], opts \\ [])

Moves the specified thread to the trash. Any messages that belong to the thread are also moved to the trash.

gmail_users_threads_untrash(connection, user_id, id, optional_params \\ [], opts \\ [])

Removes the specified thread from the trash. Any messages that belong to the thread are also removed from the trash.

gmail_users_watch(connection, user_id, optional_params \\ [], opts \\ [])

Set up or update a push notification watch on the given user mailbox.

Functions

gmail_users_drafts_create(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_drafts_create(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Gmail.V1.Model.Draft.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new draft with the DRAFT label.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.Draft.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Draft{}} on success
{:error, info} on failure

gmail_users_drafts_create_iodata(connection, user_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

@spec gmail_users_drafts_create_iodata(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  GoogleApi.Gmail.V1.Model.Draft.t(),
  iodata(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Draft.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new draft with the DRAFT label.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
upload_type (type: String.t) - Upload type. Must be "multipart".
metadata (type: GoogleApi.Gmail.V1.Model.Draft.t) - object metadata
data (type: iodata) - Content to upload, as a string or iolist
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Draft{}} on success
{:error, info} on failure

gmail_users_drafts_create_resumable(connection, user_id, upload_type, optional_params \\ [], opts \\ [])

@spec gmail_users_drafts_create_resumable(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Creates a new draft with the DRAFT label.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
upload_type (type: String.t) - Upload type. Must be "resumable".
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.Draft.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

gmail_users_drafts_create_simple(connection, user_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

@spec gmail_users_drafts_create_simple(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  GoogleApi.Gmail.V1.Model.Draft.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Draft.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new draft with the DRAFT label.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
upload_type (type: String.t) - Upload type. Must be "multipart".
metadata (type: GoogleApi.Gmail.V1.Model.Draft.t) - object metadata
data (type: String.t) - Path to file containing content to upload
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Draft{}} on success
{:error, info} on failure

gmail_users_drafts_delete(connection, user_id, id, optional_params \\ [], opts \\ [])

@spec gmail_users_drafts_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Immediately and permanently deletes the specified draft. Does not simply trash it.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
id (type: String.t) - The ID of the draft to delete.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

gmail_users_drafts_get(connection, user_id, id, optional_params \\ [], opts \\ [])

@spec gmail_users_drafts_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Draft.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the specified draft.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
id (type: String.t) - The ID of the draft to retrieve.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :format (type: String.t) - The format to return the draft in.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Draft{}} on success
{:error, info} on failure

gmail_users_drafts_list(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_drafts_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Gmail.V1.Model.ListDraftsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the drafts in the user's mailbox.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :includeSpamTrash (type: boolean()) - Include drafts from SPAM and TRASH in the results.
- :maxResults (type: integer()) - Maximum number of drafts to return. This field defaults to 100. The maximum allowed value for this field is 500.
- :pageToken (type: String.t) - Page token to retrieve a specific page of results in the list.
- :q (type: String.t) - 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".
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.ListDraftsResponse{}} on success
{:error, info} on failure

gmail_users_drafts_send(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_drafts_send(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Gmail.V1.Model.Message.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.Draft.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Message{}} on success
{:error, info} on failure

gmail_users_drafts_send_iodata(connection, user_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

@spec gmail_users_drafts_send_iodata(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  GoogleApi.Gmail.V1.Model.Draft.t(),
  iodata(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Message.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
upload_type (type: String.t) - Upload type. Must be "multipart".
metadata (type: GoogleApi.Gmail.V1.Model.Draft.t) - object metadata
data (type: iodata) - Content to upload, as a string or iolist
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Message{}} on success
{:error, info} on failure

gmail_users_drafts_send_resumable(connection, user_id, upload_type, optional_params \\ [], opts \\ [])

@spec gmail_users_drafts_send_resumable(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
upload_type (type: String.t) - Upload type. Must be "resumable".
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.Draft.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

gmail_users_drafts_send_simple(connection, user_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

@spec gmail_users_drafts_send_simple(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  GoogleApi.Gmail.V1.Model.Draft.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Message.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
upload_type (type: String.t) - Upload type. Must be "multipart".
metadata (type: GoogleApi.Gmail.V1.Model.Draft.t) - object metadata
data (type: String.t) - Path to file containing content to upload
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Message{}} on success
{:error, info} on failure

gmail_users_drafts_update(connection, user_id, id, optional_params \\ [], opts \\ [])

@spec gmail_users_drafts_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Draft.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Replaces a draft's content.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
id (type: String.t) - The ID of the draft to update.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.Draft.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Draft{}} on success
{:error, info} on failure

gmail_users_drafts_update_iodata(connection, user_id, id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

@spec gmail_users_drafts_update_iodata(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  GoogleApi.Gmail.V1.Model.Draft.t(),
  iodata(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Draft.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Replaces a draft's content.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
id (type: String.t) - The ID of the draft to update.
upload_type (type: String.t) - Upload type. Must be "multipart".
metadata (type: GoogleApi.Gmail.V1.Model.Draft.t) - object metadata
data (type: iodata) - Content to upload, as a string or iolist
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Draft{}} on success
{:error, info} on failure

gmail_users_drafts_update_resumable(connection, user_id, id, upload_type, optional_params \\ [], opts \\ [])

@spec gmail_users_drafts_update_resumable(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Replaces a draft's content.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
id (type: String.t) - The ID of the draft to update.
upload_type (type: String.t) - Upload type. Must be "resumable".
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.Draft.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

gmail_users_drafts_update_simple(connection, user_id, id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

@spec gmail_users_drafts_update_simple(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  GoogleApi.Gmail.V1.Model.Draft.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Draft.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Replaces a draft's content.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
id (type: String.t) - The ID of the draft to update.
upload_type (type: String.t) - Upload type. Must be "multipart".
metadata (type: GoogleApi.Gmail.V1.Model.Draft.t) - object metadata
data (type: String.t) - Path to file containing content to upload
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Draft{}} on success
{:error, info} on failure

gmail_users_get_profile(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_get_profile(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Gmail.V1.Model.Profile.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the current user's Gmail profile.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Profile{}} on success
{:error, info} on failure

gmail_users_history_list(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_history_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Gmail.V1.Model.ListHistoryResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId).

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :historyTypes (type: list(String.t)) - History types to be returned by the function
- :labelId (type: String.t) - Only return messages with a label matching the ID.
- :maxResults (type: integer()) - Maximum number of history records to return. This field defaults to 100. The maximum allowed value for this field is 500.
- :pageToken (type: String.t) - Page token to retrieve a specific page of results in the list.
- :startHistoryId (type: String.t) - Required. Returns history records after the specified startHistoryId. The supplied startHistoryId should be obtained from the historyId of a message, thread, or previous list response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date startHistoryId typically returns an HTTP 404 error code. A historyId is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an HTTP 404 error response, your application should perform a full sync. If you receive no nextPageToken in the response, there are no updates to retrieve and you can store the returned historyId for a future request.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.ListHistoryResponse{}} on success
{:error, info} on failure

gmail_users_labels_create(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_labels_create(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Gmail.V1.Model.Label.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new label.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.Label.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Label{}} on success
{:error, info} on failure

gmail_users_labels_delete(connection, user_id, id, optional_params \\ [], opts \\ [])

@spec gmail_users_labels_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
id (type: String.t) - The ID of the label to delete.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

gmail_users_labels_get(connection, user_id, id, optional_params \\ [], opts \\ [])

@spec gmail_users_labels_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Label.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the specified label.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
id (type: String.t) - The ID of the label to retrieve.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Label{}} on success
{:error, info} on failure

gmail_users_labels_list(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_labels_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Gmail.V1.Model.ListLabelsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all labels in the user's mailbox.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.ListLabelsResponse{}} on success
{:error, info} on failure

gmail_users_labels_patch(connection, user_id, id, optional_params \\ [], opts \\ [])

@spec gmail_users_labels_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Label.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Patch the specified label.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
id (type: String.t) - The ID of the label to update.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.Label.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Label{}} on success
{:error, info} on failure

gmail_users_labels_update(connection, user_id, id, optional_params \\ [], opts \\ [])

@spec gmail_users_labels_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Label.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the specified label.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
id (type: String.t) - The ID of the label to update.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.Label.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Label{}} on success
{:error, info} on failure

gmail_users_messages_attachments_get(connection, user_id, message_id, id, optional_params \\ [], opts \\ [])

@spec gmail_users_messages_attachments_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.MessagePartBody.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the specified message attachment.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
message_id (type: String.t) - The ID of the message containing the attachment.
id (type: String.t) - The ID of the attachment.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.MessagePartBody{}} on success
{:error, info} on failure

gmail_users_messages_batch_delete(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_messages_batch_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.BatchDeleteMessagesRequest.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

gmail_users_messages_batch_modify(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_messages_batch_modify(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Modifies the labels on the specified messages.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.BatchModifyMessagesRequest.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

gmail_users_messages_delete(connection, user_id, id, optional_params \\ [], opts \\ [])

@spec gmail_users_messages_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer messages.trash instead.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
id (type: String.t) - The ID of the message to delete.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

gmail_users_messages_get(connection, user_id, id, optional_params \\ [], opts \\ [])

@spec gmail_users_messages_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Message.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the specified message.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
id (type: String.t) - The ID of the message to retrieve. This ID is usually retrieved using messages.list. The ID is also contained in the result when a message is inserted (messages.insert) or imported (messages.import).
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :format (type: String.t) - The format to return the message in.
- :metadataHeaders (type: list(String.t)) - When given and format is METADATA, only include headers specified.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Message{}} on success
{:error, info} on failure

gmail_users_messages_import(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_messages_import(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Message.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :deleted (type: boolean()) - Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.
- :internalDateSource (type: String.t) - Source for Gmail's internal date of the message.
- :neverMarkSpam (type: boolean()) - Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.
- :processForCalendar (type: boolean()) - Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.
- :body (type: GoogleApi.Gmail.V1.Model.Message.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Message{}} on success
{:error, info} on failure

gmail_users_messages_import_iodata(connection, user_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

@spec gmail_users_messages_import_iodata(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  GoogleApi.Gmail.V1.Model.Message.t(),
  iodata(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Message.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
upload_type (type: String.t) - Upload type. Must be "multipart".
metadata (type: GoogleApi.Gmail.V1.Model.Message.t) - object metadata
data (type: iodata) - Content to upload, as a string or iolist
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :deleted (type: boolean()) - Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.
- :internalDateSource (type: String.t) - Source for Gmail's internal date of the message.
- :neverMarkSpam (type: boolean()) - Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.
- :processForCalendar (type: boolean()) - Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Message{}} on success
{:error, info} on failure

gmail_users_messages_import_resumable(connection, user_id, upload_type, optional_params \\ [], opts \\ [])

@spec gmail_users_messages_import_resumable(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
upload_type (type: String.t) - Upload type. Must be "resumable".
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :deleted (type: boolean()) - Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.
- :internalDateSource (type: String.t) - Source for Gmail's internal date of the message.
- :neverMarkSpam (type: boolean()) - Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.
- :processForCalendar (type: boolean()) - Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.
- :body (type: GoogleApi.Gmail.V1.Model.Message.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

gmail_users_messages_import_simple(connection, user_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

@spec gmail_users_messages_import_simple(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  GoogleApi.Gmail.V1.Model.Message.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Message.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
upload_type (type: String.t) - Upload type. Must be "multipart".
metadata (type: GoogleApi.Gmail.V1.Model.Message.t) - object metadata
data (type: String.t) - Path to file containing content to upload
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :deleted (type: boolean()) - Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.
- :internalDateSource (type: String.t) - Source for Gmail's internal date of the message.
- :neverMarkSpam (type: boolean()) - Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.
- :processForCalendar (type: boolean()) - Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Message{}} on success
{:error, info} on failure

gmail_users_messages_insert(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_messages_insert(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Message.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :deleted (type: boolean()) - Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.
- :internalDateSource (type: String.t) - Source for Gmail's internal date of the message.
- :body (type: GoogleApi.Gmail.V1.Model.Message.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Message{}} on success
{:error, info} on failure

gmail_users_messages_insert_iodata(connection, user_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

@spec gmail_users_messages_insert_iodata(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  GoogleApi.Gmail.V1.Model.Message.t(),
  iodata(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Message.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
upload_type (type: String.t) - Upload type. Must be "multipart".
metadata (type: GoogleApi.Gmail.V1.Model.Message.t) - object metadata
data (type: iodata) - Content to upload, as a string or iolist
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :deleted (type: boolean()) - Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.
- :internalDateSource (type: String.t) - Source for Gmail's internal date of the message.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Message{}} on success
{:error, info} on failure

gmail_users_messages_insert_resumable(connection, user_id, upload_type, optional_params \\ [], opts \\ [])

@spec gmail_users_messages_insert_resumable(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
upload_type (type: String.t) - Upload type. Must be "resumable".
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :deleted (type: boolean()) - Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.
- :internalDateSource (type: String.t) - Source for Gmail's internal date of the message.
- :body (type: GoogleApi.Gmail.V1.Model.Message.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

gmail_users_messages_insert_simple(connection, user_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

@spec gmail_users_messages_insert_simple(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  GoogleApi.Gmail.V1.Model.Message.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Message.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
upload_type (type: String.t) - Upload type. Must be "multipart".
metadata (type: GoogleApi.Gmail.V1.Model.Message.t) - object metadata
data (type: String.t) - Path to file containing content to upload
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :deleted (type: boolean()) - Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.
- :internalDateSource (type: String.t) - Source for Gmail's internal date of the message.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Message{}} on success
{:error, info} on failure

gmail_users_messages_list(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_messages_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Gmail.V1.Model.ListMessagesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the messages in the user's mailbox.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :includeSpamTrash (type: boolean()) - Include messages from SPAM and TRASH in the results.
- :labelIds (type: list(String.t)) - Only return messages with labels that match all of the specified label IDs. Messages in a thread might have labels that other messages in the same thread don't have. To learn more, see Manage labels on messages and threads.
- :maxResults (type: integer()) - Maximum number of messages to return. This field defaults to 100. The maximum allowed value for this field is 500.
- :pageToken (type: String.t) - Page token to retrieve a specific page of results in the list.
- :q (type: String.t) - 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". Parameter cannot be used when accessing the api using the gmail.metadata scope.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.ListMessagesResponse{}} on success
{:error, info} on failure

gmail_users_messages_modify(connection, user_id, id, optional_params \\ [], opts \\ [])

@spec gmail_users_messages_modify(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Message.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Modifies the labels on the specified message.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
id (type: String.t) - The ID of the message to modify.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.ModifyMessageRequest.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Message{}} on success
{:error, info} on failure

gmail_users_messages_send(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_messages_send(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Gmail.V1.Model.Message.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Sends the specified message to the recipients in the To, Cc, and Bcc headers. For example usage, see Sending email.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.Message.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Message{}} on success
{:error, info} on failure

gmail_users_messages_send_iodata(connection, user_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

@spec gmail_users_messages_send_iodata(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  GoogleApi.Gmail.V1.Model.Message.t(),
  iodata(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Message.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Sends the specified message to the recipients in the To, Cc, and Bcc headers. For example usage, see Sending email.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
upload_type (type: String.t) - Upload type. Must be "multipart".
metadata (type: GoogleApi.Gmail.V1.Model.Message.t) - object metadata
data (type: iodata) - Content to upload, as a string or iolist
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Message{}} on success
{:error, info} on failure

gmail_users_messages_send_resumable(connection, user_id, upload_type, optional_params \\ [], opts \\ [])

@spec gmail_users_messages_send_resumable(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Sends the specified message to the recipients in the To, Cc, and Bcc headers. For example usage, see Sending email.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
upload_type (type: String.t) - Upload type. Must be "resumable".
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.Message.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

gmail_users_messages_send_simple(connection, user_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

@spec gmail_users_messages_send_simple(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  GoogleApi.Gmail.V1.Model.Message.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Message.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Sends the specified message to the recipients in the To, Cc, and Bcc headers. For example usage, see Sending email.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
upload_type (type: String.t) - Upload type. Must be "multipart".
metadata (type: GoogleApi.Gmail.V1.Model.Message.t) - object metadata
data (type: String.t) - Path to file containing content to upload
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Message{}} on success
{:error, info} on failure

gmail_users_messages_trash(connection, user_id, id, optional_params \\ [], opts \\ [])

@spec gmail_users_messages_trash(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Message.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Moves the specified message to the trash.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
id (type: String.t) - The ID of the message to Trash.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Message{}} on success
{:error, info} on failure

gmail_users_messages_untrash(connection, user_id, id, optional_params \\ [], opts \\ [])

@spec gmail_users_messages_untrash(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Message.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Removes the specified message from the trash.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
id (type: String.t) - The ID of the message to remove from Trash.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Message{}} on success
{:error, info} on failure

gmail_users_settings_cse_identities_create(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_cse_identities_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.CseIdentity.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The requester's primary email address. To indicate the authenticated user, you can use the special value me.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.CseIdentity.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.CseIdentity{}} on success
{:error, info} on failure

gmail_users_settings_cse_identities_delete(connection, user_id, cse_email_address, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_cse_identities_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The requester's primary email address. To indicate the authenticated user, you can use the special value me.
cse_email_address (type: String.t) - The primary email address associated with the client-side encryption identity configuration that's removed.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

gmail_users_settings_cse_identities_get(connection, user_id, cse_email_address, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_cse_identities_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.CseIdentity.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a client-side encryption identity configuration.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The requester's primary email address. To indicate the authenticated user, you can use the special value me.
cse_email_address (type: String.t) - The primary email address associated with the client-side encryption identity configuration that's retrieved.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.CseIdentity{}} on success
{:error, info} on failure

gmail_users_settings_cse_identities_list(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_cse_identities_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.ListCseIdentitiesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the client-side encrypted identities for an authenticated user.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The requester's primary email address. To indicate the authenticated user, you can use the special value me.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :pageSize (type: integer()) - The number of identities to return. If not provided, the page size will default to 20 entries.
- :pageToken (type: String.t) - Pagination token indicating which page of identities to return. If the token is not supplied, then the API will return the first page of results.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.ListCseIdentitiesResponse{}} on success
{:error, info} on failure

gmail_users_settings_cse_identities_patch(connection, user_id, email_address, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_cse_identities_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.CseIdentity.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Associates a different key pair with an existing client-side encryption identity. The updated key pair must validate against Google's S/MIME certificate profiles.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The requester's primary email address. To indicate the authenticated user, you can use the special value me.
email_address (type: String.t) - The email address of the client-side encryption identity to update.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.CseIdentity.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.CseIdentity{}} on success
{:error, info} on failure

gmail_users_settings_cse_keypairs_create(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_cse_keypairs_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.CseKeyPair.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata for the authenticated user.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The requester's primary email address. To indicate the authenticated user, you can use the special value me.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.CseKeyPair.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.CseKeyPair{}} on success
{:error, info} on failure

gmail_users_settings_cse_keypairs_disable(connection, user_id, key_pair_id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_cse_keypairs_disable(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.CseKeyPair.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The requester's primary email address. To indicate the authenticated user, you can use the special value me.
key_pair_id (type: String.t) - The identifier of the key pair to turn off.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.DisableCseKeyPairRequest.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.CseKeyPair{}} on success
{:error, info} on failure

gmail_users_settings_cse_keypairs_enable(connection, user_id, key_pair_id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_cse_keypairs_enable(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.CseKeyPair.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Turns on a client-side encryption key pair that was turned off. The key pair becomes active again for any associated client-side encryption identities.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The requester's primary email address. To indicate the authenticated user, you can use the special value me.
key_pair_id (type: String.t) - The identifier of the key pair to turn on.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.EnableCseKeyPairRequest.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.CseKeyPair{}} on success
{:error, info} on failure

gmail_users_settings_cse_keypairs_get(connection, user_id, key_pair_id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_cse_keypairs_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.CseKeyPair.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves an existing client-side encryption key pair.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The requester's primary email address. To indicate the authenticated user, you can use the special value me.
key_pair_id (type: String.t) - The identifier of the key pair to retrieve.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.CseKeyPair{}} on success
{:error, info} on failure

gmail_users_settings_cse_keypairs_list(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_cse_keypairs_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.ListCseKeyPairsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists client-side encryption key pairs for an authenticated user.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The requester's primary email address. To indicate the authenticated user, you can use the special value me.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :pageSize (type: integer()) - The number of key pairs to return. If not provided, the page size will default to 20 entries.
- :pageToken (type: String.t) - Pagination token indicating which page of key pairs to return. If the token is not supplied, then the API will return the first page of results.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.ListCseKeyPairsResponse{}} on success
{:error, info} on failure

gmail_users_settings_cse_keypairs_obliterate(connection, user_id, key_pair_id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_cse_keypairs_obliterate(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The requester's primary email address. To indicate the authenticated user, you can use the special value me.
key_pair_id (type: String.t) - The identifier of the key pair to obliterate.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.ObliterateCseKeyPairRequest.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

gmail_users_settings_delegates_create(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_delegates_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Delegate.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.Delegate.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Delegate{}} on success
{:error, info} on failure

gmail_users_settings_delegates_delete(connection, user_id, delegate_email, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_delegates_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
delegate_email (type: String.t) - The email address of the user to be removed as a delegate.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

gmail_users_settings_delegates_get(connection, user_id, delegate_email, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_delegates_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Delegate.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
delegate_email (type: String.t) - The email address of the user whose delegate relationship is to be retrieved.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Delegate{}} on success
{:error, info} on failure

gmail_users_settings_delegates_list(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_delegates_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.ListDelegatesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the delegates for the specified account. This method is only available to service account clients that have been delegated domain-wide authority.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.ListDelegatesResponse{}} on success
{:error, info} on failure

gmail_users_settings_filters_create(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_filters_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Filter.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a filter. Note: you can only create a maximum of 1,000 filters.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.Filter.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Filter{}} on success
{:error, info} on failure

gmail_users_settings_filters_delete(connection, user_id, id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_filters_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Immediately and permanently deletes the specified filter.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
id (type: String.t) - The ID of the filter to be deleted.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

gmail_users_settings_filters_get(connection, user_id, id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_filters_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Filter.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a filter.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
id (type: String.t) - The ID of the filter to be fetched.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Filter{}} on success
{:error, info} on failure

gmail_users_settings_filters_list(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_filters_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.ListFiltersResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the message filters of a Gmail user.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.ListFiltersResponse{}} on success
{:error, info} on failure

gmail_users_settings_forwarding_addresses_create(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_forwarding_addresses_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.ForwardingAddress.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.ForwardingAddress.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.ForwardingAddress{}} on success
{:error, info} on failure

gmail_users_settings_forwarding_addresses_delete(connection, user_id, forwarding_email, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_forwarding_addresses_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
forwarding_email (type: String.t) - The forwarding address to be deleted.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

gmail_users_settings_forwarding_addresses_get(connection, user_id, forwarding_email, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_forwarding_addresses_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.ForwardingAddress.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the specified forwarding address.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
forwarding_email (type: String.t) - The forwarding address to be retrieved.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.ForwardingAddress{}} on success
{:error, info} on failure

gmail_users_settings_forwarding_addresses_list(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_forwarding_addresses_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.ListForwardingAddressesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the forwarding addresses for the specified account.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.ListForwardingAddressesResponse{}} on success
{:error, info} on failure

gmail_users_settings_get_auto_forwarding(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_get_auto_forwarding(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.AutoForwarding.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the auto-forwarding setting for the specified account.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.AutoForwarding{}} on success
{:error, info} on failure

gmail_users_settings_get_imap(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_get_imap(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.ImapSettings.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets IMAP settings.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.ImapSettings{}} on success
{:error, info} on failure

gmail_users_settings_get_language(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_get_language(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.LanguageSettings.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets language settings.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.LanguageSettings{}} on success
{:error, info} on failure

gmail_users_settings_get_pop(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_get_pop(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.PopSettings.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets POP settings.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.PopSettings{}} on success
{:error, info} on failure

gmail_users_settings_get_vacation(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_get_vacation(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.VacationSettings.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets vacation responder settings.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.VacationSettings{}} on success
{:error, info} on failure

gmail_users_settings_send_as_create(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_send_as_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.SendAs.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.SendAs.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.SendAs{}} on success
{:error, info} on failure

gmail_users_settings_send_as_delete(connection, user_id, send_as_email, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_send_as_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
send_as_email (type: String.t) - The send-as alias to be deleted.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

gmail_users_settings_send_as_get(connection, user_id, send_as_email, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_send_as_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.SendAs.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
send_as_email (type: String.t) - The send-as alias to be retrieved.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.SendAs{}} on success
{:error, info} on failure

gmail_users_settings_send_as_list(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_send_as_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.ListSendAsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.ListSendAsResponse{}} on success
{:error, info} on failure

gmail_users_settings_send_as_patch(connection, user_id, send_as_email, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_send_as_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.SendAs.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Patch the specified send-as alias.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
send_as_email (type: String.t) - The send-as alias to be updated.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.SendAs.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.SendAs{}} on success
{:error, info} on failure

gmail_users_settings_send_as_smime_info_delete(connection, user_id, send_as_email, id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_send_as_smime_info_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Deletes the specified S/MIME config for the specified send-as alias.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
send_as_email (type: String.t) - The email address that appears in the "From:" header for mail sent using this alias.
id (type: String.t) - The immutable ID for the SmimeInfo.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

gmail_users_settings_send_as_smime_info_get(connection, user_id, send_as_email, id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_send_as_smime_info_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.SmimeInfo.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the specified S/MIME config for the specified send-as alias.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
send_as_email (type: String.t) - The email address that appears in the "From:" header for mail sent using this alias.
id (type: String.t) - The immutable ID for the SmimeInfo.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.SmimeInfo{}} on success
{:error, info} on failure

gmail_users_settings_send_as_smime_info_insert(connection, user_id, send_as_email, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_send_as_smime_info_insert(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.SmimeInfo.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Insert (upload) the given S/MIME config for the specified send-as alias. Note that pkcs12 format is required for the key.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
send_as_email (type: String.t) - The email address that appears in the "From:" header for mail sent using this alias.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.SmimeInfo.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.SmimeInfo{}} on success
{:error, info} on failure

gmail_users_settings_send_as_smime_info_list(connection, user_id, send_as_email, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_send_as_smime_info_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.ListSmimeInfoResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists S/MIME configs for the specified send-as alias.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
send_as_email (type: String.t) - The email address that appears in the "From:" header for mail sent using this alias.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.ListSmimeInfoResponse{}} on success
{:error, info} on failure

gmail_users_settings_send_as_smime_info_set_default(connection, user_id, send_as_email, id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_send_as_smime_info_set_default(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Sets the default S/MIME config for the specified send-as alias.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
send_as_email (type: String.t) - The email address that appears in the "From:" header for mail sent using this alias.
id (type: String.t) - The immutable ID for the SmimeInfo.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

gmail_users_settings_send_as_update(connection, user_id, send_as_email, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_send_as_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.SendAs.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
send_as_email (type: String.t) - The send-as alias to be updated.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.SendAs.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.SendAs{}} on success
{:error, info} on failure

gmail_users_settings_send_as_verify(connection, user_id, send_as_email, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_send_as_verify(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
send_as_email (type: String.t) - The send-as alias to be verified.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

gmail_users_settings_update_auto_forwarding(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_update_auto_forwarding(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.AutoForwarding.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.AutoForwarding.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.AutoForwarding{}} on success
{:error, info} on failure

gmail_users_settings_update_imap(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_update_imap(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.ImapSettings.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates IMAP settings.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.ImapSettings.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.ImapSettings{}} on success
{:error, info} on failure

gmail_users_settings_update_language(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_update_language(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.LanguageSettings.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.LanguageSettings.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.LanguageSettings{}} on success
{:error, info} on failure

gmail_users_settings_update_pop(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_update_pop(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.PopSettings.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates POP settings.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.PopSettings.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.PopSettings{}} on success
{:error, info} on failure

gmail_users_settings_update_vacation(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_settings_update_vacation(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.VacationSettings.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates vacation responder settings.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - User's email address. The special value "me" can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.VacationSettings.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.VacationSettings{}} on success
{:error, info} on failure

gmail_users_stop(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_stop(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Stop receiving push notifications for the given user mailbox.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

gmail_users_threads_delete(connection, user_id, id, optional_params \\ [], opts \\ [])

@spec gmail_users_threads_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Immediately and permanently deletes the specified thread. Any messages that belong to the thread are also deleted. This operation cannot be undone. Prefer threads.trash instead.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
id (type: String.t) - ID of the Thread to delete.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

gmail_users_threads_get(connection, user_id, id, optional_params \\ [], opts \\ [])

@spec gmail_users_threads_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Thread.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the specified thread.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
id (type: String.t) - The ID of the thread to retrieve.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :format (type: String.t) - The format to return the messages in.
- :metadataHeaders (type: list(String.t)) - When given and format is METADATA, only include headers specified.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Thread{}} on success
{:error, info} on failure

gmail_users_threads_list(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_threads_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Gmail.V1.Model.ListThreadsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the threads in the user's mailbox.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :includeSpamTrash (type: boolean()) - Include threads from SPAM and TRASH in the results.
- :labelIds (type: list(String.t)) - Only return threads with labels that match all of the specified label IDs.
- :maxResults (type: integer()) - Maximum number of threads to return. This field defaults to 100. The maximum allowed value for this field is 500.
- :pageToken (type: String.t) - Page token to retrieve a specific page of results in the list.
- :q (type: String.t) - 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.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.ListThreadsResponse{}} on success
{:error, info} on failure

gmail_users_threads_modify(connection, user_id, id, optional_params \\ [], opts \\ [])

@spec gmail_users_threads_modify(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Thread.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Modifies the labels applied to the thread. This applies to all messages in the thread.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
id (type: String.t) - The ID of the thread to modify.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.ModifyThreadRequest.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Thread{}} on success
{:error, info} on failure

gmail_users_threads_trash(connection, user_id, id, optional_params \\ [], opts \\ [])

@spec gmail_users_threads_trash(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Thread.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Moves the specified thread to the trash. Any messages that belong to the thread are also moved to the trash.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
id (type: String.t) - The ID of the thread to Trash.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Thread{}} on success
{:error, info} on failure

gmail_users_threads_untrash(connection, user_id, id, optional_params \\ [], opts \\ [])

@spec gmail_users_threads_untrash(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Gmail.V1.Model.Thread.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Removes the specified thread from the trash. Any messages that belong to the thread are also removed from the trash.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
id (type: String.t) - The ID of the thread to remove from Trash.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.Thread{}} on success
{:error, info} on failure

gmail_users_watch(connection, user_id, optional_params \\ [], opts \\ [])

@spec gmail_users_watch(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Gmail.V1.Model.WatchResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Set up or update a push notification watch on the given user mailbox.

Parameters

connection (type: GoogleApi.Gmail.V1.Connection.t) - Connection to server
user_id (type: String.t) - The user's email address. The special value me can be used to indicate the authenticated user.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Gmail.V1.Model.WatchRequest.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Gmail.V1.Model.WatchResponse{}} on success
{:error, info} on failure