You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ac...@apache.org on 2016/04/02 14:02:48 UTC
[3/4] camel git commit: Added camel-google-mail docs to gitbook
Added camel-google-mail docs to gitbook
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/9a0e6d4c
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/9a0e6d4c
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/9a0e6d4c
Branch: refs/heads/master
Commit: 9a0e6d4c1b7eace7d2660d47c400479677f1e540
Parents: 39b0bbf
Author: Andrea Cosentino <an...@gmail.com>
Authored: Sat Apr 2 12:32:30 2016 +0200
Committer: Andrea Cosentino <an...@gmail.com>
Committed: Sat Apr 2 12:32:30 2016 +0200
----------------------------------------------------------------------
.../src/main/docs/google-mail.adoc | 152 +++++++++++++++++++
docs/user-manual/en/SUMMARY.md | 1 +
2 files changed, 153 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/9a0e6d4c/components/camel-google-mail/src/main/docs/google-mail.adoc
----------------------------------------------------------------------
diff --git a/components/camel-google-mail/src/main/docs/google-mail.adoc b/components/camel-google-mail/src/main/docs/google-mail.adoc
new file mode 100644
index 0000000..1cf52df
--- /dev/null
+++ b/components/camel-google-mail/src/main/docs/google-mail.adoc
@@ -0,0 +1,152 @@
+[[GoogleMail-GoogleMailComponent]]
+GoogleMail Component
+~~~~~~~~~~~~~~~~~~~~
+
+*Available as of Camel 2.15*
+
+[[GoogleMail-ComponentDescription]]
+Component Description
+^^^^^^^^^^^^^^^^^^^^^
+
+The Google Mail component provides access
+to http://gmail.com/[Gmail] via
+the https://developers.google.com/gmail/api/v1/reference/[Google Mail
+Web APIs].
+
+Google Mail uses
+the https://developers.google.com/accounts/docs/OAuth2[OAuth 2.0
+protocol] for authenticating a Google account and authorizing access to
+user data. Before you can use this component, you will need
+to https://developers.google.com/gmail/api/auth/web-server[create an
+account and generate OAuth credentials]. Credentials comprise of a
+clientId, clientSecret, and a refreshToken. A handy resource for
+generating a long-lived refreshToken is
+the https://developers.google.com/oauthplayground[OAuth playground].
+
+Maven users will need to add the following dependency to their pom.xml
+for this component:
+
+------------------------------------------------------
+ <dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-google-mail</artifactId>
+ <version>2.15-SNAPSHOT</version>
+ </dependency>
+
+------------------------------------------------------
+
+[[GoogleMail-URIFormat]]
+URI Format
+^^^^^^^^^^
+
+The GoogleMail Component uses the following URI format:
+
+--------------------------------------------------------
+ google-mail://endpoint-prefix/endpoint?[options]
+
+--------------------------------------------------------
+
+Endpoint prefix can be one of:
+
+* attachments
+* drafts
+* history
+* labels
+* messages
+* threads
+* users
+
+[[GoogleMail-GoogleMailComponent.1]]
+GoogleMailComponent
+^^^^^^^^^^^^^^^^^^^
+
+
+// component options: START
+The Google Mail component supports 2 options which are listed below.
+
+
+
+[width="100%",cols="2s,1m,8",options="header"]
+|=======================================================================
+| Name | Java Type | Description
+| configuration | GoogleMailConfiguration | To use the shared configuration
+| clientFactory | GoogleMailClientFactory | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleMailClientFactory
+|=======================================================================
+// component options: END
+
+
+
+// endpoint options: START
+The Google Mail component supports 13 endpoint options which are listed below:
+
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| apiName | common | | GoogleMailApiName | *Required* What kind of operation to perform
+| methodName | common | | String | *Required* What sub operation to use for the selected operation
+| accessToken | common | | String | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage.
+| applicationName | common | | String | Google mail application name. Example would be camel-google-mail/1.0
+| clientId | common | | String | Client ID of the mail application
+| clientSecret | common | | String | Client secret of the mail application
+| inBody | common | | String | Sets the name of a parameter to be passed in the exchange In Body
+| refreshToken | common | | String | 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.
+| scopes | common | | List | Specifies the level of permissions you want a mail application to have to a user account. See https://developers.google.com/gmail/api/auth/scopes for more info.
+| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+|=======================================================================
+// endpoint options: END
+
+
+[[GoogleMail-ProducerEndpoints]]
+Producer Endpoints
+^^^^^^^^^^^^^^^^^^
+
+Producer endpoints can use endpoint prefixes followed by endpoint names
+and associated options described next. A shorthand alias can be used for
+some endpoints. The endpoint URI MUST contain a prefix.
+
+Endpoint options that are not mandatory are denoted by []. When there
+are no mandatory options for an endpoint, one of the set of [] options
+MUST be provided. Producer endpoints can also use a special option
+*`inBody`* that in turn should contain the name of the endpoint option
+whose value will be contained in the Camel Exchange In message.
+
+Any of the endpoint options can be provided in either the endpoint URI,
+or dynamically in a message header. The message header name must be of
+the format `CamelGoogleMail.<option>`. Note that the `inBody` option
+overrides message header, i.e. the endpoint option `inBody=option` would
+override a `CamelGoogleMail.option` header.
+
+For more information on the endpoints and options see API documentation
+at: https://developers.google.com/gmail/api/v1/reference/[https://developers.google.com/gmail/api/v1/reference/]
+
+[[GoogleMail-ConsumerEndpoints]]
+Consumer Endpoints
+^^^^^^^^^^^^^^^^^^
+
+Any of the producer endpoints can be used as a consumer endpoint.
+Consumer endpoints can use
+http://camel.apache.org/polling-consumer.html#PollingConsumer-ScheduledPollConsumerOptions[Scheduled
+Poll Consumer Options] with a `consumer.` prefix to schedule endpoint
+invocation. Consumer endpoints that return an array or collection will
+generate one exchange per element, and their routes will be executed
+once for each exchange.
+
+[[GoogleMail-MessageHeaders]]
+Message Headers
+^^^^^^^^^^^^^^^
+
+Any URI option can be provided in a message header for producer
+endpoints with a `CamelGoogleMail.` prefix.
+
+[[GoogleMail-MessageBody]]
+Message Body
+^^^^^^^^^^^^
+
+All result message bodies utilize objects provided by the underlying
+APIs used by the GoogleMailComponent. Producer endpoints can specify the
+option name for incoming message body in the `inBody` endpoint URI
+parameter. For endpoints that return an array or collection, a consumer
+endpoint will map every element to distinct messages.
http://git-wip-us.apache.org/repos/asf/camel/blob/9a0e6d4c/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index 935baa1..8003d6a 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -138,6 +138,7 @@
* [Github](github.adoc)
* [Google Calendar](google-calendar.adoc)
* [Google Drive](google-drive.adoc)
+ * [Google Mail](google-mail.adoc)
* [Ironmq](ironmq.adoc)
* [JMS](jms.adoc)
* [JMX](jmx.adoc)