gm_threads: Get a list of threads

In r-lib/gmailr: Access the 'Gmail' 'RESTful' API

Get a list of threads

Description

Get a list of threads possibly matching a given query string.

Usage

gm_threads(
  search = NULL,
  num_results = NULL,
  page_token = NULL,
  label_ids = NULL,
  include_spam_trash = NULL,
  user_id = "me"
)

Arguments

search	query to use, same format as gmail search box.
num_results	the number of results to return.
page_token	retrieve a specific page of results
label_ids	restrict search to given labels
include_spam_trash	boolean whether to include the spam and trash folders in the search
user_id	gmail user_id to access, special value of 'me' indicates the authenticated user.

References

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

See Also

Other thread: gm_delete_thread(), gm_modify_thread(), gm_thread(), gm_trash_thread(), gm_untrash_thread()

Examples

## Not run: 
my_threads <- gm_threads()

first_10_threads <- gm_threads(10)

## End(Not run)

r-lib/gmailr documentation built on Nov. 5, 2023, 6:22 a.m.