happygapi.gmail.users — happygapi 0.4.7

Gmail API: users. The Gmail API lets you view and manage Gmail mailbox data like threads, messages, and labels. See: https://developers.google.com/gmail/api/api/reference/rest/v1/users

drafts-create$ clj

(drafts-create$ auth parameters body)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/drafts/create

Required parameters: userId

Optional parameters: none

Body:

{:message {:threadId string, :payload MessagePart, :historyId string, :raw string, :labelIds [string], :snippet string, :id string, :sizeEstimate integer, :internalDate string}, :id string}

Creates a new draft with the DRAFT label.

drafts-delete$ clj

(drafts-delete$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/drafts/delete

Required parameters: userId, id

Optional parameters: none

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

drafts-get$ clj

(drafts-get$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/drafts/get

Required parameters: userId, id

Optional parameters: format

Gets the specified draft.

drafts-list$ clj

(drafts-list$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/drafts/list

Required parameters: userId

Optional parameters: pageToken, maxResults, q, includeSpamTrash

Lists the drafts in the user's mailbox.

drafts-send$ clj

(drafts-send$ auth parameters body)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/drafts/send

Required parameters: userId

Optional parameters: none

Body:

{:message {:threadId string, :payload MessagePart, :historyId string, :raw string, :labelIds [string], :snippet string, :id string, :sizeEstimate integer, :internalDate string}, :id string}

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

drafts-update$ clj

(drafts-update$ auth parameters body)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/drafts/update

Required parameters: id, userId

Optional parameters: none

Body:

{:message {:threadId string, :payload MessagePart, :historyId string, :raw string, :labelIds [string], :snippet string, :id string, :sizeEstimate integer, :internalDate string}, :id string}

Replaces a draft's content.

getProfile$ clj

(getProfile$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/getProfile

Required parameters: userId

Optional parameters: none

Gets the current user's Gmail profile.

history-list$ clj

(history-list$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/history/list

Required parameters: userId

Optional parameters: pageToken, labelId, historyTypes, startHistoryId, maxResults

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

labels-create$ clj

(labels-create$ auth parameters body)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/labels/create

Required parameters: userId

Optional parameters: none

Body:

{:threadsUnread integer, :threadsTotal integer, :messagesTotal integer, :labelListVisibility string, :color {:textColor string, :backgroundColor string}, :messagesUnread integer, :name string, :messageListVisibility string, :type string, :id string}

Creates a new label.

labels-delete$ clj

(labels-delete$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/labels/delete

Required parameters: id, userId

Optional parameters: none

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

labels-get$ clj

(labels-get$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/labels/get

Required parameters: userId, id

Optional parameters: none

Gets the specified label.

labels-list$ clj

(labels-list$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/labels/list

Required parameters: userId

Optional parameters: none

Lists all labels in the user's mailbox.

labels-patch$ clj

(labels-patch$ auth parameters body)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/labels/patch

Required parameters: userId, id

Optional parameters: none

Body:

{:threadsUnread integer, :threadsTotal integer, :messagesTotal integer, :labelListVisibility string, :color {:textColor string, :backgroundColor string}, :messagesUnread integer, :name string, :messageListVisibility string, :type string, :id string}

Patch the specified label.

labels-update$ clj

(labels-update$ auth parameters body)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/labels/update

Required parameters: userId, id

Optional parameters: none

Body:

{:threadsUnread integer, :threadsTotal integer, :messagesTotal integer, :labelListVisibility string, :color {:textColor string, :backgroundColor string}, :messagesUnread integer, :name string, :messageListVisibility string, :type string, :id string}

Updates the specified label.

messages-attachments-get$ clj

(messages-attachments-get$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/messages/attachments/get

Required parameters: userId, id, messageId

Optional parameters: none

Gets the specified message attachment.

messages-batchDelete$ clj

(messages-batchDelete$ auth parameters body)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/messages/batchDelete

Required parameters: userId

Optional parameters: none

Body:

{:ids [string]}

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

messages-batchModify$ clj

(messages-batchModify$ auth parameters body)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/messages/batchModify

Required parameters: userId

Optional parameters: none

Body:

{:removeLabelIds [string], :addLabelIds [string], :ids [string]}

Modifies the labels on the specified messages.

messages-delete$ clj

(messages-delete$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/messages/delete

Required parameters: userId, id

Optional parameters: none

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

messages-get$ clj

(messages-get$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/messages/get

Required parameters: id, userId

Optional parameters: metadataHeaders, format

Gets the specified message.

messages-import$ clj

(messages-import$ auth parameters body)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/messages/import

Required parameters: userId

Optional parameters: internalDateSource, processForCalendar, deleted, neverMarkSpam

Body:

{:threadId string, :payload {:mimeType string, :body MessagePartBody, :filename string, :parts [MessagePart], :partId string, :headers [MessagePartHeader]}, :historyId string, :raw string, :labelIds [string], :snippet string, :id string, :sizeEstimate integer, :internalDate string}

Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message. Note: This function doesn't trigger forwarding rules or filters set up by the user.

messages-insert$ clj

(messages-insert$ auth parameters body)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/messages/insert

Required parameters: userId

Optional parameters: deleted, internalDateSource

Body:

{:threadId string, :payload {:mimeType string, :body MessagePartBody, :filename string, :parts [MessagePart], :partId string, :headers [MessagePartHeader]}, :historyId string, :raw string, :labelIds [string], :snippet string, :id string, :sizeEstimate integer, :internalDate string}

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

messages-list$ clj

(messages-list$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/messages/list

Required parameters: userId

Optional parameters: includeSpamTrash, pageToken, q, labelIds, maxResults

Lists the messages in the user's mailbox.

messages-modify$ clj

(messages-modify$ auth parameters body)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/messages/modify

Required parameters: userId, id

Optional parameters: none

Body:

{:removeLabelIds [string], :addLabelIds [string]}

Modifies the labels on the specified message.

messages-send$ clj

(messages-send$ auth parameters body)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/messages/send

Required parameters: userId

Optional parameters: none

Body:

{:threadId string, :payload {:mimeType string, :body MessagePartBody, :filename string, :parts [MessagePart], :partId string, :headers [MessagePartHeader]}, :historyId string, :raw string, :labelIds [string], :snippet string, :id string, :sizeEstimate integer, :internalDate string}

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

messages-trash$ clj

(messages-trash$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/messages/trash

Required parameters: id, userId

Optional parameters: none

Moves the specified message to the trash.

messages-untrash$ clj

(messages-untrash$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/messages/untrash

Required parameters: id, userId

Optional parameters: none

Removes the specified message from the trash.

settings-delegates-create$ clj

(settings-delegates-create$ auth parameters body)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/delegates/create

Required parameters: userId

Optional parameters: none

Body:

{:verificationStatus string, :delegateEmail string}

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 G Suite organization as the delegator user. Gmail imposes limitations on the number of delegates and delegators each user in a G Suite 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.

settings-delegates-delete$ clj

(settings-delegates-delete$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/delegates/delete

Required parameters: userId, delegateEmail

Optional parameters: none

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.

settings-delegates-get$ clj

(settings-delegates-get$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/delegates/get

Required parameters: userId, delegateEmail

Optional parameters: none

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.

settings-delegates-list$ clj

(settings-delegates-list$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/delegates/list

Required parameters: userId

Optional parameters: none

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

settings-filters-create$ clj

(settings-filters-create$ auth parameters body)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/filters/create

Required parameters: userId

Optional parameters: none

Body:

{:criteria {:excludeChats boolean, :hasAttachment boolean, :sizeComparison string, :size integer, :negatedQuery string, :from string, :query string, :subject string, :to string}, :id string, :action {:addLabelIds [string], :removeLabelIds [string], :forward string}}

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

settings-filters-delete$ clj

(settings-filters-delete$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/filters/delete

Required parameters: userId, id

Optional parameters: none

Deletes a filter.

settings-filters-get$ clj

(settings-filters-get$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/filters/get

Required parameters: id, userId

Optional parameters: none

Gets a filter.

settings-filters-list$ clj

(settings-filters-list$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/filters/list

Required parameters: userId

Optional parameters: none

Lists the message filters of a Gmail user.

settings-forwardingAddresses-create$ clj

(settings-forwardingAddresses-create$ auth parameters body)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/forwardingAddresses/create

Required parameters: userId

Optional parameters: none

Body:

{:forwardingEmail string, :verificationStatus string}

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.

settings-forwardingAddresses-delete$ clj

(settings-forwardingAddresses-delete$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/forwardingAddresses/delete

Required parameters: userId, forwardingEmail

Optional parameters: none

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.

settings-forwardingAddresses-get$ clj

(settings-forwardingAddresses-get$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/forwardingAddresses/get

Required parameters: userId, forwardingEmail

Optional parameters: none

Gets the specified forwarding address.

settings-forwardingAddresses-list$ clj

(settings-forwardingAddresses-list$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/forwardingAddresses/list

Required parameters: userId

Optional parameters: none

Lists the forwarding addresses for the specified account.

settings-getAutoForwarding$ clj

(settings-getAutoForwarding$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/getAutoForwarding

Required parameters: userId

Optional parameters: none

Gets the auto-forwarding setting for the specified account.

settings-getImap$ clj

(settings-getImap$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/getImap

Required parameters: userId

Optional parameters: none

Gets IMAP settings.

settings-getLanguage$ clj

(settings-getLanguage$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/getLanguage

Required parameters: userId

Optional parameters: none

Gets language settings.

settings-getPop$ clj

(settings-getPop$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/getPop

Required parameters: userId

Optional parameters: none

Gets POP settings.

settings-getVacation$ clj

(settings-getVacation$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/getVacation

Required parameters: userId

Optional parameters: none

Gets vacation responder settings.

settings-sendAs-create$ clj

(settings-sendAs-create$ auth parameters body)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/sendAs/create

Required parameters: userId

Optional parameters: none

Body:

{:treatAsAlias boolean, :isDefault boolean, :displayName string, :isPrimary boolean, :signature string, :sendAsEmail string, :verificationStatus string, :replyToAddress string, :smtpMsa {:username string, :port integer, :securityMode string, :host string, :password string}}

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.

settings-sendAs-delete$ clj

(settings-sendAs-delete$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/sendAs/delete

Required parameters: sendAsEmail, userId

Optional parameters: none

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.

settings-sendAs-get$ clj

(settings-sendAs-get$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/sendAs/get

Required parameters: sendAsEmail, userId

Optional parameters: none

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

settings-sendAs-list$ clj

(settings-sendAs-list$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/sendAs/list

Required parameters: userId

Optional parameters: none

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.

settings-sendAs-patch$ clj

(settings-sendAs-patch$ auth parameters body)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/sendAs/patch

Required parameters: userId, sendAsEmail

Optional parameters: none

Body:

{:treatAsAlias boolean, :isDefault boolean, :displayName string, :isPrimary boolean, :signature string, :sendAsEmail string, :verificationStatus string, :replyToAddress string, :smtpMsa {:username string, :port integer, :securityMode string, :host string, :password string}}

Patch the specified send-as alias.

settings-sendAs-smimeInfo-delete$ clj

(settings-sendAs-smimeInfo-delete$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/sendAs/smimeInfo/delete

Required parameters: sendAsEmail, id, userId

Optional parameters: none

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

settings-sendAs-smimeInfo-get$ clj

(settings-sendAs-smimeInfo-get$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/sendAs/smimeInfo/get

Required parameters: sendAsEmail, id, userId

Optional parameters: none

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

settings-sendAs-smimeInfo-insert$ clj

(settings-sendAs-smimeInfo-insert$ auth parameters body)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/sendAs/smimeInfo/insert

Required parameters: sendAsEmail, userId

Optional parameters: none

Body:

{:pkcs12 string, :issuerCn string, :encryptedKeyPassword string, :pem string, :expiration string, :isDefault boolean, :id string}

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

settings-sendAs-smimeInfo-list$ clj

(settings-sendAs-smimeInfo-list$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/sendAs/smimeInfo/list

Required parameters: sendAsEmail, userId

Optional parameters: none

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

settings-sendAs-smimeInfo-setDefault$ clj

(settings-sendAs-smimeInfo-setDefault$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/sendAs/smimeInfo/setDefault

Required parameters: userId, id, sendAsEmail

Optional parameters: none

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

settings-sendAs-update$ clj

(settings-sendAs-update$ auth parameters body)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/sendAs/update

Required parameters: userId, sendAsEmail

Optional parameters: none

Body:

{:treatAsAlias boolean, :isDefault boolean, :displayName string, :isPrimary boolean, :signature string, :sendAsEmail string, :verificationStatus string, :replyToAddress string, :smtpMsa {:username string, :port integer, :securityMode string, :host string, :password string}}

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.

settings-sendAs-verify$ clj

(settings-sendAs-verify$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/sendAs/verify

Required parameters: userId, sendAsEmail

Optional parameters: none

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.

settings-updateAutoForwarding$ clj

(settings-updateAutoForwarding$ auth parameters body)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/updateAutoForwarding

Required parameters: userId

Optional parameters: none

Body:

{:disposition string, :enabled boolean, :emailAddress string}

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.

settings-updateImap$ clj

(settings-updateImap$ auth parameters body)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/updateImap

Required parameters: userId

Optional parameters: none

Body:

{:expungeBehavior string, :autoExpunge boolean, :maxFolderSize integer, :enabled boolean}

Updates IMAP settings.

settings-updateLanguage$ clj

(settings-updateLanguage$ auth parameters body)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/updateLanguage

Required parameters: userId

Optional parameters: none

Body:

{:displayLanguage string}

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.

settings-updatePop$ clj

(settings-updatePop$ auth parameters body)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/updatePop

Required parameters: userId

Optional parameters: none

Body:

{:accessWindow string, :disposition string}

Updates POP settings.

settings-updateVacation$ clj

(settings-updateVacation$ auth parameters body)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/settings/updateVacation

Required parameters: userId

Optional parameters: none

Body:

{:restrictToContacts boolean, :responseSubject string, :responseBodyPlainText string, :endTime string, :enableAutoReply boolean, :restrictToDomain boolean, :startTime string, :responseBodyHtml string}

Updates vacation responder settings.

stop$ clj

(stop$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/stop

Required parameters: userId

Optional parameters: none

Stop receiving push notifications for the given user mailbox.

threads-delete$ clj

(threads-delete$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/threads/delete

Required parameters: id, userId

Optional parameters: none

Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer threads.trash instead.

threads-get$ clj

(threads-get$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/threads/get

Required parameters: userId, id

Optional parameters: metadataHeaders, format

Gets the specified thread.

threads-list$ clj

(threads-list$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/threads/list

Required parameters: userId

Optional parameters: q, pageToken, labelIds, maxResults, includeSpamTrash

Lists the threads in the user's mailbox.

threads-modify$ clj

(threads-modify$ auth parameters body)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/threads/modify

Required parameters: id, userId

Optional parameters: none

Body:

{:removeLabelIds [string], :addLabelIds [string]}

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

threads-trash$ clj

(threads-trash$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/threads/trash

Required parameters: userId, id

Optional parameters: none

Moves the specified thread to the trash.

threads-untrash$ clj

(threads-untrash$ auth parameters)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/threads/untrash

Required parameters: userId, id

Optional parameters: none

Removes the specified thread from the trash.

watch$ clj

(watch$ auth parameters body)

https://developers.google.com/gmail/api/api/reference/rest/v1/users/watch

Required parameters: userId

Optional parameters: none

Body:

{:topicName string, :labelFilterAction string, :labelIds [string]}

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