com.mulesoft.connectors.internal.operation

Class GmailusersdraftslistOperation

java.lang.Object

com.mulesoft.connectivity.rest.commons.api.operation.BaseRestOperation

com.mulesoft.connectors.internal.operation.GmailusersdraftslistOperation

public class GmailusersdraftslistOperation
extends com.mulesoft.connectivity.rest.commons.api.operation.BaseRestOperation

Constructor Summary

Constructors

Constructor and Description
GmailusersdraftslistOperation()

Method Summary

Modifier and Type

Method and Description

void

gmailusersdraftslist(com.mulesoft.connectivity.rest.commons.api.configuration.RestConfiguration config, com.mulesoft.connectivity.rest.commons.api.connection.RestConnection connection, String userIdUriParam, Integer maxResultsQueryParam, String pageTokenQueryParam, String qQueryParam, boolean includeSpamTrashQueryParam, com.mulesoft.connectivity.rest.commons.api.operation.NonEntityRequestParameters parameters, com.mulesoft.connectivity.rest.commons.api.operation.ConfigurationOverrides overrides, org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper, org.mule.runtime.extension.api.runtime.process.CompletionCallback<InputStream,com.mulesoft.connectivity.rest.commons.api.operation.HttpResponseAttributes> callback) Lists the drafts in the user's mailbox.

Methods inherited from class com.mulesoft.connectivity.rest.commons.api.operation.BaseRestOperation

addParameterToBindingContext, doRequest, doVoidRequest, getDefaultResponseMediaType, getExpressionLanguage, getRequestBindings, getRequestBodyDataType, getRequestBuilderWithBindings, getResponseBindings, resolveDefaultResponseMediaType, withMultipart

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GmailusersdraftslistOperation

public GmailusersdraftslistOperation()

Method Detail

gmailusersdraftslist

@Throws(value=com.mulesoft.connectivity.rest.commons.api.error.RequestErrorTypeProvider.class)
 @DisplayName(value="List Drafts")
 @Summary(value="Lists the drafts in the user\'s mailbox.")
 @MediaType(value="application/json")
 @OutputResolver(output=GmailusersdraftslistOutputMetadataResolver.class)
public void gmailusersdraftslist(@Config
                                                                                                                                                                                                                                                                                                                                               com.mulesoft.connectivity.rest.commons.api.configuration.RestConfiguration config,
                                                                                                                                                                                                                                                                                                                                               @Connection
                                                                                                                                                                                                                                                                                                                                               com.mulesoft.connectivity.rest.commons.api.connection.RestConnection connection,
                                                                                                                                                                                                                                                                                                                                               @DisplayName(value="User Id") @Summary(value="The user\'s email address. The special value `me` can be used to indicate the authenticated user.")
                                                                                                                                                                                                                                                                                                                                               String userIdUriParam,
                                                                                                                                                                                                                                                                                                                                               @Optional @DisplayName(value="Max Results") @Summary(value="Maximum number of drafts to return.")
                                                                                                                                                                                                                                                                                                                                               Integer maxResultsQueryParam,
                                                                                                                                                                                                                                                                                                                                               @Optional @DisplayName(value="Page Token") @Summary(value="Page token to retrieve a specific page of results in the list.")
                                                                                                                                                                                                                                                                                                                                               String pageTokenQueryParam,
                                                                                                                                                                                                                                                                                                                                               @Optional @DisplayName(value="Query") @Summary(value="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\"`.")
                                                                                                                                                                                                                                                                                                                                               String qQueryParam,
                                                                                                                                                                                                                                                                                                                                               @Optional @DisplayName(value="Include Spam Trash") @Summary(value="Include drafts from `SPAM` and `TRASH` in the results.")
                                                                                                                                                                                                                                                                                                                                               boolean includeSpamTrashQueryParam,
                                                                                                                                                                                                                                                                                                                                               @ParameterGroup(name="Request Parameters")
                                                                                                                                                                                                                                                                                                                                               com.mulesoft.connectivity.rest.commons.api.operation.NonEntityRequestParameters parameters,
                                                                                                                                                                                                                                                                                                                                               @ParameterGroup(name="Connector Overrides")
                                                                                                                                                                                                                                                                                                                                               com.mulesoft.connectivity.rest.commons.api.operation.ConfigurationOverrides overrides,
                                                                                                                                                                                                                                                                                                                                               org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper,
                                                                                                                                                                                                                                                                                                                                               org.mule.runtime.extension.api.runtime.process.CompletionCallback<InputStream,com.mulesoft.connectivity.rest.commons.api.operation.HttpResponseAttributes> callback)

Lists the drafts in the user's mailbox.

This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/drafts endpoint

Parameters:

config - the configuration to use

connection - the connection to use

userIdUriParam - The user's email address. The special value `me` can be used to indicate the authenticated user.

maxResultsQueryParam - Maximum number of drafts to return.

pageTokenQueryParam - Page token to retrieve a specific page of results in the list.

qQueryParam - 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"`.

includeSpamTrashQueryParam - Include drafts from `SPAM` and `TRASH` in the results.

parameters - the NonEntityRequestParameters

overrides - the ConfigurationOverrides

streamingHelper - the StreamingHelper

callback - the operation's CompletionCallback