Red Hat Summit第61章 GoogleMail
GoogleMail コンポーネント
リンクのコピーリンクがクリップボードにコピーされました!
Camel 2.15 以降で利用可能
コンポーネントの説明
リンクのコピーリンクがクリップボードにコピーされました!
Google Mail コンポーネントは、Google Mail Web API 経由で Gmail へのアクセスを提供します。
Google Mail は OAuth 2.0 プロトコル を使用して Google アカウントを認証し、ユーザーデータへのアクセスを承認します。このコンポーネントを使用する前に、アカウントを作成し、OAuth クレデンシャル を生成 する必要があります。認証情報は、clientId、clientSecret、および refreshToken で設定されます。有効期間の長い refreshToken を生成するための便利なリソースは OAuth プレイグラウンドです。
Maven ユーザーは、このコンポーネントの pom.xml に以下の依存関係を追加する必要があります。
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-google-mail</artifactId>
<version>2.17.0.redhat-630xxx</version>
</dependency>
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-google-mail</artifactId>
<version>2.17.0.redhat-630xxx</version>
</dependency>URI 形式
リンクのコピーリンクがクリップボードにコピーされました!
GoogleMail コンポーネントは以下の URI 形式を使用します。
google-mail://endpoint-prefix/endpoint?[options]
google-mail://endpoint-prefix/endpoint?[options]
エンドポイント接頭辞は以下のいずれかになります。
- attachments
- ドラフト
- history
- labels
- messages
- threads
- users
GoogleMailComponent
リンクのコピーリンクがクリップボードにコピーされました!
GoogleMail コンポーネントは、以下のオプションで設定できます。これらのオプションは、タイプ
org.apache.camel.component.google.mail.GoogleMailConfiguration のコンポーネントの Bean プロパティー configuration を使用して提供できます。
| オプション | タイプ | |
|---|---|---|
accessToken
|
String
|
OAuth2 アクセストークン。通常、これは 1 時間後に期限切れになるため、長期間の使用には refreshToken が推奨されます。
|
applicationName
|
String
|
Google ドライブアプリケーション名。たとえば、camel-google-mail/1.0 です。
|
clientId
|
String
|
ドライブアプリケーションのクライアント ID。 |
clientSecret
|
String
|
ドライブアプリケーションのクライアントシークレット。 |
refreshToken
|
String
|
OAuth2 更新トークン。このトークンを使用すると、現在の有効期限が長い場合に Google Mail コンポーネントは新しい accessToken を取得できます。
|
scopes
|
List<String>
|
ドライブアプリケーションでユーザーアカウントに必要なパーミッションのレベルを指定します。詳細は、https://developers.google.com/gmail/api/auth/scopes を参照してください。 |
user
|
String
|
Camel 2.16.0: サービスアカウントフローでアプリケーションの権限を借用しようとするユーザーのメールアドレス。
|
p12FileName
|
String
|
Camel 2.16.0: Google サービスアカウントで使用する秘密鍵を持つ
.p12 ファイルの名前。
|
プロデューサーエンドポイント
リンクのコピーリンクがクリップボードにコピーされました!
プロデューサーエンドポイントはエンドポイント接頭辞を使用し、続いてエンドポイント名と以下で説明する関連オプションを使用できます。一部のエンドポイントには、短縮エイリアスを使用できます。エンドポイント URI には 接頭辞が含まれている必要があります。
必須ではないエンドポイントオプションは [] で示されます。エンドポイントに必須のオプションがない場合は、[] オプションのセットの 1 つを指定する必要があります。プロデューサーエンドポイントは、Camel Exchange In メッセージに含まれる値を持つ endpoint オプションの名前が含まれる必要がある特別なオプション
inBody を使用することもできます。
エンドポイントオプションは、エンドポイント URI またはメッセージヘッダーで動的に指定できます。メッセージヘッダー名は
CamelGoogleMail.<option> の形式である必要があります。inBody オプションはメッセージヘッダーを上書きすることに注意してください。つまり、エンドポイントオプション inBody=option は CamelGoogleMail.option ヘッダーを上書きすることに注意してください。
エンドポイントおよびオプションの詳細は、API ドキュメント( https://developers.google.com/gmail/api/v1/reference/)を参照してください。
1.エンドポイント接頭辞 アタッチメント
リンクのコピーリンクがクリップボードにコピーされました!
以下のエンドポイントは、以下のように接頭辞
attachments で呼び出すことができます。
google-mail://attachments/endpoint?[options]
google-mail://attachments/endpoint?[options]| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| get | id、messageId、userId | com.google.api.services.gmail.model.MessagePartBody |
添付の URI オプション
リンクのコピーリンクがクリップボードにコピーされました!
| 名前 | タイプ |
|---|---|
| id | 文字列 |
| messageId | 文字列 |
| userId | 文字列 |
2.エンドポイント接頭 辞ドラフト
リンクのコピーリンクがクリップボードにコピーされました!
以下のエンドポイントは、以下のように接頭辞
drafts で呼び出すことができます。
google-mail://drafts/endpoint?[options]
google-mail://drafts/endpoint?[options]| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| create | [mediaContent], content, userId |
com.google.api.services.gmail.model.Draft
|
|
| delete | id、userId | ||
| get | id、userId |
com.google.api.services.gmail.model.Draft
|
|
| list | userId |
com.google.api.services.gmail.model.ListDraftsResponse
|
|
| send | [mediaContent], content, userId |
com.google.api.services.gmail.model.Message
|
|
| update | [mediaContent]、content、id、userId |
com.google.api.services.gmail.model.Draft
|
ドラフトの URI オプション
リンクのコピーリンクがクリップボードにコピーされました!
| 名前 | タイプ |
|---|---|
| content | com.google.api.services.gmail.model.Draft |
| id | 文字列 |
| mediaContent | com.google.api.client.http.AbstractInputStreamContent |
| userId | 文字列 |
3.エンドポイント接頭辞の 履歴
リンクのコピーリンクがクリップボードにコピーされました!
以下のエンドポイントは、以下のように接頭辞
history で呼び出すことができます。
google-mail://history/endpoint?[options]
google-mail://history/endpoint?[options]| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| list | userId |
com.google.api.services.gmail.model.ListHistoryResponse
|
履歴の URI オプション
リンクのコピーリンクがクリップボードにコピーされました!
| 名前 | タイプ |
|---|---|
| userId | 文字列 |
4.エンドポイント接頭辞の ラベル
リンクのコピーリンクがクリップボードにコピーされました!
以下のエンドポイントは、以下のように接頭辞
labels で呼び出すことができます。
google-mail://labels/endpoint?[options]
google-mail://labels/endpoint?[options]| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| create | content, userId |
com.google.api.services.gmail.model.Label
|
|
| delete | id、userId | ||
| get | id、userId |
com.google.api.services.gmail.model.Label
|
|
| list | userId |
com.google.api.services.gmail.model.ListLabelsResponse
|
|
| patch | content、id、userId |
com.google.api.services.gmail.model.Label
|
|
| update | content、id、userId |
com.google.api.services.gmail.model.Label
|
ラベルの URI オプション
リンクのコピーリンクがクリップボードにコピーされました!
| 名前 | タイプ |
|---|---|
| content | com.google.api.services.gmail.model.Label |
| id | 文字列 |
| userId | 文字列 |
5.エンドポイント接頭辞 メッセージ
リンクのコピーリンクがクリップボードにコピーされました!
以下のエンドポイントは、以下のように接頭辞
messages で呼び出すことができます。
google-mail://messages/endpoint?[options]
google-mail://messages/endpoint?[options]| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| delete | id、userId | ||
| get | id、userId |
com.google.api.services.gmail.model.Message
|
|
| gmailImport | [mediaContent], content, userId |
com.google.api.services.gmail.model.Message
|
|
| insert | [mediaContent], content, userId |
com.google.api.services.gmail.model.Message
|
|
| list | userId |
com.google.api.services.gmail.model.ListMessagesResponse
|
|
| modify | id, modifyMessageRequest, userId |
com.google.api.services.gmail.model.Message
|
|
| send | [mediaContent], content, userId |
com.google.api.services.gmail.model.Message
|
|
| trash | id、userId |
|
|
| untrash | id、userId |
|
メッセージの URI オプション
リンクのコピーリンクがクリップボードにコピーされました!
| 名前 | タイプ |
|---|---|
| content | com.google.api.services.gmail.model.Message |
| id | 文字列 |
| mediaContent | com.google.api.client.http.AbstractInputStreamContent |
| modifyMessageRequest | com.google.api.services.gmail.model.ModifyMessageRequest |
| userId | 文字列 |
6.エンドポイント接頭辞 スレッド
リンクのコピーリンクがクリップボードにコピーされました!
以下のエンドポイントは、以下のように接頭辞
threads で呼び出すことができます。
google-mail://threads/endpoint?[options]
google-mail://threads/endpoint?[options]| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| delete | id、userId | ||
| get | id、userId |
com.google.api.services.gmail.model.Thread
|
|
| list | userId |
com.google.api.services.gmail.model.ListThreadsResponse
|
|
| modify | content、id、userId |
com.google.api.services.gmail.model.Thread
|
|
| trash | id、userId | ||
| untrash | id、userId |
スレッドの URI オプション
リンクのコピーリンクがクリップボードにコピーされました!
| 名前 | タイプ |
|---|---|
| content | com.google.api.services.gmail.model.ModifyThreadRequest |
| id | 文字列 |
| userId | 文字列 |
7.エンドポイント接頭辞 ユーザー
リンクのコピーリンクがクリップボードにコピーされました!
以下のエンドポイントは、以下のように接頭辞
users で呼び出すことができます。
google-mail://users/endpoint?[options]
google-mail://users/endpoint?[options]| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| getProfile | userId | com.google.api.services.gmail.model.Profile |
ユーザーの URI オプション
リンクのコピーリンクがクリップボードにコピーされました!
| 名前 | タイプ |
|---|---|
| userId | 文字列 |
コンシューマーエンドポイント
リンクのコピーリンクがクリップボードにコピーされました!
プロデューサーエンドポイントはいずれもコンシューマーエンドポイントとして使用できます。コンシューマーエンドポイントは、
consumer. 接頭辞が付い た Scheduled Poll Consumer オプション を使用して、エンドポイントの呼び出しをスケジュールできます。配列またはコレクションを返すコンシューマーエンドポイントは、要素ごとにエクスチェンジを 1 つ生成し、それらのルートはエクスチェンジごとに 1 回実行されます。
メッセージヘッダー
リンクのコピーリンクがクリップボードにコピーされました!
URI オプションは、
CamelGoogleMail. 接頭辞が付いたプロデューサーエンドポイントのメッセージヘッダーで指定できます。
メッセージボディー
リンクのコピーリンクがクリップボードにコピーされました!
すべての結果メッセージ本文は、GoogleMailComponent が使用する基礎となる API によって提供されるオブジェクトを使用します。プロデューサーエンドポイントは、
inBody エンドポイント URI パラメーターに受信メッセージボディーのオプション名を指定できます。配列またはコレクションを返すエンドポイントの場合、コンシューマーエンドポイントはすべての要素を個別のメッセージにマップします。
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}