public class PFPOP3MailReceiver extends java.lang.Object implements PFComponent, PFProcessTerminateEventSource, PFDataCreateEventSource, PFXMLSerializable
このコンポーネントから以下のイベントが発生する。
トリガ | 対象データ | イベント番号 |
---|---|---|
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()
コンポーネントの文字列表現を取得する。
|
java.lang.Object |
getCredential()
認証情報オブジェクト(ユーザーIDとパスワード)を取得する。
|
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 |
setCredential(java.lang.Object credential)
認証情報オブジェクトを用いてユーザーIDとパスワードを設定する。
|
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出力.
|
public static final int AUTH_METHOD_POP3
public static final int AUTH_METHOD_APOP
public static final java.lang.String DEFAULT_SERVER_PORT_NO_SSL
public static final java.lang.String DEFAULT_SERVER_PORT_SSL
public java.lang.String getComponentName()
getComponentName
インタフェース内 PFComponent
public java.lang.String getComponentKey()
getComponentKey
インタフェース内 PFComponent
public void setComponentKey(java.lang.String key)
setComponentKey
インタフェース内 PFComponent
key
- コンポーネントキーpublic PFMultiLocaleString getComponentKeys()
public void setComponentKeys(PFMultiLocaleString keys)
keys
- 全ロケール分のコンポーネントキーpublic int getComponentID()
getComponentID
インタフェース内 PFComponent
public void setComponentID(int id)
PFComponentBus
から設定される。
各コンポーネント内では操作しないこと。setComponentID
インタフェース内 PFComponent
id
- 設定するコンポーネントIDpublic java.lang.String getComponentString()
getComponentString
インタフェース内 PFComponent
public java.lang.String getComponentPublicName()
getComponentPublicName
インタフェース内 PFComponent
public void setComponentPublicName(java.lang.String publicName) throws PFComponentException
setComponentPublicName
インタフェース内 PFComponent
publicName
- 設定するコンポーネント公開名PFComponentException
- 規約に反する名前が設定されようとした場合public boolean isAllowRemoteInvocation()
isAllowRemoteInvocation
インタフェース内 PFComponent
public void setAllowRemoteInvocation(boolean flag)
setAllowRemoteInvocation
インタフェース内 PFComponent
flag
- コンポーネント連携要求に対する可否public boolean isAllowPullTransfer()
isAllowPullTransfer
インタフェース内 PFComponent
public void setAllowPullTransfer(boolean flag)
setAllowPullTransfer
インタフェース内 PFComponent
flag
- Pull型コンポーネント転送要求に対する可否public boolean isAllowPushTransfer()
isAllowPushTransfer
インタフェース内 PFComponent
public void setAllowPushTransfer(boolean flag)
setAllowPushTransfer
インタフェース内 PFComponent
flag
- Push型コンポーネント転送要求に対する可否public java.util.Iterator getPFProcessTerminateListenerList()
getPFProcessTerminateListenerList
インタフェース内 PFProcessTerminateEventSource
public void addPFProcessTerminateListener(PFProcessTerminateListener lis)
addPFProcessTerminateListener
インタフェース内 PFProcessTerminateEventSource
lis
- 追加対象イベントリスナpublic void removePFProcessTerminateListener(PFProcessTerminateListener lis)
removePFProcessTerminateListener
インタフェース内 PFProcessTerminateEventSource
lis
- 削除対象イベントリスナpublic java.util.Iterator getPFDataCreateListenerList()
getPFDataCreateListenerList
インタフェース内 PFDataCreateEventSource
public void addPFDataCreateListener(PFDataCreateListener lis)
addPFDataCreateListener
インタフェース内 PFDataCreateEventSource
lis
- 追加対象イベントリスナpublic void removePFDataCreateListener(PFDataCreateListener lis)
removePFDataCreateListener
インタフェース内 PFDataCreateEventSource
lis
- 削除対象イベントリスナpublic void localeUpdated()
localeUpdated
インタフェース内 PFComponent
public void writeXML(PFXMLGenerator out) throws java.io.IOException
writeXML
インタフェース内 PFXMLSerializable
out
- XML出力ユーティリティjava.io.IOException
public void readXML(PFXMLLoader in)
readXML
インタフェース内 PFXMLSerializable
in
- XML入力ユーティリティpublic java.lang.String getServerAddress()
public void setServerAddress(java.lang.String serverAddress)
serverAddress
- IPアドレス/ホスト名(FQDN)public java.lang.String getServerPort()
public void setServerPort(java.lang.String serverPort)
serverPort
- ポート番号(文字列)public boolean isSslTlsEnabled()
public void setSslTlsEnabled(boolean sslTlsEnabled)
sslTlsEnabled
- SSL/TLS使用フラグpublic boolean isStartTlsEnabled()
public void setStartTlsEnabled(boolean startTlsEnabled)
startTlsEnabled
- STARTTLS使用フラグpublic boolean isStartTlsRequired()
public void setStartTlsRequired(boolean startTlsRequired)
startTlsRequired
- STARTTLS強制フラグpublic int getAuthMethod()
public void setAuthMethod(int authMethod)
authMethod
- 認証方法の種類public java.lang.String getAuthId()
public void setAuthId(java.lang.String authId)
authId
- ユーザID(認証なしの場合はnull可)public java.lang.String getAuthPassword()
public void setAuthPassword(java.lang.String authPassword)
authPassword
- パスワード(認証なしの場合はnull可)public void receiveMail(boolean doDeleteMailAfterReceive) throws PFException
doDeleteMailAfterReceive
- 受信後削除するかどうかPFExcption
- イベント処理中の例外PFException
public void receiveMailDigest() throws PFException
PFExcption
- イベント処理中の例外PFException
public void receiveMail(java.lang.String mailUIDL, boolean doDeleteMailAfterReceive) throws PFException
mailUIDL
- メールUIDLdoDeleteMailAfterReceive
- 受信後のメール削除(true=削除する,false=削除しない)PFException
public boolean authorize() throws PFException
PFException
- イベント処理中の例外public PFObjectTable getMailDigestTable()
public java.lang.Object getCredential()
public void setCredential(java.lang.Object credential)
credential
- 認証情報オブジェクト