jp.go.aist.dmrc.platform.beans.mail
クラス PFPOP3MailReceiver

java.lang.Object
  jp.go.aist.dmrc.platform.beans.mail.PFPOP3MailReceiver

すべての実装されたインタフェース:

java.io.Serializable, PFComponent, PFXMLSerializable, PFDataCreateEventSource, PFEventSource, PFProcessTerminateEventSource

public class PFPOP3MailReceiver
extends java.lang.Object
implements PFComponent, PFProcessTerminateEventSource, PFDataCreateEventSource, PFXMLSerializable

POP3メール受信コンポーネント。
POP3でサーバからメールを取得する。
メール受信に成功するとデータ生成イベントが発生して、そのイベント内包データとして 取得したメールが設定される。
サーバとのPOP3通信は、その認証方法・暗号化を選択できる。

このコンポーネントから以下のイベントが発生する。

• データ生成イベント

  トリガ	対象データ	イベント番号
  receiveMail(boolean)を実行して、すべてのメールメッセージを正しく取得したとき	メール情報オブジェクトのリスト (PFObjectList)	0
  receiveMail(String,boolean)を実行して、指定したメールメッセージを正しく取得したとき	メール情報オブジェクト (PFMailInformation)	1
  receiveMailDigest()を実行して、メールダイジェスト情報を正しく取得したとき	メール情報オブジェクトのリスト (PFObjectList)	2
  メール受信に失敗したとき	エラーメッセージ (String)	-1

  
  
• 処理完了イベント

  トリガ	対象データ	イベント番号
  authorize()を実行して認証に成功したとき	null	0
  authorize()を実行して認証に失敗したとき	エラーメッセージ (String)	-1

関連項目:

直列化された形式

フィールドの概要

static int	AUTH_METHOD_APOP 認証方法 APOP。
static int	AUTH_METHOD_POP3 認証方法 POP3。
static java.lang.String	DEFAULT_SERVER_PORT_NO_SSL デフォルトサーバポート番号・SSLなし
static java.lang.String	DEFAULT_SERVER_PORT_SSL デフォルトサーバポート番号・SSLあり

コンストラクタの概要

PFPOP3MailReceiver()
デフォルトコンストラクタ。

メソッドの概要

void	addPFDataCreateListener(PFDataCreateListener lis) 引数で与えられたイベントリスナを登録し、 データ生成イベント発生時に処理を行う対象とする。
void	addPFProcessTerminateListener(PFProcessTerminateListener lis) 引数で与えられたイベントリスナを登録し、 処理完了イベント発生時に処理を行う対象とする。
boolean	authorize() 認証の実施。
java.lang.String	getAuthId() 認証情報（ユーザID）の取得。
int	getAuthMethod() 認証方法の取得。
java.lang.String	getAuthPassword() 認証情報（パスワード）の取得。
int	getComponentID() コンポーネントIDを取得する。
java.lang.String	getComponentKey() コンポーネントキーを取得する。
PFMultiLocaleString	getComponentKeys() 全ロケール分のコンポーネントキーを返す。
java.lang.String	getComponentName() コンポーネント名称を取得する。
java.lang.String	getComponentPublicName() コンポーネント公開名を取得する.
java.lang.String	getComponentString() コンポーネントの文字列表現を取得する。
PFObjectTable	getMailDigestTable() メールダイジェストのテーブルを取得する。
java.util.Iterator	getPFDataCreateListenerList() データ生成イベントリスナ配列を取得する。
java.util.Iterator	getPFProcessTerminateListenerList() 処理完了イベントリスナ配列を取得する。
java.lang.String	getServerAddress() POP3サーバアドレスの取得。
java.lang.String	getServerPort() POP3サーバのポート番号の取得。
boolean	isAllowPullTransfer() 他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowPushTransfer() 他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowRemoteInvocation() 他PFからのコンポーネント連携要求に対する可否属性を取得する.
boolean	isSslTlsEnabled() SSL/TLS使用有無の取得。
boolean	isStartTlsEnabled() STARTTLS使用有無の取得。
boolean	isStartTlsRequired() STARTTLS強制有無の取得。
void	localeUpdated() ロケール変更に対応する。
void	readXML(PFXMLLoader in) コンポーネントのXML入力.
void	receiveMail(boolean doDeleteMailAfterReceive) メール全受信。
void	receiveMail(java.lang.String mailUIDL, boolean doDeleteMailAfterReceive) メールを受信する。
void	receiveMailDigest() ダイジェスト受信。
void	removePFDataCreateListener(PFDataCreateListener lis) 引数で与えられたイベントリスナを削除し、 データ生成イベント発生時に処理を行う対象から外す。
void	removePFProcessTerminateListener(PFProcessTerminateListener lis) 引数で与えられたイベントリスナを削除し、 処理完了イベント発生時に処理を行う対象から外す。
void	setAllowPullTransfer(boolean flag) 他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.
void	setAllowPushTransfer(boolean flag) 他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.
void	setAllowRemoteInvocation(boolean flag) 他PFからのコンポーネント連携要求に対する可否属性を設定する.
void	setAuthId(java.lang.String authId) 認証情報（ユーザID）の設定。
void	setAuthMethod(int authMethod) 認証方法の設定。
void	setAuthPassword(java.lang.String authPassword) 認証情報（パスワード）の設定。
void	setComponentID(int id) コンポーネントIDを設定する。
void	setComponentKey(java.lang.String key) コンポーネントキーを設定する。
void	setComponentKeys(PFMultiLocaleString keys) 全ロケール分のコンポーネントキーを設定する。
void	setComponentPublicName(java.lang.String publicName) コンポーネント公開名を設定する.
void	setServerAddress(java.lang.String serverAddress) POP3サーバアドレスの設定。
void	setServerPort(java.lang.String serverPort) POP3サーバのポート番号の設定。
void	setSslTlsEnabled(boolean sslTlsEnabled) SSL/TLS使用有無の設定。
void	setStartTlsEnabled(boolean startTlsEnabled) STARTTLS使用有無の設定。
void	setStartTlsRequired(boolean startTlsRequired) STARTTLS強制有無の設定。
void	writeXML(PFXMLGenerator out) コンポーネントのXML出力.

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

AUTH_METHOD_POP3

public static final int AUTH_METHOD_POP3

認証方法 POP3。

関連項目:

定数フィールド値

AUTH_METHOD_APOP

public static final int AUTH_METHOD_APOP

認証方法 APOP。

関連項目:

定数フィールド値

DEFAULT_SERVER_PORT_NO_SSL

public static final java.lang.String DEFAULT_SERVER_PORT_NO_SSL

デフォルトサーバポート番号・SSLなし

関連項目:

定数フィールド値

DEFAULT_SERVER_PORT_SSL

public static final java.lang.String DEFAULT_SERVER_PORT_SSL

デフォルトサーバポート番号・SSLあり

関連項目:

定数フィールド値

コンストラクタの詳細

PFPOP3MailReceiver

public PFPOP3MailReceiver()

デフォルトコンストラクタ。

メソッドの詳細

getComponentName

public java.lang.String getComponentName()

コンポーネント名称を取得する。

定義:

インタフェース PFComponent 内の getComponentName

戻り値:

コンポーネント名

getComponentKey

public java.lang.String getComponentKey()

コンポーネントキーを取得する。

定義:

インタフェース PFComponent 内の getComponentKey

戻り値:

コンポーネントキー

setComponentKey

public void setComponentKey(java.lang.String key)

コンポーネントキーを設定する。

定義:

インタフェース PFComponent 内の setComponentKey

パラメータ:

key - コンポーネントキー

getComponentKeys

public PFMultiLocaleString getComponentKeys()

全ロケール分のコンポーネントキーを返す。

戻り値:

全ロケール分のコンポーネントキー

setComponentKeys

public void setComponentKeys(PFMultiLocaleString keys)

全ロケール分のコンポーネントキーを設定する。

パラメータ:

keys - 全ロケール分のコンポーネントキー

getComponentID

public int getComponentID()

コンポーネントIDを取得する。

定義:

インタフェース PFComponent 内の getComponentID

戻り値:

コンポーネントID

setComponentID

public void setComponentID(int id)

コンポーネントIDを設定する。
コンポーネントIDはプラットフォームPFComponentBusから設定される。 各コンポーネント内では操作しないこと。

定義:

インタフェース PFComponent 内の setComponentID

パラメータ:

id - 設定するコンポーネントID

getComponentString

public java.lang.String getComponentString()

コンポーネントの文字列表現を取得する。
形式："Component Name" [ ID : "ID" ]

定義:

インタフェース PFComponent 内の getComponentString

戻り値:

文字列表現

getComponentPublicName

public java.lang.String getComponentPublicName()

コンポーネント公開名を取得する.

定義:

インタフェース PFComponent 内の getComponentPublicName

戻り値:

コンポーネント公開名

setComponentPublicName

public void setComponentPublicName(java.lang.String publicName)
                            throws PFComponentException

コンポーネント公開名を設定する.
空文字のみの公開名は、nullに置き換える。数字のみの公開名は許可しない。 また、既存コンポーネントとの重複も認めない.

定義:

インタフェース PFComponent 内の setComponentPublicName

パラメータ:

publicName - 設定するコンポーネント公開名

例外:

PFComponentException - 規約に反する名前が設定されようとした場合

isAllowRemoteInvocation

public boolean isAllowRemoteInvocation()

他PFからのコンポーネント連携要求に対する可否属性を取得する.

定義:

インタフェース PFComponent 内の isAllowRemoteInvocation

戻り値:

コンポーネント連携要求可否属性

setAllowRemoteInvocation

public void setAllowRemoteInvocation(boolean flag)

他PFからのコンポーネント連携要求に対する可否属性を設定する.

定義:

インタフェース PFComponent 内の setAllowRemoteInvocation

パラメータ:

flag - コンポーネント連携要求に対する可否

isAllowPullTransfer

public boolean isAllowPullTransfer()

他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.

定義:

インタフェース PFComponent 内の isAllowPullTransfer

戻り値:

Pull型コンポーネント転送要求可否属性

setAllowPullTransfer

public void setAllowPullTransfer(boolean flag)

他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.

定義:

インタフェース PFComponent 内の setAllowPullTransfer

パラメータ:

flag - Pull型コンポーネント転送要求に対する可否

isAllowPushTransfer

public boolean isAllowPushTransfer()

他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.

定義:

インタフェース PFComponent 内の isAllowPushTransfer

戻り値:

Push型コンポーネント転送要求可否属性

setAllowPushTransfer

public void setAllowPushTransfer(boolean flag)

他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.

定義:

インタフェース PFComponent 内の setAllowPushTransfer

パラメータ:

flag - Push型コンポーネント転送要求に対する可否

getPFProcessTerminateListenerList

public java.util.Iterator getPFProcessTerminateListenerList()

処理完了イベントリスナ配列を取得する。

定義:

インタフェース PFProcessTerminateEventSource 内の getPFProcessTerminateListenerList

戻り値:

イベントリスナイテレータ

addPFProcessTerminateListener

public void addPFProcessTerminateListener(PFProcessTerminateListener lis)

引数で与えられたイベントリスナを登録し、 処理完了イベント発生時に処理を行う対象とする。

定義:

インタフェース PFProcessTerminateEventSource 内の addPFProcessTerminateListener

パラメータ:

lis - 追加対象イベントリスナ

removePFProcessTerminateListener

public void removePFProcessTerminateListener(PFProcessTerminateListener lis)

引数で与えられたイベントリスナを削除し、 処理完了イベント発生時に処理を行う対象から外す。

定義:

インタフェース PFProcessTerminateEventSource 内の removePFProcessTerminateListener

パラメータ:

lis - 削除対象イベントリスナ

getPFDataCreateListenerList

public java.util.Iterator getPFDataCreateListenerList()

データ生成イベントリスナ配列を取得する。

定義:

インタフェース PFDataCreateEventSource 内の getPFDataCreateListenerList

戻り値:

イベントリスナイテレータ

addPFDataCreateListener

public void addPFDataCreateListener(PFDataCreateListener lis)

引数で与えられたイベントリスナを登録し、 データ生成イベント発生時に処理を行う対象とする。

定義:

インタフェース PFDataCreateEventSource 内の addPFDataCreateListener

パラメータ:

lis - 追加対象イベントリスナ

removePFDataCreateListener

public void removePFDataCreateListener(PFDataCreateListener lis)

引数で与えられたイベントリスナを削除し、 データ生成イベント発生時に処理を行う対象から外す。

定義:

インタフェース PFDataCreateEventSource 内の removePFDataCreateListener

パラメータ:

lis - 削除対象イベントリスナ

localeUpdated

public void localeUpdated()

ロケール変更に対応する。

定義:

インタフェース PFComponent 内の localeUpdated

writeXML

public void writeXML(PFXMLGenerator out)
              throws java.io.IOException

コンポーネントのXML出力.

定義:

インタフェース PFXMLSerializable 内の writeXML

パラメータ:

out - XML出力ユーティリティ

例外:

java.io.IOException

readXML

public void readXML(PFXMLLoader in)

コンポーネントのXML入力.

定義:

インタフェース PFXMLSerializable 内の readXML

パラメータ:

in - XML入力ユーティリティ

getServerAddress

public java.lang.String getServerAddress()

POP3サーバアドレスの取得。

戻り値:

アドレス

setServerAddress

public void setServerAddress(java.lang.String serverAddress)

POP3サーバアドレスの設定。

パラメータ:

serverAddress - IPアドレス/ホスト名（FQDN）

getServerPort

public java.lang.String getServerPort()

POP3サーバのポート番号の取得。

戻り値:

ポート番号(文字列)

setServerPort

public void setServerPort(java.lang.String serverPort)

POP3サーバのポート番号の設定。
ポート番号が未指定の場合、110（SSL/TLS未使用時）もしくは995（SSL/TLS使用時）を使用する。

パラメータ:

serverPort - ポート番号(文字列)

isSslTlsEnabled

public boolean isSslTlsEnabled()

SSL/TLS使用有無の取得。

戻り値:

SSL/TLS使用フラグ

setSslTlsEnabled

public void setSslTlsEnabled(boolean sslTlsEnabled)

SSL/TLS使用有無の設定。

パラメータ:

sslTlsEnabled - SSL/TLS使用フラグ

isStartTlsEnabled

public boolean isStartTlsEnabled()

STARTTLS使用有無の取得。

戻り値:

STARTTLS使用フラグ

setStartTlsEnabled

public void setStartTlsEnabled(boolean startTlsEnabled)

STARTTLS使用有無の設定。

パラメータ:

startTlsEnabled - STARTTLS使用フラグ

isStartTlsRequired

public boolean isStartTlsRequired()

STARTTLS強制有無の取得。

戻り値:

STARTTLS強制フラグ

setStartTlsRequired

public void setStartTlsRequired(boolean startTlsRequired)

STARTTLS強制有無の設定。

パラメータ:

startTlsRequired - STARTTLS強制フラグ

getAuthMethod

public int getAuthMethod()

認証方法の取得。
認証方法の種類は
0 = 通常のPOP3
1 = APOP3

戻り値:

認証方法の種類

setAuthMethod

public void setAuthMethod(int authMethod)

認証方法の設定。
認証方法の種類は
0 = 通常のPOP3
1 = APOP3

パラメータ:

authMethod - 認証方法の種類

getAuthId

public java.lang.String getAuthId()

認証情報（ユーザID）の取得。

戻り値:

ユーザID（認証なしの場合はnull可）

setAuthId

public void setAuthId(java.lang.String authId)

認証情報（ユーザID）の設定。

パラメータ:

authId - ユーザID（認証なしの場合はnull可）

getAuthPassword

public java.lang.String getAuthPassword()

認証情報（パスワード）の取得。

戻り値:

パスワード（認証なしの場合はnull可）

setAuthPassword

public void setAuthPassword(java.lang.String authPassword)

認証情報（パスワード）の設定。

パラメータ:

authPassword - パスワード（認証なしの場合はnull可）

receiveMail

public void receiveMail(boolean doDeleteMailAfterReceive)
                 throws PFException

メール全受信。
すべてのメッセージを取得する。
結果（複数のメール情報）を格納した PFObjectListを内包した データ生成イベントを発生する。
エラー時はイベント内包データがエラーメッセージ（String）となる。

パラメータ:

doDeleteMailAfterReceive - 受信後削除するかどうか

例外:

PFExcption - イベント処理中の例外

PFException

receiveMailDigest

public void receiveMailDigest()
                       throws PFException

ダイジェスト受信。
メールのヘッダとメールサイズだけを取得する。
結果（複数の本文のないメール情報）を格納したPFObjectListを 内包したデータ生成イベントを発生する。
エラー時はイベント内包データがエラーメッセージ（String）となる。

例外:

PFExcption - イベント処理中の例外

PFException

receiveMail

public void receiveMail(java.lang.String mailUIDL,
                        boolean doDeleteMailAfterReceive)
                 throws PFException

メールを受信する。
指定したメッセージを取得する。結果（メール情報）を内包したデータ生成イベントを発生する。

パラメータ:

mailUIDL - メールUIDL

doDeleteMailAfterReceive - 受信後のメール削除（true=削除する,false=削除しない）

例外:

PFException

authorize

public boolean authorize()
                  throws PFException

認証の実施。
戻り値で成否を返す。失敗にはエラーも含む。
処理完了イベントが発生する

• イベント番号:0（成功）or 1（失敗）
• イベント内包データはnull

戻り値:

処理結果（成功:true、失敗：false）

例外:

PFException - イベント処理中の例外

getMailDigestTable

public PFObjectTable getMailDigestTable()

メールダイジェストのテーブルを取得する。 テーブルの列名と型は、差出人(String)、宛先(String)、CC(String)、返信先(String)、件名(String)、送信日時(Date)、 サイズ(Integer)、UIDL(String)の順。

戻り値:

メールダイジェストのテーブル