31.4.2. クエリーパラメーター (66 パラメーター)

bridgeErrorHandler (コンシューマー)

コンシューマーの Camel ルーティングエラーハンドラーへのブリッジを許可します。よって、コンシューマーが受信メッセージなどの取得を試行している間に発生した例外は、メッセージとして処理され、ルーティングエラーハンドラーによって処理されます。デフォルトでは、コンシューマーは org.apache.camel.spi.ExceptionHandler を使用して例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。

false

boolean

closeFolder (コンシューマー)

ポーリング後にコンシューマーがフォルダーを閉じるかどうか。このオプションを false に設定して disconnect=false も持つと、コンシューマーはポーリング間でフォルダーを開いたままにします。

true

boolean

copyTo (コンシューマー)

メールメッセージの処理後、指定した名前のメールフォルダーにコピーできます。この設定値をキー copyTo で上書きすると、実行時に設定されたフォルダー名にメッセージをコピーできます。

文字列

decodeFilename (consumer)

true に設定すると、MimeUtility.decodeText メソッドを使用してファイル名をデコードします。これは、JVM システムプロパティー mail.mime.encodefilename の設定に似ています。

false

boolean

delete (コンシューマー)

処理後にメッセージを削除します。これには、メールメッセージに DELETED フラグを設定します。false の場合、代わりに SEEN フラグが設定されます。Camel 2.10 以降では、ヘッダーにキー delete を設定して、メールを削除するかどうかを決定します。

false

boolean

disconnect (コンシューマー)

ポーリング後にコンシューマーが切断されるべきかどうか。これを有効にすると、Camel がポーリングごとに強制的に接続します。

false

boolean

handleFailedMessage (コンシューマー)

メールコンシューマーが指定のメールメッセージを取得できない場合、このオプションはコンシューマーのエラーハンドラーによって原因となった例外を処理できるようにします。コンシューマーでブリッジエラーハンドラーを有効にすると、Camel ルーティングエラーハンドラーは代わりに例外を処理できます。デフォルトの動作では、コンシューマーが例外を出力し、バッチからのメールは Camel によってルーティングできません。

false

boolean

maxMessagesPerPoll (コンシューマー)

ポーリングごとに収集するメッセージの最大数を指定します。デフォルトでは最大値は設定されていません。たとえば、1000 などの制限を設定して、サーバーの起動時に数千のファイルがダウンロードされないようにすることができます。このオプションを無効にするには、0 または負の値を設定します。

int

mimeDecodeHeaders (コンシューマー)

このオプションにより、メールヘッダーの透過的な MIME デコードおよびアン折りが有効になります。

false

boolean

moveTo (コンシューマー)

メールメッセージの処理後、指定した名前のメールフォルダーに移動できます。この設定値を上書きするには、キー moveTo でヘッダーを使用します。これにより、ランタイムで設定されたフォルダー名にメッセージを移動できます。

文字列

peek (コンシューマー)

メールメッセージを処理する前に、javax.mail.Message に peeked のマークを付けます。これは IMAPMessage メッセージタイプにのみ適用されます。peek を使用すると、メールはメールサーバーで SEEN とマークされません。これにより、Camel でエラー処理がある場合にメールメッセージをロールバックできます。

true

boolean

sendEmptyMessageWhenIdle (consumer)

ポーリングコンシューマーがファイルをポーリングしなかった場合、このオプションを有効にして、代わりに空のメッセージ (ボディーなし) を送信できます。

false

boolean

skipFailedMessage (コンシューマー)

メールコンシューマーが指定のメールメッセージを取得できない場合、このオプションを使用するとメッセージをスキップして次のメールメッセージを取得できます。デフォルトの動作では、コンシューマーが例外を出力し、バッチからのメールは Camel によってルーティングできません。

false

boolean

unseen (コンシューマー)

未確認のメールのみで制限するかどうか。

true

boolean

exceptionHandler (コンシューマー (上級))

コンシューマーによるカスタム ExceptionHandler の使用を許可します。bridgeErrorHandler オプションが有効な場合は、このオプションは使用されないことに注意してください。デフォルトでは、コンシューマーは例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。

ExceptionHandler

exchangePattern (コンシューマー (上級))

コンシューマーがエクスチェンジを作成する際に交換パターンを設定します。

列挙値:

ExchangePattern

fetchSize (コンシューマー (上級))

ポーリング中に消費するメッセージの最大数を設定します。メールボックスフォルダーに多くのメッセージが含まれる場合、これを使用してメールサーバーの過負荷を回避することができます。デフォルト値の -1 は、フェッチサイズがなく、すべてのメッセージが消費されることを意味します。値を 0 に設定すると、Camel はメッセージをまったく消費しません。

-1

int

folderName (コンシューマー (上級))

ポーリングするフォルダー。

INBOX

文字列

mailUidGenerator (コンシューマー (上級))

カスタムロジックを使用してメールメッセージの UUID を生成できるようにするプラグ可能な MailUidGenerator。

MailUidGenerator

mapMailMessage (コンシューマー (上級))

Camel が受信したメールメッセージを Camel body/headers/attachments にマップするかどうかを指定します。true に設定すると、メールメッセージのボディーは Camel IN メッセージのボディーにマッピングされ、メールヘッダーは IN ヘッダーにマッピングされ、添付ファイルは Camel IN アタッチメントメッセージにマッピングされます。このオプションを false に設定すると、IN メッセージには生の javax.mail.Message が含まれます。exchange.getIn （）.getBody (javax.mail.Message.class)を呼び出すことで、この raw メッセージを取得できます。

true

boolean

pollStrategy (コンシューマー (上級))

プラグ可能な org.apache.camel.PollingConsumerPollingStrategy を使用すると、エクスチェンジが作成され、Camel でルーティングされる前に、通常はポーリング操作中に発生するエラー処理を制御するカスタム実装が提供できます。

PollingConsumerPollStrategy

postProcessAction (consumer (advanced))

通常の処理が終了すると、メールボックスで後処理タスクを実行する MailBoxPostProcessAction を参照します。

MailBoxPostProcessAction

bcc (プロデューサー)

BCC メールアドレスを設定します。複数の電子メールアドレスはコンマで区切ります。

文字列

cc (プロデューサー)

CC メールアドレスを設定します。複数の電子メールアドレスはコンマで区切ります。

文字列

from (プロデューサー)

from メールアドレス。

camel@localhost

文字列

lazyStartProducer (producer)

最初のメッセージでプロデューサーをレイジーに起動すべきかどうか。レイジーに起動することで、起動時にプロデューサーが失敗し、それによりルートが失敗する可能性がある状況で、CamelContext およびルートの起動を許可します。レイジーな起動を延期すると、Camel のルーティングエラーハンドラー経由でメッセージのルーティング中に起動の失敗を処理できます。最初のメッセージが処理されるときに、プロデューサーの作成および起動に若干時間がかかり、合計処理時間が長くなる可能性があることに注意してください。

false

boolean

replyTo (プロデューサー)

Reply-To 受信者（応答メールの受信側）。複数のメールアドレスはコンマで区切ります。

文字列

subject (プロデューサー)

送信されるメッセージの Subject。注記：ヘッダーにサブジェクトを設定することは、このオプションよりも優先されます。

文字列

to (プロデューサー)

To メールアドレスを設定します。複数の電子メールアドレスはコンマで区切ります。

文字列

javaMailSender (プロデューサー (上級))

メールの送信にカスタムの org.apache.camel.component.mail.JavaMailSender を使用するには、以下を行います。

JavaMailSender

additionalJavaMailProperties (上級)

他のすべてのオプションに基づいて設定されるデフォルトのプロパティーを追加/上書きする追加の java メールプロパティーを設定します。これは、特別なオプションを追加する必要があるが、そのまま他のオプションを保持する必要がある場合に便利です。

プロパティー

alternativeBodyHeader (上級)

代替メールボディーが含まれる IN メッセージヘッダーへのキーを指定します。たとえば、テキスト/html 形式でメールを送信し、HTML 以外のメールクライアント用に代替メール本文を提供する場合は、別のメール本文をヘッダーとして設定します。

CamelMailAlternativeBody

文字列

attachmentsContentTransferEncodingResolver (advanced)

カスタムAttachmentsContentTransferEncodingResolver を使用して、添付に使用する content-type-encoding を解決するには、以下を行います。

AttachmentsContentTransferEncodingResolver

authenticator (上級)

ログインのオーセンティケーター。設定すると、パスワードとユーザー名は無視されます。期限切れとなる可能性のあるトークンに使用することができるため、動的に読み取る必要があります。

MailAuthenticator

binding (上級)

Camel メッセージからメールメッセージとの間で変換するために使用されるバインディングを設定します。

MailBinding

connectionTimeout (上級)

ミリ秒単位の接続タイムアウト。

30000

int

contentType (上級)

メールメッセージのコンテンツタイプ。HTML メールには text/html を使用します。

text/plain

文字列

contentTypeResolver (上級)

添付ファイルの Content-Type を決定するリゾルバー。

ContentTypeResolver

debugMode (上級)

基礎となるメールフレームワークでデバッグモードを有効にします。SUN Mail フレームワークは、デフォルトでデバッグメッセージを System.out に記録します。

false

boolean

headerFilterStrategy (上級)

カスタムの org.apache.camel.spi.HeaderFilterStrategy を使用してヘッダーをフィルターリングします。

HeaderFilterStrategy

ignoreUnsupportedCharset (上級)

メール送信時にローカル JVM でサポートされていない文字セットを Camel が無視できるようにするオプション。文字セットがサポートされていない場合は、charset=XXX (XXX はサポートされていない文字セットを表す) が content-type から削除され、代わりにプラットフォームのデフォルトに依存します。

false

boolean

ignoreUriScheme (上級)

メール送信時にローカル JVM でサポートされていない文字セットを Camel が無視できるようにするオプション。文字セットがサポートされていない場合は、charset=XXX (XXX はサポートされていない文字セットを表す) が content-type から削除され、代わりにプラットフォームのデフォルトに依存します。

false

boolean

javaMailProperties (advanced)

java メールオプションを設定します。デフォルトのプロパティーを削除し、このメソッドに指定されたプロパティーのみを使用します。

プロパティー

session (上級)

すべてのメール対話に camel が使用するメールセッションを指定します。JavaEE コンテナーなどの他のリソースによってメールセッションが作成および管理されるシナリオに役立ちます。カスタムメールセッションを使用する場合は、メールセッションのホスト名とポートが使用されます（セッションに設定されている場合）。

Session

useInlineAttachments (上級)

インラインまたは添付の設定を使用するかどうか。

false

boolean

idempotentRepository (フィルター)

同じメールボックスから消費するクラスターを可能にするプラグ可能なリポジトリー org.apache.camel.spi.IdempotentRepository。また、コンシューマーの処理にメールメッセージが有効であるかどうかをリポジトリーが調整できるようにします。デフォルトでは、リポジトリーは使用されません。

IdempotentRepository

idempotentRepositoryRemoveOnCommit (filter)

べき等リポジトリーを使用する場合、メールメッセージが正常に処理され、コミットされると、メッセージ ID がべき等リポジトリー（デフォルト）から削除されるか、リポジトリーに保存されます。デフォルトでは、はメッセージ ID が一意であり、リポジトリーに格納される値がないことを前提としています。これは、メールメッセージが再度消費されないように seen/moved または deleted とマークされるためです。そのため、メッセージ ID がべき等リポジトリーに保存されるため、値はほとんどありません。ただし、このオプションを使用すると、任意の理由でメッセージ ID を保存できます。

true

boolean

searchTerm (フィルター)

javax.mail.search.SearchTerm を参照します。これにより、特定の日付以降に送信されたサブジェクト、ボディー、送信元などの検索条件に基づいてメールをフィルターリングできます。

SearchTerm

backoffErrorThreshold (スケジューラー)

backoffMultipler が開始する前に発生する必要がある後続のエラーポーリング (エラーによって失敗した) の数。

int

backoffIdleThreshold (スケジューラー)

backoffMultipler が開始する前に発生する必要がある後続のアイドルポーリングの数。

int

backoffMultiplier (スケジューラー)

後続のアイドル状態/エラーが連続して発生した場合に、スケジュールされたポーリングコンシューマーのバックオフを許可します。乗数は、実際に次の試行が行われる前にスキップされるポーリングの数です。このオプションが使用されている場合は、backoffIdleThreshold や backoffErrorThreshold も設定する必要があります。

int

delay (スケジューラー)

次のポーリングまでの時間 (ミリ秒単位)。

60000

long

greedy (スケジューラー)

greedy が有効で、以前の実行が 1 つ以上のメッセージをポーリングした場合、ScheduledPollConsumer は即座に再度実行されます。

false

boolean

initialDelay (スケジューラー)

最初のポーリングが開始されるまでの時間 (ミリ秒単位)。

1000

long

repeatCount (スケジューラー)

実行の最大数を指定します。そのため、これを 1 に設定するとスケジューラーは 1 度だけ実行されます。これを 5 に設定した場合、5 回だけ実行されます。0 または負の値を設定すると、無制限に実行されます。

0

long

runLoggingLevel (scheduler)

コンシューマーはポーリング時に開始/完了のログ行を記録します。このオプションを使用すると、ログレベルを設定できます。

列挙値:

TRACE

LoggingLevel

scheduledExecutorService (スケジューラー)

コンシューマーに使用するカスタム/共有スレッドプールを設定できます。デフォルトでは、各コンシューマーに独自の単一スレッドのスレッドプールがあります。

ScheduledExecutorService

scheduler (スケジューラー)

camel-spring または camel-quartz コンポーネントから cron スケジューラーを使用します。スケジューラーにビルドされた値 spring または quartz を使用。

none

オブジェクト

schedulerProperties (スケジューラー)

カスタムスケジューラーまたは Quartz や Spring ベースのスケジューラーを使用する場合に、追加のプロパティーを設定します。

マップ

startScheduler (スケジューラー)

スケジューラーを自動起動するかどうか。

true

boolean

timeUnit (スケジューラー)

initialDelay および delay オプションの時間単位。

列挙値:

MILLISECONDS

TimeUnit

useFixedDelay (スケジューラー)

固定遅延または固定レートを使用するかどうかを制御します。詳細は、JDK の ScheduledExecutorService を参照してください。

true

boolean

password (セキュリティー)

ログインのパスワード。setAuthenticator (MailAuthenticator) も参照してください。

文字列

sslContextParameters (security)

SSLContextParameters を使用してセキュリティーを設定する場合。

SSLContextParameters

username (セキュリティー)

ログイン用のユーザー名。setAuthenticator (MailAuthenticator) も参照してください。

文字列

sortTerm (並べ替え)

メッセージのソート順序。IMAP でのみネイティブにサポートされます。POP3 を使用する場合、または IMAP サーバーに SORT 機能がない場合など、ある程度エミュレートされます。

SortTerm[]