You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by bu...@apache.org on 2014/12/05 13:20:49 UTC
svn commit: r931522 [5/7] - in /websites/production/camel/content: ./ cache/
Added: websites/production/camel/content/googlemail.html
==============================================================================
--- websites/production/camel/content/googlemail.html (added)
+++ websites/production/camel/content/googlemail.html Fri Dec 5 12:20:48 2014
@@ -0,0 +1,160 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<html>
+<head>
+ <link href="//camel.apache.org/styles/site.css" rel="stylesheet" type="text/css">
+ <link href="//camel.apache.org/styles/type-settings.css" rel="stylesheet" type="text/css">
+ <script src="//camel.apache.org/styles/prototype.js" type="text/javascript"></script>
+ <script src="//camel.apache.org/styles/rico.js" type="text/javascript"></script>
+ <script src="//camel.apache.org/styles/site.js" type="text/javascript"></script>
+
+ <meta http-equiv="Content-type" content="text/html;charset=UTF-8">
+
+ <style type="text/css">
+ .maincontent { overflow:hidden; }
+ </style>
+ <!--[if IE]>
+ <style type="text/css">
+ .maincontent { width:100%; }
+ </style>
+ <![endif]-->
+
+
+
+ <title>
+ Apache Camel: GoogleMail
+ </title>
+</head>
+<body>
+<div class="white_box">
+<div class="header">
+ <div class="header_l">
+ <div class="header_r">
+ </div>
+ </div>
+</div>
+<div class="content">
+ <div class="content_l">
+ <div class="content_r">
+ <div>
+ <!-- Banner -->
+<div id="banner-content"><div id="asf_logo">
+ <div id="activemq_logo" style="height:108px; background:transparent url(banner.data/apache-camel-7.png) no-repeat scroll left top;">
+ <a shape="rect" style="float:left; width:310px;display:block;text-indent:-5000px;text-decoration:none;line-height:140px; margin-top:20px; margin-left:18px;" href="http://camel.apache.org/">Camel</a>
+ <a shape="rect" style="float:right; width:180px;display:block;text-indent:-5000px;text-decoration:none;line-height:80px; margin-top:45px; margin-right:10px;" href="http://www.apache.org">Apache</a>
+ </div>
+</div></div>
+ <!-- Banner -->
+ <div class="top_red_bar">
+ <div id="site-breadcrumbs">
+ <!-- Breadcrumbs -->
+<a href="index.html">Apache Camel</a> > <a href="site.html">Site</a> > <a href="includes.html">Includes</a> > <a href="component-list.html">Component List</a> > <a href="googlemail.html">GoogleMail</a>
+ </div>
+ <!-- Quicklinks -->
+<div id="site-quicklinks"><p><a shape="rect" href="download.html">Download</a> | <a shape="rect" href="javadoc.html">JavaDoc</a> | <a shape="rect" href="source.html">Source</a> | <a shape="rect" href="discussion-forums.html">Forums</a> | <a shape="rect" href="support.html">Support</a></p></div>
+ <!-- Quicklinks -->
+ </div>
+
+ <table border="0">
+ <tbody>
+ <tr>
+ <td valign="top" width="100%">
+<div class="wiki-content maincontent"><h2 id="GoogleMail-GoogleMailComponent">GoogleMail Component</h2><hr><p><strong>Available as of Camel 2.15</strong></p><h3 id="GoogleMail-ComponentDescription">Component Description</h3><p>The Google Mail component provides access to <a shape="rect" class="external-link" href="http://gmail.com/" rel="nofollow">Gmail</a> via the <a shape="rect" class="external-link" href="https://developers.google.com/gmail/api/v1/reference/" rel="nofollow">Google Mail Web APIs</a>.</p><p><span style="color: rgb(34,34,34);">Google Mail uses the </span><a shape="rect" class="external-link" href="https://developers.google.com/accounts/docs/OAuth2" rel="nofollow">OAuth 2.0 protocol</a><span style="color: rgb(34,34,34);"> for authenticating a Google account and authorizing access to user data. Before you can use this component, you will need to <a shape="rect" class="external-link" href="https://developers.google.com/gmail/api/auth/web-s
erver" rel="nofollow">create an account and generate OAuth credentials</a>. Credentials comprise of a clientId, clientSecret, and a refreshToken. A handy resource for generating a long-lived refreshToken is the <a shape="rect" class="external-link" href="https://developers.google.com/oauthplayground" rel="nofollow">OAuth playground</a>.</span></p><p>Maven users will need to add the following dependency to their pom.xml for this component:</p><pre> <dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-google-mail</artifactId>
+ <version>2.15-SNAPSHOT</version>
+ </dependency>
+ </pre><h3 id="GoogleMail-URIFormat">URI Format</h3><hr><p>The GoogleMail Component uses the following URI format:</p><pre> google-mail://endpoint-prefix/endpoint?[options]
+ </pre><p>Endpoint prefix can be one of:</p><ul><li>attachments</li><li>drafts</li><li>history</li><li>labels</li><li>messages</li><li>threads</li><li>users</li></ul><h3 id="GoogleMail-GoogleMailComponent.1">GoogleMailComponent</h3><hr><p>The GoogleMail Component can be configured with the options below. These options can be provided using the component's bean property <code>configuration</code> of type <code>org.apache.camel.component.google.mail.GoogleMailConfiguration</code>.</p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Option</th><th colspan="1" rowspan="1" class="confluenceTh">Type</th><th colspan="1" rowspan="1" class="confluenceTh"> </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">accessToken</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">OAuth 2 access token. This typically expires after an hour so refreshToken is re
commended for long term usage.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">applicationName</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">Google drive application name. Example would be "camel-google-mail/1.0"</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">clientId</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">Client ID of the drive application</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">clientSecret</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">Client secret of the drive application</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">refreshToken</td><td colspan="1" rowspan="1" class="confluenceTd"><p>String</p></td><td colspan="1" rowspan="1" class="confluenceTd">OAuth 2 refresh token. Using this, the Google Mail component c
an obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">scopes</td><td colspan="1" rowspan="1" class="confluenceTd">List<String></td><td colspan="1" rowspan="1" class="confluenceTd">Specifies the level of permissions you want a drive application to have to a user account. See <a shape="rect" class="external-link" href="https://developers.google.com/gmail/api/auth/scopes" rel="nofollow">https://developers.google.com/gmail/api/auth/scopes</a> for more info.</td></tr></tbody></table></div><h3 id="GoogleMail-ProducerEndpoints">Producer Endpoints</h3><hr><p>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.</p><p>Endpoint options that are not mandatory are denoted by []. When there are no mandatory options for a
n endpoint, one of the set of [] options MUST be provided. Producer endpoints can also use a special option <strong><code>inBody</code></strong> that in turn should contain the name of the endpoint option whose value will be contained in the Camel Exchange In message.</p><p>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 <code>CamelGoogleMail.<option></code>. Note that the <code>inBody</code> option overrides message header, i.e. the endpoint option <code>inBody=option</code> would override a <code>CamelGoogleMail.option</code> header.</p><p>For more information on the endpoints and options see API documentation at: <a shape="rect" class="external-link" href="https://developers.google.com/gmail/api/v1/reference/" rel="nofollow">https://developers.google.com/gmail/api/v1/reference/</a></p><h3 id="GoogleMail-1.EndpointPrefixattachments">1. Endpoint Prefix <em>attachment
s</em></h3><hr><p>The following endpoints can be invoked with the prefix <code>attachments</code> as follows:</p><pre> google-mail://attachments/endpoint?[options]
+ </pre><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Endpoint</th><th colspan="1" rowspan="1" class="confluenceTh">Shorthand Alias</th><th colspan="1" rowspan="1" class="confluenceTh">Options</th><th colspan="1" rowspan="1" class="confluenceTh">Result Body Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">get</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">id, messageId, userId</td><td colspan="1" rowspan="1" class="confluenceTd">com.google.api.services.gmail.model.MessagePartBody</td></tr></tbody></table></div><h4 id="GoogleMail-URIOptionsforattachments">URI Options for <em>attachments</em></h4><hr><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Name</th><th colspan="1" rowspan="1" class="confluenceTh">Type</th></tr><tr><td colspan="1" rowspan="1" class="confluence
Td">id</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">messageId</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">userId</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr></tbody></table></div><h3 id="GoogleMail-2.EndpointPrefixdrafts">2. Endpoint Prefix <em>drafts</em></h3><hr><p>The following endpoints can be invoked with the prefix <code>drafts</code> as follows:</p><pre> google-mail://drafts/endpoint?[options]
+ </pre><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Endpoint</th><th colspan="1" rowspan="1" class="confluenceTh">Shorthand Alias</th><th colspan="1" rowspan="1" class="confluenceTh">Options</th><th colspan="1" rowspan="1" class="confluenceTh">Result Body Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">create</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">[mediaContent], content, userId</td><td colspan="1" rowspan="1" class="confluenceTd"><pre class="prettyprint lang-java"><span class="pln" style="color: rgb(0,0,0);">com</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">google</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">api</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" styl
e="color: rgb(0,0,0);">services</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">gmail</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">model</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="typ" style="color: rgb(102,0,102);">Draft</span></pre></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">delete</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">id, userId</td><td colspan="1" rowspan="1" class="confluenceTd"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">get</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">id, userId</td><td colspan="1" rowspan="1" class="confluenceTd"><pre class="prettyprint lang-java"><span class="pln" style="color: rgb(0,0,0);">com</span><span class="pun" st
yle="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">google</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">api</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">services</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">gmail</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">model</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="typ" style="color: rgb(102,0,102);">Draft</span></pre></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">list</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">userId</td><td colspan="1" rowspan="1" class="confluenceTd"><pre class="prettyprint lang-java"><span class="pln" style="color: rgb(0,0,0);">
com</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">google</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">api</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">services</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">gmail</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">model</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="typ" style="color: rgb(102,0,102);">ListDraftsResponse</span></pre></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">send</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">[mediaContent], content, userId</td><td colspan="1" rowspan="1" class="confluenceTd"><pre class="
prettyprint lang-java"><span class="pln" style="color: rgb(0,0,0);">com</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">google</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">api</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">services</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">gmail</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">model</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="typ" style="color: rgb(102,0,102);">Message</span></pre></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">update</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">[mediaContent], content, id, userId</t
d><td colspan="1" rowspan="1" class="confluenceTd"><pre class="prettyprint lang-java"><span class="pln" style="color: rgb(0,0,0);">com</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">google</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">api</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">services</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">gmail</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">model</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="typ" style="color: rgb(102,0,102);">Draft</span></pre></td></tr></tbody></table></div><h4 id="GoogleMail-URIOptionsfordrafts">URI Options for <em>drafts</em></h4><hr><div class="table-wrap"><table class="confluence
Table"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Name</th><th colspan="1" rowspan="1" class="confluenceTh">Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">content</td><td colspan="1" rowspan="1" class="confluenceTd">com.google.api.services.gmail.model.Draft</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">id</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">mediaContent</td><td colspan="1" rowspan="1" class="confluenceTd">com.google.api.client.http.AbstractInputStreamContent</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">userId</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr></tbody></table></div><h3 id="GoogleMail-3.EndpointPrefixhistory">3. Endpoint Prefix <em>history</em></h3><hr><p>The following endpoints can be invoked with the prefix <code>history</code> as follows:</p><pre> google-mail://history/endpoint?[options]
+ </pre><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Endpoint</th><th colspan="1" rowspan="1" class="confluenceTh">Shorthand Alias</th><th colspan="1" rowspan="1" class="confluenceTh">Options</th><th colspan="1" rowspan="1" class="confluenceTh">Result Body Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">list</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">userId</td><td colspan="1" rowspan="1" class="confluenceTd"><pre class="prettyprint lang-java"><span class="pln" style="color: rgb(0,0,0);">com</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">google</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">api</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">serv
ices</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">gmail</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">model</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="typ" style="color: rgb(102,0,102);">ListHistoryResponse</span></pre></td></tr></tbody></table></div><h4 id="GoogleMail-URIOptionsforhistory">URI Options for <em>history</em></h4><hr><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Name</th><th colspan="1" rowspan="1" class="confluenceTh">Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">userId</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr></tbody></table></div><h3 id="GoogleMail-4.EndpointPrefixlabels">4. Endpoint Prefix <em>labels</em></h3><hr><p>The following endpoints can be invoked with the prefix <code>labels</code> as f
ollows:</p><pre> google-mail://labels/endpoint?[options]
+ </pre><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Endpoint</th><th colspan="1" rowspan="1" class="confluenceTh">Shorthand Alias</th><th colspan="1" rowspan="1" class="confluenceTh">Options</th><th colspan="1" rowspan="1" class="confluenceTh">Result Body Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">create</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">content, userId</td><td colspan="1" rowspan="1" class="confluenceTd"><pre class="prettyprint lang-java"><span class="pln" style="color: rgb(0,0,0);">com</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">google</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">api</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,
0,0);">services</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">gmail</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">model</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="typ" style="color: rgb(102,0,102);">Label</span></pre></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">delete</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">id, userId</td><td colspan="1" rowspan="1" class="confluenceTd"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">get</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">id, userId</td><td colspan="1" rowspan="1" class="confluenceTd"><pre class="prettyprint lang-java"><span class="pln" style="color: rgb(0,0,0);">com</span><span class="pun" style="color: rgb(
102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">google</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">api</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">services</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">gmail</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">model</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="typ" style="color: rgb(102,0,102);">Label</span></pre></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">list</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">userId</td><td colspan="1" rowspan="1" class="confluenceTd"><pre class="prettyprint lang-java"><span class="pln" style="color: rgb(0,0,0);">com</span><span
class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">google</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">api</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">services</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">gmail</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">model</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="typ" style="color: rgb(102,0,102);">ListLabelsResponse</span></pre></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">patch</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">content, id, userId</td><td colspan="1" rowspan="1" class="confluenceTd"><pre class="prettyprint lang-java"><spa
n class="pln" style="color: rgb(0,0,0);">com</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">google</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">api</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">services</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">gmail</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">model</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="typ" style="color: rgb(102,0,102);">Label</span></pre></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">update</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">content, id, userId</td><td colspan="1" rowspan="1" class="confluen
ceTd"><pre class="prettyprint lang-java"><span class="pln" style="color: rgb(0,0,0);">com</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">google</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">api</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">services</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">gmail</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">model</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="typ" style="color: rgb(102,0,102);">Label</span></pre></td></tr></tbody></table></div><h4 id="GoogleMail-URIOptionsforlabels">URI Options for <em>labels</em></h4><hr><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh">Name</th><th colspan="1" rowspan="1" class="confluenceTh">Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">content</td><td colspan="1" rowspan="1" class="confluenceTd">com.google.api.services.gmail.model.Label</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">id</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">userId</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr></tbody></table></div><h3 id="GoogleMail-5.EndpointPrefixmessages">5. Endpoint Prefix <em>messages</em></h3><hr><p>The following endpoints can be invoked with the prefix <code>messages</code> as follows:</p><pre> google-mail://messages/endpoint?[options]
+ </pre><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Endpoint</th><th colspan="1" rowspan="1" class="confluenceTh">Shorthand Alias</th><th colspan="1" rowspan="1" class="confluenceTh">Options</th><th colspan="1" rowspan="1" class="confluenceTh">Result Body Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">delete</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">id, userId</td><td colspan="1" rowspan="1" class="confluenceTd"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">get</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">id, userId</td><td colspan="1" rowspan="1" class="confluenceTd"><pre class="prettyprint lang-java"><span class="pln" style="color: rgb(0,0,0);">com</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" st
yle="color: rgb(0,0,0);">google</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">api</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">services</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">gmail</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">model</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="typ" style="color: rgb(102,0,102);">Message</span></pre></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">gmailImport</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">[mediaContent], content, userId</td><td colspan="1" rowspan="1" class="confluenceTd"><pre class="prettyprint lang-java"><span class="pln" style="color: rgb(0,0,0);">com</span><span class="
pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">google</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">api</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">services</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">gmail</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">model</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="typ" style="color: rgb(102,0,102);">Message</span></pre></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">insert</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">[mediaContent], content, userId</td><td colspan="1" rowspan="1" class="confluenceTd"><pre class="prettyprint lang-java"><span cla
ss="pln" style="color: rgb(0,0,0);">com</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">google</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">api</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">services</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">gmail</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">model</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="typ" style="color: rgb(102,0,102);">Message</span></pre></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">list</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">userId</td><td colspan="1" rowspan="1" class="confluenceTd"><pre class="
prettyprint lang-java"><span class="pln" style="color: rgb(0,0,0);">com</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">google</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">api</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">services</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">gmail</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">model</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="typ" style="color: rgb(102,0,102);">ListMessagesResponse</span></pre></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">modify</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">id, modifyMessageRequest,
userId</td><td colspan="1" rowspan="1" class="confluenceTd"><pre class="prettyprint lang-java"><span class="pln" style="color: rgb(0,0,0);">com</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">google</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">api</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">services</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">gmail</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">model</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="typ" style="color: rgb(102,0,102);">Message</span></pre></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">send</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1"
rowspan="1" class="confluenceTd">[mediaContent], content, userId</td><td colspan="1" rowspan="1" class="confluenceTd"><pre class="prettyprint lang-java"><span class="pln" style="color: rgb(0,0,0);">com</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">google</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">api</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">services</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">gmail</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">model</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="typ" style="color: rgb(102,0,102);">Message</span></pre></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">trash</td><td colspan="1" ro
wspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">id, userId</td><td colspan="1" rowspan="1" class="confluenceTd"><pre class="prettyprint lang-java"> </pre></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">untrash</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">id, userId</td><td colspan="1" rowspan="1" class="confluenceTd"><pre class="prettyprint lang-java"> </pre></td></tr></tbody></table></div><h4 id="GoogleMail-URIOptionsformessages">URI Options for <em>messages</em></h4><hr><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Name</th><th colspan="1" rowspan="1" class="confluenceTh">Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">content</td><td colspan="1" rowspan="1" class="confluenceTd">com.google.api.services.gmail.model.Message</td></tr><tr><td colspan="1" rowspan="1
" class="confluenceTd">id</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">mediaContent</td><td colspan="1" rowspan="1" class="confluenceTd">com.google.api.client.http.AbstractInputStreamContent</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">modifyMessageRequest</td><td colspan="1" rowspan="1" class="confluenceTd">com.google.api.services.gmail.model.ModifyMessageRequest</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">userId</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr></tbody></table></div><h3 id="GoogleMail-6.EndpointPrefixthreads">6. Endpoint Prefix <em>threads</em></h3><hr><p>The following endpoints can be invoked with the prefix <code>threads</code> as follows:</p><pre> google-mail://threads/endpoint?[options]
+ </pre><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Endpoint</th><th colspan="1" rowspan="1" class="confluenceTh">Shorthand Alias</th><th colspan="1" rowspan="1" class="confluenceTh">Options</th><th colspan="1" rowspan="1" class="confluenceTh">Result Body Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">delete</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">id, userId</td><td colspan="1" rowspan="1" class="confluenceTd"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">get</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">id, userId</td><td colspan="1" rowspan="1" class="confluenceTd"><pre class="prettyprint lang-java"><span class="pln" style="color: rgb(0,0,0);">com</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" st
yle="color: rgb(0,0,0);">google</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">api</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">services</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">gmail</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">model</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="typ" style="color: rgb(102,0,102);">Thread</span></pre></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">list</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">userId</td><td colspan="1" rowspan="1" class="confluenceTd"><pre class="prettyprint lang-java"><span class="pln" style="color: rgb(0,0,0);">com</span><span class="pun" style="color: rgb(102,102,0)
;">.</span><span class="pln" style="color: rgb(0,0,0);">google</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">api</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">services</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">gmail</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">model</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="typ" style="color: rgb(102,0,102);">ListThreadsResponse</span></pre></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">modify</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">content, id, userId</td><td colspan="1" rowspan="1" class="confluenceTd"><pre class="prettyprint lang-java"><span class="pln" style="color: rgb(0,0,0)
;">com</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">google</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">api</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">services</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">gmail</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">model</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="typ" style="color: rgb(102,0,102);">Thread</span></pre></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">trash</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">id, userId</td><td colspan="1" rowspan="1" class="confluenceTd"> </td></tr><tr><td colspan="1" rowsp
an="1" class="confluenceTd">untrash</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">id, userId</td><td colspan="1" rowspan="1" class="confluenceTd"> </td></tr></tbody></table></div><h4 id="GoogleMail-URIOptionsforthreads">URI Options for <em>threads</em></h4><hr><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Name</th><th colspan="1" rowspan="1" class="confluenceTh">Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">content</td><td colspan="1" rowspan="1" class="confluenceTd">com.google.api.services.gmail.model.ModifyThreadRequest</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">id</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">userId</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr></tbody></table></div><h3 id="GoogleMail-7.E
ndpointPrefixusers">7. Endpoint Prefix <em>users</em></h3><hr><p>The following endpoints can be invoked with the prefix <code>users</code> as follows:</p><pre> google-mail://users/endpoint?[options]
+ </pre><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Endpoint</th><th colspan="1" rowspan="1" class="confluenceTh">Shorthand Alias</th><th colspan="1" rowspan="1" class="confluenceTh">Options</th><th colspan="1" rowspan="1" class="confluenceTh">Result Body Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">getProfile</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">userId</td><td colspan="1" rowspan="1" class="confluenceTd">com.google.api.services.gmail.model.Profile</td></tr></tbody></table></div><h4 id="GoogleMail-URIOptionsforusers">URI Options for <em>users</em></h4><hr><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Name</th><th colspan="1" rowspan="1" class="confluenceTh">Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">userId</td><td colspan="
1" rowspan="1" class="confluenceTd">String</td></tr></tbody></table></div><h3 id="GoogleMail-ConsumerEndpoints">Consumer Endpoints</h3><hr><p>Any of the producer endpoints can be used as a consumer endpoint. Consumer endpoints can use <a shape="rect" class="external-link" href="http://camel.apache.org/polling-consumer.html#PollingConsumer-ScheduledPollConsumerOptions">Scheduled Poll Consumer Options</a> with a <code>consumer.</code> 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.</p><h3 id="GoogleMail-MessageHeaders">Message Headers</h3><hr><p>Any URI option can be provided in a message header for producer endpoints with a <code>CamelGoogleMail.</code> prefix.</p><h3 id="GoogleMail-MessageBody">Message Body</h3><hr><p>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 <code>inBody</code> endpoint URI parameter. For endpoints that return an array or collection, a consumer endpoint will map every element to distinct messages.     </p></div>
+ </td>
+ <td valign="top">
+ <div class="navigation">
+ <div class="navigation_top">
+ <!-- NavigationBar -->
+<div class="navigation_bottom" id="navigation_bottom"><h3 id="Navigation-Overview"><a shape="rect" href="overview.html">Overview</a></h3><ul class="alternate"><li><a shape="rect" href="index.html">Home</a></li><li><a shape="rect" href="download.html">Download</a></li><li><a shape="rect" href="getting-started.html">Getting Started</a></li><li><a shape="rect" href="faq.html">FAQ</a></li></ul><h3 id="Navigation-Documentation"><a shape="rect" href="documentation.html">Documentation</a></h3><ul class="alternate"><li><a shape="rect" href="user-guide.html">User Guide</a></li><li><a shape="rect" href="manual.html">Manual</a></li><li><a shape="rect" href="books.html">Books</a></li><li><a shape="rect" href="tutorials.html">Tutorials</a></li><li><a shape="rect" href="examples.html">Examples</a></li><li><a shape="rect" href="cookbook.html">Cookbook</a></li><li><a shape="rect" href="architecture.html">Architecture</a></li><li><a shape="rect" href="enterprise-integration-patterns.html">Enterprise
Integration Patterns</a></li><li><a shape="rect" href="dsl.html">DSL</a></li><li><a shape="rect" href="components.html">Components</a></li><li><a shape="rect" href="data-format.html">Data Format</a></li><li><a shape="rect" href="languages.html">Languages</a></li><li><a shape="rect" href="security.html">Security</a></li><li><a shape="rect" href="security-advisories.html">Security Advisories</a></li></ul><h3 id="Navigation-Search">Search</h3><form enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box" action="http://www.google.com/cse">
+ <div>
+ <input type="hidden" name="cx" value="007878419884033443453:m5nhvy4hmyq">
+ <input type="hidden" name="ie" value="UTF-8">
+ <input type="text" name="q" size="21">
+ <input type="submit" name="sa" value="Search">
+ </div>
+</form>
+<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en"></script><h3 id="Navigation-Community"><a shape="rect" href="community.html">Community</a></h3><ul class="alternate"><li><a shape="rect" href="support.html">Support</a></li><li><a shape="rect" href="contributing.html">Contributing</a></li><li><a shape="rect" href="discussion-forums.html">Discussion Forums</a></li><li><a shape="rect" href="mailing-lists.html">Mailing Lists</a></li><li><a shape="rect" href="user-stories.html">User Stories</a></li><li><a shape="rect" href="news.html">News</a></li><li><a shape="rect" href="articles.html">Articles</a></li><li><a shape="rect" href="site.html">Site</a></li><li><a shape="rect" href="team.html">Team</a></li><li><a shape="rect" class="external-link" href="http://camel-extra.googlecode.com/" rel="nofollow">Camel Extra</a></li></ul><h3 id="Navigation-Developers"><a shape="rect" href="developers.html">Developers</a></h3><ul class="alternate"
><li><a shape="rect" href="developers.html">Developer Guide</a></li><li><a shape="rect" href="source.html">Source</a></li><li><a shape="rect" href="building.html">Building</a></li><li><a shape="rect" href="javadoc.html">JavaDoc</a></li><li><a shape="rect" href="irc-room.html">IRC Room</a></li></ul><h3 id="Navigation-ApacheSoftwareFoundation">Apache Software Foundation</h3><ul class="alternate"><li><a shape="rect" class="external-link" href="http://www.apache.org/licenses/">License</a></li><li><a shape="rect" class="external-link" href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li><li><a shape="rect" class="external-link" href="http://www.apache.org/foundation/thanks.html">Thanks</a></li><li><a shape="rect" class="external-link" href="http://www.apache.org/security/">Security</a></li></ul></div>
+ <!-- NavigationBar -->
+ </div>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+
+ <div class="bottom_red_bar"></div>
+ </div>
+ </div>
+ </div>
+</div>
+<div class="black_box">
+<div class="footer">
+ <div class="footer_l">
+ <div class="footer_r">
+ <div>
+ <a href="$base/privacy-policy.html">Privacy Policy</a> -
+ (<a href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=49578989">edit page</a>)
+ (<a href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=49578989&showComments=true&showCommentArea=true#addcomment">add comment</a>)
+ </div>
+ </div>
+ </div>
+</div>
+</div>
+</div>
+<div class="design_attribution">
+© 2004-2014 The Apache Software Foundation.
+<br>
+Apache Camel, Camel, Apache, the Apache feather logo, and the Apache Camel project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
+<br>
+<a href="http://hiramchirino.com">Graphic Design By Hiram</a>
+</div>
+
+<!-- Camel committers that would like access to the Analytics, send a note to private@camel.apache.org -->
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976253-1']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+</script>
+
+</body>
+</html>
+
+
Modified: websites/production/camel/content/hl7-dataformat.html
==============================================================================
--- websites/production/camel/content/hl7-dataformat.html (original)
+++ websites/production/camel/content/hl7-dataformat.html Fri Dec 5 12:20:48 2014
@@ -84,60 +84,41 @@
<tbody>
<tr>
<td valign="top" width="100%">
-<div class="wiki-content maincontent"><h3 id="HL7DataFormat-HL7DataFormat">HL7 DataFormat</h3>
-<p>The <a shape="rect" href="hl7.html">HL7</a> component ships with a HL7 data format that can be used to format between <code>String</code> and HL7 model objects. </p>
-<ul class="alternate"><li><code>marshal</code> = from Message to byte stream (can be used when returning as response using the HL7 MLLP codec)</li><li><code>unmarshal</code> = from byte stream to Message (can be used when receiving streamed data from the HL7 MLLP</li></ul>
-
-
-<p>To use the data format, simply instantiate an instance and invoke the marshal or unmarshal operation in the route builder:</p>
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
- DataFormat hl7 = new HL7DataFormat();
+<div class="wiki-content maincontent"><h3 id="HL7DataFormat-HL7DataFormat">HL7 DataFormat</h3><p>The <a shape="rect" href="hl7.html">HL7</a> component ships with a HL7 data format that can be used to marshal or unmarshal HL7 model objects.</p><ul class="alternate"><li><code>marshal</code> = from Message to byte stream (can be used when returning as response using the HL7 MLLP codec)</li><li><code>unmarshal</code> = from byte stream to Message (can be used when receiving streamed data from the HL7 MLLP</li></ul><p>To use the data format, simply instantiate an instance and invoke the marshal or unmarshal operation in the route builder:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[ DataFormat hl7 = new HL7DataFormat();
...
from("direct:hl7in").marshal(hl7).to("jms:queue:hl7out");
]]></script>
-</div></div>
-<p>In the sample above, the HL7 is marshalled from a HAPI Message object to a byte stream and put on a JMS queue.<br clear="none">
-The next example is the opposite:</p>
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
- DataFormat hl7 = new HL7DataFormat();
+</div></div><p>In the sample above, the HL7 is marshalled from a HAPI Message object to a byte stream and put on a JMS queue.<br clear="none"> The next example is the opposite:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[ DataFormat hl7 = new HL7DataFormat();
...
from("jms:queue:hl7out").unmarshal(hl7).to("patientLookupService");
]]></script>
-</div></div>
-<p>Here we unmarshal the byte stream into a HAPI Message object that is passed to our patient lookup service.</p>
-
- <div class="aui-message warning shadowed information-macro">
+</div></div><p>Here we unmarshal the byte stream into a HAPI Message object that is passed to our patient lookup service.</p> <div class="aui-message warning shadowed information-macro">
<p class="title">Segment separators</p>
<span class="aui-icon icon-warning">Icon</span>
<div class="message-content">
-
-<p>As of <strong>Camel 2.11</strong>, <code>unmarshal</code> does not automatically fix segment separators anymore by converting <code>\n</code> to <code>\r</code>. If you <br clear="none">
-need this conversion, <code>org.apache.camel.component.hl7.HL7#convertLFToCR</code> provides a handy <code>Expression</code> for this purpose.</p>
+ <p>As of <strong>Camel 2.11</strong>, <code>unmarshal</code> does not automatically fix segment separators anymore by converting <code>\n</code> to <code>\r</code>. If you <br clear="none"> need this conversion, <code>org.apache.camel.component.hl7.HL7#convertLFToCR</code> provides a handy <code>Expression</code> for this purpose.</p>
</div>
</div>
-
-
-<p>Notice there is a shorthand syntax in Camel for well-known data formats that is commonly used.<br clear="none">
-Then you don't need to create an instance of the <code>HL7DataFormat</code> object:</p>
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
- from("direct:hl7in").marshal().hl7().to("jms:queue:hl7out");
+ <div class="aui-message warning shadowed information-macro">
+ <p class="title">Charset</p>
+ <span class="aui-icon icon-warning">Icon</span>
+ <div class="message-content">
+ <p>As of <strong>Camel 2.14.1</strong>, both <code>marshal and unmarshal</code> consider the charset provided in the field <code>MSH-18</code>. If this field is empty, by default the charset contained in the corresponding Camel charset property/header is assumed. You can even change this default behavior by overriding the <code>guessCharsetName</code> method when inheriting from the <code>HL7DataFormat</code> class.</p>
+ </div>
+ </div>
+<p> </p><p>Notice there is a shorthand syntax in Camel for well-known data formats that is commonly used.<br clear="none"> Then you don't need to create an instance of the <code>HL7DataFormat</code> object:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[ from("direct:hl7in").marshal().hl7().to("jms:queue:hl7out");
from("jms:queue:hl7out").unmarshal().hl7().to("patientLookupService");
]]></script>
-</div></div>
-
- <div class="aui-message success shadowed information-macro">
+</div></div> <div class="aui-message success shadowed information-macro">
<p class="title">Serializable messages</p>
<span class="aui-icon icon-success">Icon</span>
<div class="message-content">
-
-<p>As of HAPI 2.0 (used by <strong>Camel 2.11</strong>), the HL7v2 model classes are fully serializable. So you can put HL7v2 messages directly into a JMS queue (i.e. without calling <code>marshal()</code> and read them again directly from the queue (i.e. without calling <code>unmarshal()</code>.</p>
+ <p>As of HAPI 2.0 (used by <strong>Camel 2.11</strong>), the HL7v2 model classes are fully serializable. So you can put HL7v2 messages directly into a JMS queue (i.e. without calling <code>marshal()</code> and read them again directly from the queue (i.e. without calling <code>unmarshal()</code>.</p>
</div>
- </div>
-
-</div>
+ </div></div>
</td>
<td valign="top">
<div class="navigation">