gm_messages: Get a list of messages

Description Usage Arguments References See Also Examples

View source: R/message.R

Description

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

Usage

1
2
gm_messages(search = NULL, num_results = NULL, label_ids = NULL,
  include_spam_trash = NULL, page_token = NULL, user_id = "me")

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

page_token

retrieve a specific page of results

user_id

gmail user_id to access, special value of 'me' indicates the authenticated user.

References

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

See Also

Other message: gm_attachment, gm_delete_message, gm_import_message, gm_insert_message, gm_message, gm_modify_message, gm_save_attachments, gm_save_attachment, gm_send_message, gm_trash_message, gm_untrash_message

Examples

1
2
3
4
5
## Not run: 
#Search for R, return 10 results using label 1 including spam and trash folders
my_messages = gm_messages("R", 10, "label_1", TRUE)

## End(Not run)

gmailr documentation built on Aug. 23, 2019, 5:06 p.m.