gmail v0.1.17 Gmail.Thread

A collection of messages representing a conversation.

Summary

Functions

Gmail API documentation: https://developers.google.com/gmail/api/v1/reference/users/threads#resource

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

Gets the specified thread

Handles a thread delete response from the Gmail API

Handles a thread list response from the Gmail API

Handles a thread resource response from the Gmail API

Lists the threads in the user’s mailbox

Searches for threads in the user’s mailbox

Moves the specified thread to the trash

Removes the specified thread from the trash

Types

t()
t() :: %Gmail.Thread{history_id: term, id: term, messages: term, snippet: term}

Functions

__struct__()

Gmail API documentation: https://developers.google.com/gmail/api/v1/reference/users/threads#resource

delete(user_id, thread_id)
delete(String.t, String.t) :: {atom, String.t, String.t}

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

Gmail API documentation: https://developers.google.com/gmail/api/v1/reference/users/threads/delete

get(user_id, thread_id, params)
get(String.t, String.t, map) :: {atom, String.t, String.t}

Gets the specified thread.

Gmail API documentation: https://developers.google.com/gmail/api/v1/reference/users/threads/get

handle_thread_delete_response(response)
handle_thread_delete_response({atom, map}) ::
  {atom, String.t | map} |
  {atom, map, String.t} |
  atom
handle_thread_delete_response({atom, String.t}) ::
  {atom, String.t | map} |
  {atom, map, String.t} |
  atom

Handles a thread delete response from the Gmail API.

handle_thread_list_response(response)
handle_thread_list_response(atom | {atom, map | String.t}) ::
  {atom, String.t | map} |
  {atom, map, String.t}

Handles a thread list response from the Gmail API.

handle_thread_response(response)
handle_thread_response({atom, String.t}) ::
  {atom, String.t} |
  {atom, map}
handle_thread_response({atom, map}) ::
  {atom, String.t} |
  {atom, map}

Handles a thread resource response from the Gmail API.

list(user_id, params)
list(String.t, map) :: {atom, String.t, String.t}

Lists the threads in the user’s mailbox.

Gmail API documentation: https://developers.google.com/gmail/api/v1/reference/users/threads/list

search(user_id, query, params)
search(String.t, String.t, map) :: {atom, String.t, String.t}

Searches for threads in the user’s mailbox.

Gmail API documentation: https://developers.google.com/gmail/api/v1/reference/users/threads/list

trash(user_id, thread_id)
trash(String.t, String.t) :: {atom, String.t, String.t}

Moves the specified thread to the trash.

Gmail API documentation: https://developers.google.com/gmail/api/v1/reference/users/threads/trash

untrash(user_id, thread_id)
untrash(String.t, String.t) :: {atom, String.t, String.t}

Removes the specified thread from the trash.

Gmail API documentation: https://developers.google.com/gmail/api/v1/reference/users/threads/untrash