This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel.git
commit 79755d09986a3413a7d693f959f4571eb5925465 Author: Claus Ibsen <[email protected]> AuthorDate: Mon Aug 30 11:08:57 2021 +0200 camel-google-mail - stream is not API based --- .../stream/GoogleMailStreamEndpointUriFactory.java | 10 +- .../google/mail/stream/google-mail-stream.json | 18 - .../main/docs/google-mail-stream-component.adoc | 529 --------------------- .../ROOT/pages/google-mail-stream-component.adoc | 529 --------------------- 4 files changed, 1 insertion(+), 1085 deletions(-) diff --git a/components/camel-google/camel-google-mail/src/generated/java/org/apache/camel/component/google/mail/stream/GoogleMailStreamEndpointUriFactory.java b/components/camel-google/camel-google-mail/src/generated/java/org/apache/camel/component/google/mail/stream/GoogleMailStreamEndpointUriFactory.java index 4922c38..d0d2554 100644 --- a/components/camel-google/camel-google-mail/src/generated/java/org/apache/camel/component/google/mail/stream/GoogleMailStreamEndpointUriFactory.java +++ b/components/camel-google/camel-google-mail/src/generated/java/org/apache/camel/component/google/mail/stream/GoogleMailStreamEndpointUriFactory.java @@ -20,24 +20,19 @@ public class GoogleMailStreamEndpointUriFactory extends org.apache.camel.support private static final Set<String> PROPERTY_NAMES; private static final Set<String> SECRET_PROPERTY_NAMES; static { - Set<String> props = new HashSet<>(37); + Set<String> props = new HashSet<>(29); props.add("backoffMultiplier"); props.add("initialDelay"); - props.add("content"); props.add("markAsRead"); props.add("scheduler"); - props.add("modifyMessageRequest"); props.add("bridgeErrorHandler"); props.add("useFixedDelay"); - props.add("mediaContent"); props.add("runLoggingLevel"); props.add("maxResults"); props.add("backoffErrorThreshold"); props.add("greedy"); props.add("clientSecret"); - props.add("id"); props.add("scheduledExecutorService"); - props.add("batchModifyMessagesRequest"); props.add("applicationName"); props.add("repeatCount"); props.add("timeUnit"); @@ -47,11 +42,8 @@ public class GoogleMailStreamEndpointUriFactory extends org.apache.camel.support props.add("schedulerProperties"); props.add("exchangePattern"); props.add("index"); - props.add("messageId"); props.add("accessToken"); - props.add("userId"); props.add("backoffIdleThreshold"); - props.add("batchDeleteMessagesRequest"); props.add("labels"); props.add("delay"); props.add("pollStrategy"); diff --git a/components/camel-google/camel-google-mail/src/generated/resources/org/apache/camel/component/google/mail/stream/google-mail-stream.json b/components/camel-google/camel-google-mail/src/generated/resources/org/apache/camel/component/google/mail/stream/google-mail-stream.json index 646d34d..d6bdaa1 100644 --- a/components/camel-google/camel-google-mail/src/generated/resources/org/apache/camel/component/google/mail/stream/google-mail-stream.json +++ b/components/camel-google/camel-google-mail/src/generated/resources/org/apache/camel/component/google/mail/stream/google-mail-stream.json @@ -66,23 +66,5 @@ "accessToken": { "kind": "parameter", "displayName": "Access Token", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration", "configurationField": "configuration", "description": "OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for l [...] "clientSecret": { "kind": "parameter", "displayName": "Client Secret", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration", "configurationField": "configuration", "description": "Client secret of the mail application" }, "refreshToken": { "kind": "parameter", "displayName": "Refresh Token", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration", "configurationField": "configuration", "description": "OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new accessToken [...] - }, - "apis": { - "attachments": { "consumerOnly": true, "producerOnly": false, "description": "The attachments collection of methods", "methods": { "get": { "description": "Gets the specified message attachment", "signatures": [ "com.google.api.services.gmail.Gmail$Users$Messages$Attachments$Get get(String userId, String messageId, String id)" ] } } }, - "drafts": { "consumerOnly": true, "producerOnly": false, "description": "The drafts collection of methods", "methods": { "create": { "description": "Creates a new draft with the DRAFT label", "signatures": [ "com.google.api.services.gmail.Gmail$Users$Drafts$Create create(String userId, com.google.api.services.gmail.model.Draft content)", "com.google.api.services.gmail.Gmail$Users$Drafts$Create create(String userId, com.google.api.services.gmail.model.Draft content, com.google.api.cli [...] - "history": { "consumerOnly": true, "producerOnly": false, "description": "The history collection of methods", "methods": { "list": { "description": "Lists the history of all changes to the given mailbox", "signatures": [ "com.google.api.services.gmail.Gmail$Users$History$List list(String userId)" ] } } }, - "labels": { "consumerOnly": true, "producerOnly": false, "description": "The labels collection of methods", "methods": { "create": { "description": "Creates a new label", "signatures": [ "com.google.api.services.gmail.Gmail$Users$Labels$Create create(String userId, com.google.api.services.gmail.model.Label content)" ] }, "delete": { "description": "Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to", "signatures" [...] - "messages": { "consumerOnly": true, "producerOnly": false, "description": "The messages collection of methods", "methods": { "batchDelete": { "description": "Deletes many messages by message ID", "signatures": [ "com.google.api.services.gmail.Gmail$Users$Messages$BatchDelete batchDelete(String userId, com.google.api.services.gmail.model.BatchDeleteMessagesRequest content)" ] }, "batchModify": { "description": "Modifies the labels on the specified messages", "signatures": [ "com.googl [...] - "threads": { "consumerOnly": true, "producerOnly": false, "description": "The threads collection of methods", "methods": { "delete": { "description": "Immediately and permanently deletes the specified thread", "signatures": [ "com.google.api.services.gmail.Gmail$Users$Threads$Delete delete(String userId, String id)" ] }, "get": { "description": "Gets the specified thread", "signatures": [ "com.google.api.services.gmail.Gmail$Users$Threads$Get get(String userId, String id)" ] }, "list [...] - "users": { "consumerOnly": true, "producerOnly": false, "description": "The users collection of methods", "methods": { "getProfile": { "description": "Gets the current user's Gmail profile", "signatures": [ "com.google.api.services.gmail.Gmail$Users$GetProfile getProfile(String userId)" ] }, "stop": { "description": "Stop receiving push notifications for the given user mailbox", "signatures": [ "com.google.api.services.gmail.Gmail$Users$Stop stop(String userId)" ] }, "watch": { "desc [...] - }, - "apiProperties": { - "attachments": { "methods": { "get": { "properties": { "id": { "kind": "parameter", "displayName": "Id", "group": "consumer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The ID of the attachment", "optional": false }, "messageId": { "kind": "parameter", "displayName": "Message Id", "group": "consumer", "label": "", "required": false, "type": "string", "javaType": "java.lang [...] - "drafts": { "methods": { "create": { "properties": { "content": { "kind": "parameter", "displayName": "Content", "group": "consumer", "label": "", "required": false, "type": "object", "javaType": "com.google.api.services.gmail.model.Draft", "deprecated": false, "autowired": false, "secret": false, "description": "The com.google.api.services.gmail.model.Draft media metadata or null if none", "optional": false }, "mediaContent": { "kind": "parameter", "displayName": "Media Content", "g [...] - "history": { "methods": { "list": { "properties": { "userId": { "kind": "parameter", "displayName": "User Id", "group": "consumer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The user's email address. The special value me can be used to indicate the authenticated user. default: me", "optional": false } } } } }, - "labels": { "methods": { "create": { "properties": { "content": { "kind": "parameter", "displayName": "Content", "group": "consumer", "label": "", "required": false, "type": "object", "javaType": "com.google.api.services.gmail.model.Label", "deprecated": false, "autowired": false, "secret": false, "description": "The com.google.api.services.gmail.model.Label", "optional": false }, "userId": { "kind": "parameter", "displayName": "User Id", "group": "consumer", "label": "", "required": [...] - "messages": { "methods": { "batchDelete": { "properties": { "batchDeleteMessagesRequest": { "kind": "parameter", "displayName": "Batch Delete Messages Request", "group": "consumer", "label": "", "required": false, "type": "object", "javaType": "com.google.api.services.gmail.model.BatchDeleteMessagesRequest", "deprecated": false, "autowired": false, "secret": false, "description": "The com.google.api.services.gmail.model.BatchDeleteMessagesRequest", "optional": false }, "userId": { "k [...] - "threads": { "methods": { "delete": { "properties": { "id": { "kind": "parameter", "displayName": "Id", "group": "consumer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "ID of the Thread to delete", "optional": false }, "userId": { "kind": "parameter", "displayName": "User Id", "group": "consumer", "label": "", "required": false, "type": "string", "javaType": "java.lang.Stri [...] - "users": { "methods": { "getProfile": { "properties": { "userId": { "kind": "parameter", "displayName": "User Id", "group": "consumer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The user's email address. The special value me can be used to indicate the authenticated user. default: me", "optional": false } } }, "stop": { "properties": { "userId": { "kind": "parameter", "di [...] } } diff --git a/components/camel-google/camel-google-mail/src/main/docs/google-mail-stream-component.adoc b/components/camel-google/camel-google-mail/src/main/docs/google-mail-stream-component.adoc index ca1e09a..448403e 100644 --- a/components/camel-google/camel-google-mail/src/main/docs/google-mail-stream-component.adoc +++ b/components/camel-google/camel-google-mail/src/main/docs/google-mail-stream-component.adoc @@ -169,535 +169,6 @@ with the following path and query parameters: | *clientSecret* (security) | Client secret of the mail application | | String | *refreshToken* (security) | OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived. | | String |=== - - - - -=== API Parameters (7 APIs): - -The Google Mail Stream endpoint is an API based component and has additional parameters based on which API name and API method is used. -The API name and API method is located in the endpoint URI as the null path parameters: - ----- -google-mail-stream:index ----- - -There are 7 API names as listed in the table below: - -[width="100%",cols="2,2,6",options="header"] -|=== -| API Name | Type | Description -| *attachments* | Consumer | The attachments collection of methods -| *drafts* | Consumer | The drafts collection of methods -| *history* | Consumer | The history collection of methods -| *labels* | Consumer | The labels collection of methods -| *messages* | Consumer | The messages collection of methods -| *threads* | Consumer | The threads collection of methods -| *users* | Consumer | The users collection of methods -|=== - -Each API is documented in the following sections to come. - - -==== API: attachments - -*Only consumer is supported* - - - - -The attachments API has 1 method(s) which is represented by the following method signatures -(an API method may have multiple signatures due to overloading): - -[source,java] ----- - -com.google.api.services.gmail.Gmail.Users.Messages.Attachments.Get get(String userId, String messageId, String id); - ----- - -The attachments API is defined in the syntax as follows: - ----- -google-mail-stream:attachments/methodName?[parameters] ----- - -The 1 method(s) is listed in the table below. -(API methods can have a shorthand alias name which can be used in the syntax instead of the name) - -[width="100%",cols="2,2,6",options="header"] -|=== -| Method | Alias | Description -| *get* | | Gets the specified message attachment -|=== - -The attachments API method(s) has the following set of parameters listed in the table below: -[width="100%",cols="2,2,4,2",options="header"] -|=== -| Method | Parameter | Description | Type -| get | *id* | The ID of the attachment | String -| get | *messageId* | The ID of the message containing the attachment | String -| get | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -|=== - -In addition to the parameters above, the attachments API can also use from the 28 endpoint query option -which is listed in the _Query Parameters_ section. - -Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. -The message header name must be of the format `CamelGoogleMailStream.parameter`. -The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere` -would override a `CamelGoogleMailStream.myParameterNameHere` header. - - - -==== API: drafts - -*Only consumer is supported* - - - - -The drafts API has 6 method(s) which is represented by the following method signatures -(an API method may have multiple signatures due to overloading): - -[source,java] ----- - -com.google.api.services.gmail.Gmail.Users.Drafts.Create create(String userId, com.google.api.services.gmail.model.Draft content); - -com.google.api.services.gmail.Gmail.Users.Drafts.Create create(String userId, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent); - -com.google.api.services.gmail.Gmail.Users.Drafts.Delete delete(String userId, String id); - -com.google.api.services.gmail.Gmail.Users.Drafts.Get get(String userId, String id); - -com.google.api.services.gmail.Gmail.Users.Drafts.List list(String userId); - -com.google.api.services.gmail.Gmail.Users.Drafts.Send send(String userId, com.google.api.services.gmail.model.Draft content); - -com.google.api.services.gmail.Gmail.Users.Drafts.Send send(String userId, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent); - -com.google.api.services.gmail.Gmail.Users.Drafts.Update update(String userId, String id, com.google.api.services.gmail.model.Draft content); - -com.google.api.services.gmail.Gmail.Users.Drafts.Update update(String userId, String id, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent); - ----- - -The drafts API is defined in the syntax as follows: - ----- -google-mail-stream:drafts/methodName?[parameters] ----- - -The 6 method(s) is listed in the table below. -(API methods can have a shorthand alias name which can be used in the syntax instead of the name) - -[width="100%",cols="2,2,6",options="header"] -|=== -| Method | Alias | Description -| *create* | | Creates a new draft with the DRAFT label -| *delete* | | Immediately and permanently deletes the specified draft -| *get* | | Gets the specified draft -| *list* | | Lists the drafts in the user's mailbox -| *send* | | Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers -| *update* | | Replaces a draft's content -|=== - -The drafts API method(s) has the following set of parameters listed in the table below: -[width="100%",cols="2,2,4,2",options="header"] -|=== -| Method | Parameter | Description | Type -| create | *content* | The com.google.api.services.gmail.model.Draft media metadata or null if none | Draft -| create | *mediaContent* | The media HTTP content or null if none | AbstractInputStreamContent -| create | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| delete | *id* | The ID of the draft to delete | String -| delete | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| get | *id* | The ID of the draft to retrieve | String -| get | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| list | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| send | *content* | The com.google.api.services.gmail.model.Draft media metadata or null if none | Draft -| send | *mediaContent* | The media HTTP content or null if none | AbstractInputStreamContent -| send | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| update | *content* | The com.google.api.services.gmail.model.Draft media metadata or null if none | Draft -| update | *id* | | String -| update | *mediaContent* | The media HTTP content or null if none | AbstractInputStreamContent -| update | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -|=== - -In addition to the parameters above, the drafts API can also use from the 28 endpoint query option -which is listed in the _Query Parameters_ section. - -Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. -The message header name must be of the format `CamelGoogleMailStream.parameter`. -The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere` -would override a `CamelGoogleMailStream.myParameterNameHere` header. - - - -==== API: history - -*Only consumer is supported* - - - - -The history API has 1 method(s) which is represented by the following method signatures -(an API method may have multiple signatures due to overloading): - -[source,java] ----- - -com.google.api.services.gmail.Gmail.Users.History.List list(String userId); - ----- - -The history API is defined in the syntax as follows: - ----- -google-mail-stream:history/methodName?[parameters] ----- - -The 1 method(s) is listed in the table below. -(API methods can have a shorthand alias name which can be used in the syntax instead of the name) - -[width="100%",cols="2,2,6",options="header"] -|=== -| Method | Alias | Description -| *list* | | Lists the history of all changes to the given mailbox -|=== - -The history API method(s) has the following set of parameters listed in the table below: -[width="100%",cols="2,2,4,2",options="header"] -|=== -| Method | Parameter | Description | Type -| list | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -|=== - -In addition to the parameters above, the history API can also use from the 28 endpoint query option -which is listed in the _Query Parameters_ section. - -Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. -The message header name must be of the format `CamelGoogleMailStream.parameter`. -The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere` -would override a `CamelGoogleMailStream.myParameterNameHere` header. - - - -==== API: labels - -*Only consumer is supported* - - - - -The labels API has 6 method(s) which is represented by the following method signatures -(an API method may have multiple signatures due to overloading): - -[source,java] ----- - -com.google.api.services.gmail.Gmail.Users.Labels.Create create(String userId, com.google.api.services.gmail.model.Label content); - -com.google.api.services.gmail.Gmail.Users.Labels.Delete delete(String userId, String id); - -com.google.api.services.gmail.Gmail.Users.Labels.Get get(String userId, String id); - -com.google.api.services.gmail.Gmail.Users.Labels.List list(String userId); - -com.google.api.services.gmail.Gmail.Users.Labels.Patch patch(String userId, String id, com.google.api.services.gmail.model.Label content); - -com.google.api.services.gmail.Gmail.Users.Labels.Update update(String userId, String id, com.google.api.services.gmail.model.Label content); - ----- - -The labels API is defined in the syntax as follows: - ----- -google-mail-stream:labels/methodName?[parameters] ----- - -The 6 method(s) is listed in the table below. -(API methods can have a shorthand alias name which can be used in the syntax instead of the name) - -[width="100%",cols="2,2,6",options="header"] -|=== -| Method | Alias | Description -| *create* | | Creates a new label -| *delete* | | Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to -| *get* | | Gets the specified label -| *list* | | Lists all labels in the user's mailbox -| *patch* | | Updates the specified label -| *update* | | Updates the specified label -|=== - -The labels API method(s) has the following set of parameters listed in the table below: -[width="100%",cols="2,2,4,2",options="header"] -|=== -| Method | Parameter | Description | Type -| create | *content* | The com.google.api.services.gmail.model.Label | Label -| create | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| delete | *id* | The ID of the label to delete | String -| delete | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| get | *id* | The ID of the label to retrieve | String -| get | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| list | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| patch | *content* | The com.google.api.services.gmail.model.Label | Label -| patch | *id* | The ID of the label to update | String -| patch | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| update | *content* | The com.google.api.services.gmail.model.Label | Label -| update | *id* | The ID of the label to update | String -| update | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -|=== - -In addition to the parameters above, the labels API can also use from the 28 endpoint query option -which is listed in the _Query Parameters_ section. - -Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. -The message header name must be of the format `CamelGoogleMailStream.parameter`. -The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere` -would override a `CamelGoogleMailStream.myParameterNameHere` header. - - - -==== API: messages - -*Only consumer is supported* - - - - -The messages API has 11 method(s) which is represented by the following method signatures -(an API method may have multiple signatures due to overloading): - -[source,java] ----- - -com.google.api.services.gmail.Gmail.Users.Messages.BatchDelete batchDelete(String userId, com.google.api.services.gmail.model.BatchDeleteMessagesRequest content); - -com.google.api.services.gmail.Gmail.Users.Messages.BatchModify batchModify(String userId, com.google.api.services.gmail.model.BatchModifyMessagesRequest content); - -com.google.api.services.gmail.Gmail.Users.Messages.Delete delete(String userId, String id); - -com.google.api.services.gmail.Gmail.Users.Messages.Get get(String userId, String id); - -com.google.api.services.gmail.Gmail.Users.Messages.GmailImport gmailImport(String userId, com.google.api.services.gmail.model.Message content); - -com.google.api.services.gmail.Gmail.Users.Messages.GmailImport gmailImport(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent); - -com.google.api.services.gmail.Gmail.Users.Messages.Insert insert(String userId, com.google.api.services.gmail.model.Message content); - -com.google.api.services.gmail.Gmail.Users.Messages.Insert insert(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent); - -com.google.api.services.gmail.Gmail.Users.Messages.List list(String userId); - -com.google.api.services.gmail.Gmail.Users.Messages.Modify modify(String userId, String id, com.google.api.services.gmail.model.ModifyMessageRequest content); - -com.google.api.services.gmail.Gmail.Users.Messages.Send send(String userId, com.google.api.services.gmail.model.Message content); - -com.google.api.services.gmail.Gmail.Users.Messages.Send send(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent); - -com.google.api.services.gmail.Gmail.Users.Messages.Trash trash(String userId, String id); - -com.google.api.services.gmail.Gmail.Users.Messages.Untrash untrash(String userId, String id); - ----- - -The messages API is defined in the syntax as follows: - ----- -google-mail-stream:messages/methodName?[parameters] ----- - -The 11 method(s) is listed in the table below. -(API methods can have a shorthand alias name which can be used in the syntax instead of the name) - -[width="100%",cols="2,2,6",options="header"] -|=== -| Method | Alias | Description -| *batchDelete* | | Deletes many messages by message ID -| *batchModify* | | Modifies the labels on the specified messages -| *delete* | | Immediately and permanently deletes the specified message -| *get* | | Gets the specified message -| *gmailImport* | | Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP -| *insert* | | Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification -| *list* | | Lists the messages in the user's mailbox -| *modify* | | Modifies the labels on the specified message -| *send* | | Sends the specified message to the recipients in the To, Cc, and Bcc headers -| *trash* | | Moves the specified message to the trash -| *untrash* | | Removes the specified message from the trash -|=== - -The messages API method(s) has the following set of parameters listed in the table below: -[width="100%",cols="2,2,4,2",options="header"] -|=== -| Method | Parameter | Description | Type -| batchDelete | *batchDeleteMessagesRequest* | The com.google.api.services.gmail.model.BatchDeleteMessagesRequest | BatchDeleteMessagesRequest -| batchDelete | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| batchModify | *batchModifyMessagesRequest* | The com.google.api.services.gmail.model.BatchModifyMessagesRequest | BatchModifyMessagesRequest -| batchModify | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| delete | *id* | The ID of the message to delete | String -| delete | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| get | *id* | The ID of the message to retrieve | String -| get | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| gmailImport | *content* | The com.google.api.services.gmail.model.Message media metadata or null if none | Message -| gmailImport | *mediaContent* | The media HTTP content or null if none | AbstractInputStreamContent -| gmailImport | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| insert | *content* | The com.google.api.services.gmail.model.Message media metadata or null if none | Message -| insert | *mediaContent* | The media HTTP content or null if none | AbstractInputStreamContent -| insert | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| list | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| modify | *id* | The ID of the message to modify | String -| modify | *modifyMessageRequest* | The com.google.api.services.gmail.model.ModifyMessageRequest | ModifyMessageRequest -| modify | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| send | *content* | The com.google.api.services.gmail.model.Message media metadata or null if none | Message -| send | *mediaContent* | The media HTTP content or null if none | AbstractInputStreamContent -| send | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| trash | *id* | The ID of the message to Trash | String -| trash | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| untrash | *id* | The ID of the message to remove from Trash | String -| untrash | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -|=== - -In addition to the parameters above, the messages API can also use from the 28 endpoint query option -which is listed in the _Query Parameters_ section. - -Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. -The message header name must be of the format `CamelGoogleMailStream.parameter`. -The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere` -would override a `CamelGoogleMailStream.myParameterNameHere` header. - - - -==== API: threads - -*Only consumer is supported* - - - - -The threads API has 6 method(s) which is represented by the following method signatures -(an API method may have multiple signatures due to overloading): - -[source,java] ----- - -com.google.api.services.gmail.Gmail.Users.Threads.Delete delete(String userId, String id); - -com.google.api.services.gmail.Gmail.Users.Threads.Get get(String userId, String id); - -com.google.api.services.gmail.Gmail.Users.Threads.List list(String userId); - -com.google.api.services.gmail.Gmail.Users.Threads.Modify modify(String userId, String id, com.google.api.services.gmail.model.ModifyThreadRequest content); - -com.google.api.services.gmail.Gmail.Users.Threads.Trash trash(String userId, String id); - -com.google.api.services.gmail.Gmail.Users.Threads.Untrash untrash(String userId, String id); - ----- - -The threads API is defined in the syntax as follows: - ----- -google-mail-stream:threads/methodName?[parameters] ----- - -The 6 method(s) is listed in the table below. -(API methods can have a shorthand alias name which can be used in the syntax instead of the name) - -[width="100%",cols="2,2,6",options="header"] -|=== -| Method | Alias | Description -| *delete* | | Immediately and permanently deletes the specified thread -| *get* | | Gets the specified thread -| *list* | | Lists the threads in the user's mailbox -| *modify* | | Modifies the labels applied to the thread -| *trash* | | Moves the specified thread to the trash -| *untrash* | | Removes the specified thread from the trash -|=== - -The threads API method(s) has the following set of parameters listed in the table below: -[width="100%",cols="2,2,4,2",options="header"] -|=== -| Method | Parameter | Description | Type -| delete | *id* | ID of the Thread to delete | String -| delete | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| get | *id* | The ID of the thread to retrieve | String -| get | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| list | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| modify | *content* | The com.google.api.services.gmail.model.ModifyThreadRequest | ModifyThreadRequest -| modify | *id* | The ID of the thread to modify | String -| modify | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| trash | *id* | The ID of the thread to Trash | String -| trash | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| untrash | *id* | The ID of the thread to remove from Trash | String -| untrash | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -|=== - -In addition to the parameters above, the threads API can also use from the 28 endpoint query option -which is listed in the _Query Parameters_ section. - -Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. -The message header name must be of the format `CamelGoogleMailStream.parameter`. -The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere` -would override a `CamelGoogleMailStream.myParameterNameHere` header. - - - -==== API: users - -*Only consumer is supported* - - - - -The users API has 3 method(s) which is represented by the following method signatures -(an API method may have multiple signatures due to overloading): - -[source,java] ----- - -com.google.api.services.gmail.Gmail.Users.GetProfile getProfile(String userId); - -com.google.api.services.gmail.Gmail.Users.Stop stop(String userId); - -com.google.api.services.gmail.Gmail.Users.Watch watch(String userId, com.google.api.services.gmail.model.WatchRequest content); - ----- - -The users API is defined in the syntax as follows: - ----- -google-mail-stream:users/methodName?[parameters] ----- - -The 3 method(s) is listed in the table below. -(API methods can have a shorthand alias name which can be used in the syntax instead of the name) - -[width="100%",cols="2,2,6",options="header"] -|=== -| Method | Alias | Description -| *getProfile* | | Gets the current user's Gmail profile -| *stop* | | Stop receiving push notifications for the given user mailbox -| *watch* | | Set up or update a push notification watch on the given user mailbox -|=== - -The users API method(s) has the following set of parameters listed in the table below: -[width="100%",cols="2,2,4,2",options="header"] -|=== -| Method | Parameter | Description | Type -| getProfile | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| stop | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| watch | *content* | The com.google.api.services.gmail.model.WatchRequest | WatchRequest -| watch | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -|=== - -In addition to the parameters above, the users API can also use from the 28 endpoint query option -which is listed in the _Query Parameters_ section. - -Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. -The message header name must be of the format `CamelGoogleMailStream.parameter`. -The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere` -would override a `CamelGoogleMailStream.myParameterNameHere` header. // endpoint options: END diff --git a/docs/components/modules/ROOT/pages/google-mail-stream-component.adoc b/docs/components/modules/ROOT/pages/google-mail-stream-component.adoc index 41384ad..304a81a 100644 --- a/docs/components/modules/ROOT/pages/google-mail-stream-component.adoc +++ b/docs/components/modules/ROOT/pages/google-mail-stream-component.adoc @@ -171,535 +171,6 @@ with the following path and query parameters: | *clientSecret* (security) | Client secret of the mail application | | String | *refreshToken* (security) | OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived. | | String |=== - - - - -=== API Parameters (7 APIs): - -The Google Mail Stream endpoint is an API based component and has additional parameters based on which API name and API method is used. -The API name and API method is located in the endpoint URI as the null path parameters: - ----- -google-mail-stream:index ----- - -There are 7 API names as listed in the table below: - -[width="100%",cols="2,2,6",options="header"] -|=== -| API Name | Type | Description -| *attachments* | Consumer | The attachments collection of methods -| *drafts* | Consumer | The drafts collection of methods -| *history* | Consumer | The history collection of methods -| *labels* | Consumer | The labels collection of methods -| *messages* | Consumer | The messages collection of methods -| *threads* | Consumer | The threads collection of methods -| *users* | Consumer | The users collection of methods -|=== - -Each API is documented in the following sections to come. - - -==== API: attachments - -*Only consumer is supported* - - - - -The attachments API has 1 method(s) which is represented by the following method signatures -(an API method may have multiple signatures due to overloading): - -[source,java] ----- - -com.google.api.services.gmail.Gmail.Users.Messages.Attachments.Get get(String userId, String messageId, String id); - ----- - -The attachments API is defined in the syntax as follows: - ----- -google-mail-stream:attachments/methodName?[parameters] ----- - -The 1 method(s) is listed in the table below. -(API methods can have a shorthand alias name which can be used in the syntax instead of the name) - -[width="100%",cols="2,2,6",options="header"] -|=== -| Method | Alias | Description -| *get* | | Gets the specified message attachment -|=== - -The attachments API method(s) has the following set of parameters listed in the table below: -[width="100%",cols="2,2,4,2",options="header"] -|=== -| Method | Parameter | Description | Type -| get | *id* | The ID of the attachment | String -| get | *messageId* | The ID of the message containing the attachment | String -| get | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -|=== - -In addition to the parameters above, the attachments API can also use from the 28 endpoint query option -which is listed in the _Query Parameters_ section. - -Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. -The message header name must be of the format `CamelGoogleMailStream.parameter`. -The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere` -would override a `CamelGoogleMailStream.myParameterNameHere` header. - - - -==== API: drafts - -*Only consumer is supported* - - - - -The drafts API has 6 method(s) which is represented by the following method signatures -(an API method may have multiple signatures due to overloading): - -[source,java] ----- - -com.google.api.services.gmail.Gmail.Users.Drafts.Create create(String userId, com.google.api.services.gmail.model.Draft content); - -com.google.api.services.gmail.Gmail.Users.Drafts.Create create(String userId, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent); - -com.google.api.services.gmail.Gmail.Users.Drafts.Delete delete(String userId, String id); - -com.google.api.services.gmail.Gmail.Users.Drafts.Get get(String userId, String id); - -com.google.api.services.gmail.Gmail.Users.Drafts.List list(String userId); - -com.google.api.services.gmail.Gmail.Users.Drafts.Send send(String userId, com.google.api.services.gmail.model.Draft content); - -com.google.api.services.gmail.Gmail.Users.Drafts.Send send(String userId, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent); - -com.google.api.services.gmail.Gmail.Users.Drafts.Update update(String userId, String id, com.google.api.services.gmail.model.Draft content); - -com.google.api.services.gmail.Gmail.Users.Drafts.Update update(String userId, String id, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent); - ----- - -The drafts API is defined in the syntax as follows: - ----- -google-mail-stream:drafts/methodName?[parameters] ----- - -The 6 method(s) is listed in the table below. -(API methods can have a shorthand alias name which can be used in the syntax instead of the name) - -[width="100%",cols="2,2,6",options="header"] -|=== -| Method | Alias | Description -| *create* | | Creates a new draft with the DRAFT label -| *delete* | | Immediately and permanently deletes the specified draft -| *get* | | Gets the specified draft -| *list* | | Lists the drafts in the user's mailbox -| *send* | | Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers -| *update* | | Replaces a draft's content -|=== - -The drafts API method(s) has the following set of parameters listed in the table below: -[width="100%",cols="2,2,4,2",options="header"] -|=== -| Method | Parameter | Description | Type -| create | *content* | The com.google.api.services.gmail.model.Draft media metadata or null if none | Draft -| create | *mediaContent* | The media HTTP content or null if none | AbstractInputStreamContent -| create | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| delete | *id* | The ID of the draft to delete | String -| delete | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| get | *id* | The ID of the draft to retrieve | String -| get | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| list | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| send | *content* | The com.google.api.services.gmail.model.Draft media metadata or null if none | Draft -| send | *mediaContent* | The media HTTP content or null if none | AbstractInputStreamContent -| send | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| update | *content* | The com.google.api.services.gmail.model.Draft media metadata or null if none | Draft -| update | *id* | | String -| update | *mediaContent* | The media HTTP content or null if none | AbstractInputStreamContent -| update | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -|=== - -In addition to the parameters above, the drafts API can also use from the 28 endpoint query option -which is listed in the _Query Parameters_ section. - -Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. -The message header name must be of the format `CamelGoogleMailStream.parameter`. -The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere` -would override a `CamelGoogleMailStream.myParameterNameHere` header. - - - -==== API: history - -*Only consumer is supported* - - - - -The history API has 1 method(s) which is represented by the following method signatures -(an API method may have multiple signatures due to overloading): - -[source,java] ----- - -com.google.api.services.gmail.Gmail.Users.History.List list(String userId); - ----- - -The history API is defined in the syntax as follows: - ----- -google-mail-stream:history/methodName?[parameters] ----- - -The 1 method(s) is listed in the table below. -(API methods can have a shorthand alias name which can be used in the syntax instead of the name) - -[width="100%",cols="2,2,6",options="header"] -|=== -| Method | Alias | Description -| *list* | | Lists the history of all changes to the given mailbox -|=== - -The history API method(s) has the following set of parameters listed in the table below: -[width="100%",cols="2,2,4,2",options="header"] -|=== -| Method | Parameter | Description | Type -| list | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -|=== - -In addition to the parameters above, the history API can also use from the 28 endpoint query option -which is listed in the _Query Parameters_ section. - -Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. -The message header name must be of the format `CamelGoogleMailStream.parameter`. -The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere` -would override a `CamelGoogleMailStream.myParameterNameHere` header. - - - -==== API: labels - -*Only consumer is supported* - - - - -The labels API has 6 method(s) which is represented by the following method signatures -(an API method may have multiple signatures due to overloading): - -[source,java] ----- - -com.google.api.services.gmail.Gmail.Users.Labels.Create create(String userId, com.google.api.services.gmail.model.Label content); - -com.google.api.services.gmail.Gmail.Users.Labels.Delete delete(String userId, String id); - -com.google.api.services.gmail.Gmail.Users.Labels.Get get(String userId, String id); - -com.google.api.services.gmail.Gmail.Users.Labels.List list(String userId); - -com.google.api.services.gmail.Gmail.Users.Labels.Patch patch(String userId, String id, com.google.api.services.gmail.model.Label content); - -com.google.api.services.gmail.Gmail.Users.Labels.Update update(String userId, String id, com.google.api.services.gmail.model.Label content); - ----- - -The labels API is defined in the syntax as follows: - ----- -google-mail-stream:labels/methodName?[parameters] ----- - -The 6 method(s) is listed in the table below. -(API methods can have a shorthand alias name which can be used in the syntax instead of the name) - -[width="100%",cols="2,2,6",options="header"] -|=== -| Method | Alias | Description -| *create* | | Creates a new label -| *delete* | | Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to -| *get* | | Gets the specified label -| *list* | | Lists all labels in the user's mailbox -| *patch* | | Updates the specified label -| *update* | | Updates the specified label -|=== - -The labels API method(s) has the following set of parameters listed in the table below: -[width="100%",cols="2,2,4,2",options="header"] -|=== -| Method | Parameter | Description | Type -| create | *content* | The com.google.api.services.gmail.model.Label | Label -| create | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| delete | *id* | The ID of the label to delete | String -| delete | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| get | *id* | The ID of the label to retrieve | String -| get | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| list | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| patch | *content* | The com.google.api.services.gmail.model.Label | Label -| patch | *id* | The ID of the label to update | String -| patch | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| update | *content* | The com.google.api.services.gmail.model.Label | Label -| update | *id* | The ID of the label to update | String -| update | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -|=== - -In addition to the parameters above, the labels API can also use from the 28 endpoint query option -which is listed in the _Query Parameters_ section. - -Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. -The message header name must be of the format `CamelGoogleMailStream.parameter`. -The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere` -would override a `CamelGoogleMailStream.myParameterNameHere` header. - - - -==== API: messages - -*Only consumer is supported* - - - - -The messages API has 11 method(s) which is represented by the following method signatures -(an API method may have multiple signatures due to overloading): - -[source,java] ----- - -com.google.api.services.gmail.Gmail.Users.Messages.BatchDelete batchDelete(String userId, com.google.api.services.gmail.model.BatchDeleteMessagesRequest content); - -com.google.api.services.gmail.Gmail.Users.Messages.BatchModify batchModify(String userId, com.google.api.services.gmail.model.BatchModifyMessagesRequest content); - -com.google.api.services.gmail.Gmail.Users.Messages.Delete delete(String userId, String id); - -com.google.api.services.gmail.Gmail.Users.Messages.Get get(String userId, String id); - -com.google.api.services.gmail.Gmail.Users.Messages.GmailImport gmailImport(String userId, com.google.api.services.gmail.model.Message content); - -com.google.api.services.gmail.Gmail.Users.Messages.GmailImport gmailImport(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent); - -com.google.api.services.gmail.Gmail.Users.Messages.Insert insert(String userId, com.google.api.services.gmail.model.Message content); - -com.google.api.services.gmail.Gmail.Users.Messages.Insert insert(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent); - -com.google.api.services.gmail.Gmail.Users.Messages.List list(String userId); - -com.google.api.services.gmail.Gmail.Users.Messages.Modify modify(String userId, String id, com.google.api.services.gmail.model.ModifyMessageRequest content); - -com.google.api.services.gmail.Gmail.Users.Messages.Send send(String userId, com.google.api.services.gmail.model.Message content); - -com.google.api.services.gmail.Gmail.Users.Messages.Send send(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent); - -com.google.api.services.gmail.Gmail.Users.Messages.Trash trash(String userId, String id); - -com.google.api.services.gmail.Gmail.Users.Messages.Untrash untrash(String userId, String id); - ----- - -The messages API is defined in the syntax as follows: - ----- -google-mail-stream:messages/methodName?[parameters] ----- - -The 11 method(s) is listed in the table below. -(API methods can have a shorthand alias name which can be used in the syntax instead of the name) - -[width="100%",cols="2,2,6",options="header"] -|=== -| Method | Alias | Description -| *batchDelete* | | Deletes many messages by message ID -| *batchModify* | | Modifies the labels on the specified messages -| *delete* | | Immediately and permanently deletes the specified message -| *get* | | Gets the specified message -| *gmailImport* | | Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP -| *insert* | | Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification -| *list* | | Lists the messages in the user's mailbox -| *modify* | | Modifies the labels on the specified message -| *send* | | Sends the specified message to the recipients in the To, Cc, and Bcc headers -| *trash* | | Moves the specified message to the trash -| *untrash* | | Removes the specified message from the trash -|=== - -The messages API method(s) has the following set of parameters listed in the table below: -[width="100%",cols="2,2,4,2",options="header"] -|=== -| Method | Parameter | Description | Type -| batchDelete | *batchDeleteMessagesRequest* | The com.google.api.services.gmail.model.BatchDeleteMessagesRequest | BatchDeleteMessagesRequest -| batchDelete | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| batchModify | *batchModifyMessagesRequest* | The com.google.api.services.gmail.model.BatchModifyMessagesRequest | BatchModifyMessagesRequest -| batchModify | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| delete | *id* | The ID of the message to delete | String -| delete | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| get | *id* | The ID of the message to retrieve | String -| get | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| gmailImport | *content* | The com.google.api.services.gmail.model.Message media metadata or null if none | Message -| gmailImport | *mediaContent* | The media HTTP content or null if none | AbstractInputStreamContent -| gmailImport | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| insert | *content* | The com.google.api.services.gmail.model.Message media metadata or null if none | Message -| insert | *mediaContent* | The media HTTP content or null if none | AbstractInputStreamContent -| insert | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| list | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| modify | *id* | The ID of the message to modify | String -| modify | *modifyMessageRequest* | The com.google.api.services.gmail.model.ModifyMessageRequest | ModifyMessageRequest -| modify | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| send | *content* | The com.google.api.services.gmail.model.Message media metadata or null if none | Message -| send | *mediaContent* | The media HTTP content or null if none | AbstractInputStreamContent -| send | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| trash | *id* | The ID of the message to Trash | String -| trash | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| untrash | *id* | The ID of the message to remove from Trash | String -| untrash | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -|=== - -In addition to the parameters above, the messages API can also use from the 28 endpoint query option -which is listed in the _Query Parameters_ section. - -Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. -The message header name must be of the format `CamelGoogleMailStream.parameter`. -The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere` -would override a `CamelGoogleMailStream.myParameterNameHere` header. - - - -==== API: threads - -*Only consumer is supported* - - - - -The threads API has 6 method(s) which is represented by the following method signatures -(an API method may have multiple signatures due to overloading): - -[source,java] ----- - -com.google.api.services.gmail.Gmail.Users.Threads.Delete delete(String userId, String id); - -com.google.api.services.gmail.Gmail.Users.Threads.Get get(String userId, String id); - -com.google.api.services.gmail.Gmail.Users.Threads.List list(String userId); - -com.google.api.services.gmail.Gmail.Users.Threads.Modify modify(String userId, String id, com.google.api.services.gmail.model.ModifyThreadRequest content); - -com.google.api.services.gmail.Gmail.Users.Threads.Trash trash(String userId, String id); - -com.google.api.services.gmail.Gmail.Users.Threads.Untrash untrash(String userId, String id); - ----- - -The threads API is defined in the syntax as follows: - ----- -google-mail-stream:threads/methodName?[parameters] ----- - -The 6 method(s) is listed in the table below. -(API methods can have a shorthand alias name which can be used in the syntax instead of the name) - -[width="100%",cols="2,2,6",options="header"] -|=== -| Method | Alias | Description -| *delete* | | Immediately and permanently deletes the specified thread -| *get* | | Gets the specified thread -| *list* | | Lists the threads in the user's mailbox -| *modify* | | Modifies the labels applied to the thread -| *trash* | | Moves the specified thread to the trash -| *untrash* | | Removes the specified thread from the trash -|=== - -The threads API method(s) has the following set of parameters listed in the table below: -[width="100%",cols="2,2,4,2",options="header"] -|=== -| Method | Parameter | Description | Type -| delete | *id* | ID of the Thread to delete | String -| delete | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| get | *id* | The ID of the thread to retrieve | String -| get | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| list | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| modify | *content* | The com.google.api.services.gmail.model.ModifyThreadRequest | ModifyThreadRequest -| modify | *id* | The ID of the thread to modify | String -| modify | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| trash | *id* | The ID of the thread to Trash | String -| trash | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| untrash | *id* | The ID of the thread to remove from Trash | String -| untrash | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -|=== - -In addition to the parameters above, the threads API can also use from the 28 endpoint query option -which is listed in the _Query Parameters_ section. - -Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. -The message header name must be of the format `CamelGoogleMailStream.parameter`. -The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere` -would override a `CamelGoogleMailStream.myParameterNameHere` header. - - - -==== API: users - -*Only consumer is supported* - - - - -The users API has 3 method(s) which is represented by the following method signatures -(an API method may have multiple signatures due to overloading): - -[source,java] ----- - -com.google.api.services.gmail.Gmail.Users.GetProfile getProfile(String userId); - -com.google.api.services.gmail.Gmail.Users.Stop stop(String userId); - -com.google.api.services.gmail.Gmail.Users.Watch watch(String userId, com.google.api.services.gmail.model.WatchRequest content); - ----- - -The users API is defined in the syntax as follows: - ----- -google-mail-stream:users/methodName?[parameters] ----- - -The 3 method(s) is listed in the table below. -(API methods can have a shorthand alias name which can be used in the syntax instead of the name) - -[width="100%",cols="2,2,6",options="header"] -|=== -| Method | Alias | Description -| *getProfile* | | Gets the current user's Gmail profile -| *stop* | | Stop receiving push notifications for the given user mailbox -| *watch* | | Set up or update a push notification watch on the given user mailbox -|=== - -The users API method(s) has the following set of parameters listed in the table below: -[width="100%",cols="2,2,4,2",options="header"] -|=== -| Method | Parameter | Description | Type -| getProfile | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| stop | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -| watch | *content* | The com.google.api.services.gmail.model.WatchRequest | WatchRequest -| watch | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String -|=== - -In addition to the parameters above, the users API can also use from the 28 endpoint query option -which is listed in the _Query Parameters_ section. - -Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. -The message header name must be of the format `CamelGoogleMailStream.parameter`. -The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere` -would override a `CamelGoogleMailStream.myParameterNameHere` header. // endpoint options: END
