This is an automated email from the ASF dual-hosted git repository. nfilotto pushed a commit to branch CAMEL-17792/doc-message-headers in repository https://gitbox.apache.org/repos/asf/camel.git
commit b5b678cc25a20aaffc9b6fbdd18651f1cb938198 Author: Nicolas Filotto <[email protected]> AuthorDate: Tue Mar 22 15:12:04 2022 +0100 CAMEL-17792: Add doc about the message headers of camel-google-mail --- .../camel/component/google/mail/stream/google-mail-stream.json | 8 ++++++++ .../src/main/docs/google-mail-stream-component.adoc | 4 +++- .../component/google/mail/stream/GoogleMailStreamConstants.java | 8 ++++++++ .../component/google/mail/stream/GoogleMailStreamEndpoint.java | 2 +- 4 files changed, 20 insertions(+), 2 deletions(-) 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 80aaa24..06fe45f 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 @@ -39,6 +39,14 @@ "keyResource": { "kind": "property", "displayName": "Key Resource", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration", "configurationField": "configuration", "description": "Sets .json file with credentials for Service account" }, "refreshToken": { "kind": "property", "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 [...] }, + "headers": { + "CamelGoogleMailStreamTo": { "kind": "header", "displayName": "", "group": "consumer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The recipient of the message" }, + "CamelGoogleMailStreamFrom": { "kind": "header", "displayName": "", "group": "consumer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The emitter of the message" }, + "CamelGoogleMailStreamCc": { "kind": "header", "displayName": "", "group": "consumer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The carbon copy of the message" }, + "CamelGoogleMailStreamBcc": { "kind": "header", "displayName": "", "group": "consumer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The blind carbon cpoy of the message" }, + "CamelGoogleMailStreamSubject": { "kind": "header", "displayName": "", "group": "consumer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The subject of the message" }, + "CamelGoogleMailId": { "kind": "header", "displayName": "", "group": "consumer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The ID of the message" } + }, "properties": { "index": { "kind": "path", "displayName": "Index", "group": "consumer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration", "configurationField": "configuration", "description": "Currently not in use" }, "applicationName": { "kind": "parameter", "displayName": "Application Name", "group": "consumer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration", "configurationField": "configuration", "description": "Google mail application name. Example would be camel-google-mail\/1.0" }, 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 fd0217a..0f6896f 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 @@ -69,7 +69,9 @@ include::partial$component-endpoint-options.adoc[] // endpoint options: START // endpoint options: END - +// component headers: START +include::partial$component-endpoint-headers.adoc[] +// component headers: END include::spring-boot:partial$starter.adoc[] diff --git a/components/camel-google/camel-google-mail/src/main/java/org/apache/camel/component/google/mail/stream/GoogleMailStreamConstants.java b/components/camel-google/camel-google-mail/src/main/java/org/apache/camel/component/google/mail/stream/GoogleMailStreamConstants.java index ea8fdf1..7d4bafe 100644 --- a/components/camel-google/camel-google-mail/src/main/java/org/apache/camel/component/google/mail/stream/GoogleMailStreamConstants.java +++ b/components/camel-google/camel-google-mail/src/main/java/org/apache/camel/component/google/mail/stream/GoogleMailStreamConstants.java @@ -16,16 +16,24 @@ */ package org.apache.camel.component.google.mail.stream; +import org.apache.camel.spi.Metadata; + /** * Constants used in Camel Google Mail Stream */ public final class GoogleMailStreamConstants { + @Metadata(description = "The recipient of the message", javaType = "String") public static final String MAIL_TO = "CamelGoogleMailStreamTo"; + @Metadata(description = "The emitter of the message", javaType = "String") public static final String MAIL_FROM = "CamelGoogleMailStreamFrom"; + @Metadata(description = "The carbon copy of the message", javaType = "String") public static final String MAIL_CC = "CamelGoogleMailStreamCc"; + @Metadata(description = "The blind carbon cpoy of the message", javaType = "String") public static final String MAIL_BCC = "CamelGoogleMailStreamBcc"; + @Metadata(description = "The subject of the message", javaType = "String") public static final String MAIL_SUBJECT = "CamelGoogleMailStreamSubject"; + @Metadata(description = "The ID of the message", javaType = "String") public static final String MAIL_ID = "CamelGoogleMailId"; /** diff --git a/components/camel-google/camel-google-mail/src/main/java/org/apache/camel/component/google/mail/stream/GoogleMailStreamEndpoint.java b/components/camel-google/camel-google-mail/src/main/java/org/apache/camel/component/google/mail/stream/GoogleMailStreamEndpoint.java index 0f60175..0e8c198 100644 --- a/components/camel-google/camel-google-mail/src/main/java/org/apache/camel/component/google/mail/stream/GoogleMailStreamEndpoint.java +++ b/components/camel-google/camel-google-mail/src/main/java/org/apache/camel/component/google/mail/stream/GoogleMailStreamEndpoint.java @@ -41,7 +41,7 @@ import org.apache.camel.util.ObjectHelper; title = "Google Mail Stream", syntax = "google-mail-stream:index", consumerOnly = true, - category = { Category.CLOUD, Category.MAIL }) + category = { Category.CLOUD, Category.MAIL }, headersClass = GoogleMailStreamConstants.class) public class GoogleMailStreamEndpoint extends ScheduledPollEndpoint { @UriParam
