GoogleApi.Gmail.V1.Api.Users.gmail_users_drafts_list
You're seeing just the function
gmail_users_drafts_list
, go back to GoogleApi.Gmail.V1.Api.Users module for more information.
Link to this function
gmail_users_drafts_list(connection, user_id, optional_params \\ [], opts \\ [])
View SourceSpecs
gmail_users_drafts_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Gmail.V1.Model.ListDraftsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the drafts in the user's mailbox.
Parameters
-
connection
(type:GoogleApi.Gmail.V1.Connection.t
) - Connection to server -
user_id
(type:String.t
) - The user's email address. The special valueme
can be used to indicate the authenticated user. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:includeSpamTrash
(type:boolean()
) - Include drafts fromSPAM
andTRASH
in the results. -
:maxResults
(type:integer()
) - Maximum number of drafts to return. -
:pageToken
(type:String.t
) - Page token to retrieve a specific page of results in the list. -
:q
(type:String.t
) - Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example,"from:someuser@example.com rfc822msgid: is:unread"
.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Gmail.V1.Model.ListDraftsResponse{}}
on success -
{:error, info}
on failure