gmailr (version 0.6.0)

messages: Get a list of messages

Description

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

Usage

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

Arguments

search

query to use, same format as gmail search box.

num_results

the number of results to return.

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.

page_token

retrieve a specific page of results

References

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

Examples

#Search for R, return 10 results using label 1 including spam and trash folders
my_messages = messages("R", 10, "label_1", TRUE)