33.3. コンポーネントオプション

bridgeErrorHandler (consumer)

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

false

boolean

closeFolder (consumer)

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

true

boolean

copyTo (consumer)

メールメッセージを処理した後、指定された名前のメールフォルダーにコピーできます。キー copyTo を含むヘッダーを使用して、この設定値をオーバーライドできます。これにより、実行時に設定されたフォルダー名にメッセージをコピーできます。

String

decodeFilename (consumer)

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

false

boolean

delete (consumer)

処理後にメッセージを削除します。これは、メールメッセージに DELETED フラグを設定することによって行われます。false の場合、代わりに SEEN フラグが設定されます。Camel 2.10 では、メールを削除するかどうかを決定するキー delete でヘッダーを設定することにより、この設定オプションをオーバーライドできます。

false

boolean

disconnect (consumer)

ポーリング後に consumer を切断するかどうか。有効にすると、各ポーリングで Camel が強制的に接続されます。

false

boolean

handleFailedMessage (consumer)

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

false

boolean

mimeDecodeHeaders (consumer)

このオプションは、メールヘッダーの透過的な MIME デコードとデプロイメントを有効にします。

false

boolean

moveTo (consumer)

メールメッセージを処理した後、指定された名前のメールフォルダーに移動できます。キー moveTo を含むヘッダーを使用して、この設定値をオーバーライドできます。これにより、実行時に設定されたフォルダー名にメッセージを移動できます。

String

peek (consumer)

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

true

boolean

skipFailedMessage (consumer)

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

false

boolean

unseen (consumer)

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

true

boolean

fetchSize (consumer (上級))

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

-1

int

folderName (consumer (上級))

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

INBOX

String

mapMailMessage (consumer (上級))

Camel が受信したメールメッセージを Camel の本文/ヘッダー/添付ファイルにマップするかどうかを指定します。true に設定すると、メールメッセージの本文は Camel IN メッセージの本文にマップされ、メールヘッダーは IN ヘッダーにマップされ、添付ファイルは Camel IN 添付メッセージにマップされます。このオプションが false に設定されている場合、IN メッセージには生の javax.mail.Message が含まれます。exchange.getIn ().getBody (javax.mail.Message.class) を呼び出して、この生のメッセージを取得できます。

true

boolean

bcc (producer)

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

String

cc (producer)

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

String

from (producer)

差出人の電子メールアドレス。

camel@localhost

String

lazyStartProducer (producer)

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

false

boolean

replyTo (producer)

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

String

subject (producer)

送信されるメッセージの件名。注: ヘッダーに件名を設定すると、このオプションよりも優先されます。

String

to (producer)

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

String

javaMailSender (producer (上級))

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

JavaMailSender

additionalJavaMailProperties (上級)

他のすべてのオプションに基づいて設定されたデフォルトプロパティーを追加/オーバーライドする追加の Java メールプロパティーを設定します。これは、いくつかの特別なオプションを追加する必要があるが、他のオプションはそのままにしておきたい場合に便利です。

プロパティー

alternativeBodyHeader (advanced)

代替電子メール本文を含む IN メッセージヘッダーのキーを指定します。たとえば、メールを text/html 形式で送信し、HTML 以外のメールクライアントに代替メール本文を提供する場合は、このキーをヘッダーとして使用して代替メール本文を設定します。

CamelMailAlternativeBody

String

attachmentsContentTransferEncodingResolver (上級)

カスタムの AttachmentsContentTransferEncodingResolver を使用して、添付ファイルに使用する content-type-encoding を解決するには。

AttachmentsContentTransferEncodingResolver

authenticator (上級)

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

MailAuthenticator

autowiredEnabled (上級)

自動ワイヤリングが有効になっているかどうか。これは、コンポーネントで設定される一致するタイプのインスタンスが 1 つあるかどうかを検出するためにレジストリーを検索することで、自動ワイアリングオプションに使用されます (オプションは自動ワイアとマーク付けされる必要があります)。これは、JDBC データソース、JMS 接続ファクトリー、AWS クライアントなどの自動設定に使用できます。

true

boolean

configuration (上級)

メール設定を設定します。

MailConfiguration

connectionTimeout (上級)

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

30000

int

contentType (advanced)

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

text/plain

String

contentTypeResolver (advanced)

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

ContentTypeResolver

debugMode (advanced)

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

false

boolean

ignoreUnsupportedCharset (上級)

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

false

boolean

ignoreUriScheme (advanced)

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

false

boolean

javaMailProperties (上級)

Java メールオプションを設定します。デフォルトのプロパティーをすべてクリアし、このメソッドに提供されているプロパティーのみを使用します。

プロパティー

session (上級)

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

Session

useInlineAttachments (上級)

ディスポジションインラインまたは添付を使用するかどうか。

false

boolean

headerFilterStrategy (filter)

カスタムの org.apache.camel.spi.HeaderFilterStrategy を使用して、Camel メッセージとの間でヘッダーをフィルターします。

HeaderFilterStrategy

password (セキュリティー)

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

String

sslContextParameters (security)

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

SSLContextParameters

useGlobalSslContextParameters (security)

グローバル SSL コンテキストパラメーターの使用を有効にします。

false

boolean

username (セキュリティー)

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

String