メール受信(IMAP4)処理

オペレーション名

メール受信(IMAP4)

機能概要

IMAP4サーバからメールを受信します。

データモデル

本コンポーネントのデータモデルはテーブルモデル型です。
入出力のスキーマについては「スキーマ」を参照してください。

プロパティ

基本設定

項目名 必須/省略可 変数の使用 説明 補足
名前 必須 使用不可 スクリプトキャンバス上での名前を入力します。  

必須設定

項目名 必須/省略可 変数の使用 説明 補足
接続先 必須 使用不可 グローバルリソースを選択します。
グローバルリソースの設定方法については「グローバルリソースのプロパティ」を参照してください。
  • [追加]:
    新規にグローバルリソースを追加します。
  • [一覧の編集]:
    「リソース一覧の編集」プロパティにて、グローバルリソースの設定を編集することができます。
 
ユーザ名 必須 使用可 ユーザ名を入力します。  
パスワード 必須 使用可 パスワードを入力します。  
プロパティアクション
項目名 説明 補足
認証テスト 指定した[接続先]に対し、[ユーザ名][パスワード]でログインすることができるかテストを行います。
  • 以下の場合には[認証テスト]は無効になります。
    • [ユーザ名]または[パスワード]が入力されていない場合
    • [ユーザ名]または[パスワード]に変数が指定された場合

受信設定

項目名 必須/省略可 変数の使用 説明 補足
メール受信後 必須 使用不可 受信したメッセージをサーバから削除するかどうかを選択します。
  • [削除しない]:(デフォルト)
  • [削除する]:
 
受信後既読にする 省略可 使用不可 受信したメッセージを既読にするかどうかを選択します。
  • [チェックあり]:(デフォルト)
    受信したメッセージを既読にします。
  • [チェックなし]:
    受信したメッセージを既読にしません。
    受信前の状態が既読のメッセージは既読のままとなります。受信前の状態が未読のメッセージは未読のままになります。
  • 既読にするとはSEENフラグをマークするということを意味しています。
エンコード 省略可 使用可 メール受信時のエンコードを選択または入力します。
  • [日本語自動判別(JISAutoDetect)]:(デフォルト)
  • [日本語(JIS)]:
  • [日本語(シフトJIS)]:
  • [日本語(EUC)]:
  • [US-ASCII]:
  • [ISO 8859-1]:
  • [UTF-8]:
  • [EUC-KR]:
入力する場合は、J2SE Development Kit 5.0でサポートされているエンコードを指定することができます。
  • メッセージにエンコードが指定されている場合(Content-Typeヘッダのcharsetパラメータが設定されている場合)は、メッセージで指定されたエンコーディングを使用します。
  • 省略した場合には、「JIS」で受信します。
フォルダ名 省略可 使用可 受信するフォルダ名を入力します。
  • デフォルト値は「inbox」です。
  • 省略した場合には、「inbox」を受信します。
新着順に受信する 省略可 使用不可 新着順にメッセージを受信するかどうかを選択します。
  • [チェックあり]:
    新しくメールサーバに届いた順にメッセージを受信します。
  • [チェックなし]:(デフォルト)
    メールサーバに届いた順にメッセージを受信します。
 
最大受信件数を設定する 省略可 使用不可 メッセージの最大受信件数を指定するかどうかを選択します。
  • [チェックあり]:
    指定された件数を上限としてメッセージを受信します。
  • [チェックなし]:(デフォルト)
    すべてのメッセージを受信します。
 
最大受信件数 必須 使用可 メッセージの最大受信件数を指定します。
例えば、サーバにメッセージが100件格納されており、最大受信件数が10件に設定されている場合、先頭の10件のメッセージのみが受信され、残りの90件は未読の状態のままとなります。
  • [最大受信件数を設定する][チェックあり]にした場合、有効になります。
受信できないメッセージは読み飛ばす 省略可 使用不可 受信できないメッセージを受信した際の動作を選択します。
  • [チェックあり]:
    受信できないメッセージは読み飛ばし、処理を継続します。
  • [チェックなし]:(デフォルト)
    受信できないメッセージを受信した際には、エラーにします。
  • チェックを入れた場合には、メッセージ受信時にエラーが発生した際に、対象のメッセージの受信をスキップし、処理を継続します。
  • 接続できないホストを指定した場合などの接続時のエラーは、本プロパティにチェックを入れた場合でも処理が継続できないため、エラーとなります。
  • 受信できなかったメッセージはログレベル「WARN」でログに出力されます。
メールアドレスはアドレスのみ取得する 省略可 使用不可 メールアドレスが含まれるデータ(From、To、Cc、Reply-To)を取得する際に、
    「説明<メールアドレス>」
の形式で取得するか
    「メールアドレス」
の形式で取得するかを選択します。
  • [チェックあり]:
    「メールアドレス」の形式で取得します。
  • [チェックなし]:(デフォルト)
    「説明<メールアドレス>」の形式で取得します。
  • 説明部がない場合には「メールアドレス」のみとなります。
UIDを取得する 省略可 使用不可 UIDを取得するかどうかを選択します。
  • [チェックあり]:
    UIDを取得します。
  • [チェックなし]:(デフォルト)
    UIDを取得しません。
  • チェックを入れた場合には出力スキーマにUIDカラムが追加されます。詳細はスキーマを参照してください。

添付ファイル

項目名 必須/省略可 変数の使用 説明 補足
添付ファイルを受信 省略可 使用不可 添付ファイルを受信するかどうかを選択します。
  • [チェックあり]:(デフォルト)
    メッセージに添付されたファイルを受信します。
  • [チェックなし]:
    メッセージに添付されたファイルを受信しません。
 
添付ファイル格納先 必須 使用可 添付ファイルを格納するディレクトリを入力します。

[参照]ボタンを押下するとディレクトリチューザが起動し、ディレクトリの選択ができます。

格納された添付ファイルのパスの生成仕組みは${格納先}/${メッセージID}/添付ファイル名になります。
また、${メッセージID}はメールサーバで設定される可変値です。

格納先パラメータは/tmpに設定してtest.txtファイルを添付して送った場合、以下のように生成されます。
例:/tmp/18926678.1130237227441.JavaMail.account@mail.com/test.txt
  • デフォルト値は「/tmp」です。
  • [添付ファイルを受信][チェックあり]にした場合、有効になります。
  • 添付ファイル名・メッセージIDに「DataSpiderファイルシステムの禁止文字」またはタブが含まれる場合、「_」(半角アンダースコア)に変換して出力します。
  • ファイルパスはDataSpiderファイルシステムの絶対パスで指定してください。
  • パス区切り文字「/」以外のDataSpiderファイルシステムの使用禁止文字は使用できません。
添付ファイルに同じ名前のファイルが存在する場合 必須 使用不可 添付ファイルに同一名のファイルが存在する場合の動作を選択します。
  • [上書きする]:(デフォルト)
    ファイルを上書きします。
  • [連番を振る]:
    「<ファイル名>_1.csv」のように連番を付けます。拡張子がある場合は、拡張子の前の名前に連番が付与されます。
  • [添付ファイルを受信][チェックあり]にした場合、有効になります。

フィルタ

項目名 必須/省略可 変数の使用 説明 補足
未読メッセージのみ受信 省略可 使用不可 未読のメッセージ(SEENフラグがマークされていないメッセージ)のみ受信するかどうかを選択します。
  • [チェックあり]:
    未読のメッセージのみ受信します。
  • [チェックなし]:(デフォルト)
    全てのメッセージを受信します。
 

ヘッダ

項目名 必須/省略可 変数の使用 説明 補足
ヘッダ一覧 省略可
-
取得するヘッダを指定します。
  • ヘッダを設定した場合のスキーマ情報はスキーマを参照してください。
ヘッダ一覧/ヘッダ 必須 使用可 取得するヘッダのキーを入力します。
  • ダブルバイトのキー値は対応していません。
  • ヘッダ値がダブルバイトを含む場合には、ヘッダ値がRFC 2047準拠のエンコーディングがされている必要があります。

データ処理方式

項目名 必須/省略可 変数の使用 説明 補足
データ処理方式 必須 使用不可 データ処理方式を選択します。
  • [スクリプトの設定を使用する]:(デフォルト)
    スクリプトプロパティの大容量データ処理の設定をアダプタに使用します。
  • [大容量データ処理を行わない]:
    大容量データ処理を行いません。
  • [大容量データ処理を行う]:
    大容量データ処理を行います。
 

互換性

項目名 必須/省略可 変数の使用 説明 補足
1.5形式のデータを使用 省略可 使用不可 結果データのスキーマの形式を選択します。
  • [チェックあり]:
    DataSpider 1.5形式のスキーマで結果データを作成します。
  • [チェックなし]:(デフォルト)
    DataSpider Servista 2.0以降のスキーマで結果データを作成します。
 
XMLとして不正な文字を削除 省略可 使用不可 結果データ構築中にXMLとして不正な文字列が見つかった場合に自動的に削除するかどうかを選択します。
  • [チェックあり]:
    不正な文字を削除します。
  • [チェックなし]:(デフォルト)
    不正な文字を削除しません。
 
[互換性]タブは、マイグレーション・キットをインストールした場合のみ表示されます。
マイグレーションの懸念事項については、「マイグレーション制限事項および注意事項」を参照してください。

コメント

項目名 必須/省略可 変数の使用 説明 補足
コメント 省略可 使用不可 このアダプタの簡単な説明を記述することができます。
説明を記述すると、仕様書に反映させることができます。
 

スキーマ

<?xml version="1.0" encoding="UTF-8" ?>
 <table>
   <row>
     <column>a.メッセージID</column>
     <column>b.UID</column>  ← [UIDを取得する]を選択した場合に出現し、選択しなかった場合には出現しません。
     <column>c.送信日付(受信日付)</column>
     <column>d1.ヘッダ1</column>  ← [ヘッダ]を複数定義した場合には繰り返し、ヘッダを定義しない場合には出現しません。
     <column>d2.ヘッダ2</column>
       :
     <column>e.差出人</column>
     <column>f.宛先</column>
     <column>g.CC</column>
     <column>h.BCC</column>
     <column>i.返信先</column>
     <column>j.件名</column>
     <column>k.Contetnt-Type</column>
     <column>l.本文</column>
     <column>m.添付ファイルパス</column>
   </row>
   <row>  ← 複数メールの場合繰り返します。
     :
   </row>
 </table>

大容量データ処理

大容量データ処理に対応しています。

使用できるコンポーネント変数

コンポーネント変数名 説明
count 受信件数を返します。エラーが発生した場合にはnullを返します。
パラレルストリーミング処理使用時にはnullになります。
error_type エラーが発生したときに、エラーの種類を返します。
java.io.FileNotFoundExceptionというような形式で返されます。
エラーが発生しなかった時にはnullを返します。
バージョンにより、内容が変わる可能性があります。
error_message エラーが発生したときのエラーメッセージを返します。
バージョンにより、内容が変わる可能性があります。
error_trace エラーが発生したときのトレース情報を返します。
バージョンにより、内容が変わる可能性があります。

主な例外

例外名 原因 対策
ResourceNotFoundException
リソース定義が見つかりませんでした。名前:[]
[接続先]が指定されていません。 [接続先]を指定してください。
ResourceNotFoundException
リソース定義が見つかりませんでした。名前:[<グローバルリソース名>]
[接続先]で選択されたリソース定義が見つかりません。 [接続先]で指定したグローバルリソースを確認してください。
InvalidPropertyConfigurationException
<プロパティ名>が指定されていません。
[<プロパティ名>]が指定されていません。 [<プロパティ名>]を指定してください。
java.io.UnsupportedEncodingException [エンコード]に設定されたエンコードはサポートされません。 [エンコード]で指定したエンコードを確認してください。
javax.mail.AuthenticationFailedException: [ユーザ名]または[パスワード]が間違っています。 [ユーザ名]または[パスワード]を確認してください。
javax.mail.MessagingException:
ConnectionException
[ホスト名]で指定したホストとの接続に失敗しました。 [ホスト名][ポート番号]が間違っていないかを確認してください。 また、[ホスト名]で指定したホストでサービスが提供されているかどうかをかを確認してください。
javax.mail.MessagingException:
UnknownHostException
[ホスト名]で指定したホストが見つかりません。 [ホスト名]で指定したホスト名をを確認してください。