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

java.lang.Object
  上位を拡張 jp.go.aist.dmrc.platform.beans.util.variable.PFVariable
      上位を拡張 jp.go.aist.dmrc.platform.beans.mail.PFMailInformationVariable
すべての実装されたインタフェース:
java.io.Serializable, PFComponent, PFXMLSerializable, PFDataSetEventSource, PFEventSource

public class PFMailInformationVariable
extends PFVariable
implements PFComponent, PFXMLSerializable

メール情報格納変数。
POP3メール受信コンポーネントが送信するデータ生成イベントの内包データに設定された メールメッセージを保持して、その内容にアクセスするAPIを提供する。

ヘッダ:キーを指定して任意ヘッダを取得、もしくは特別に用意されたメソッドで一般的なヘッダを取得
本文:Stringとして取得
添付:各種メソッドで番号(0,1,2,…)を指定

POP3メール受信コンポーネントが送信するデータ生成イベントは、受信した メールの情報(PFMailInformationクラス)のリスト(PFObjectList)が イベント内包データとして設定される。受信するメールが1件の場合も、 要素数が1件のPFObjectListとなる。
メール情報格納変数コンポーネントにPFObjectListの1要素(=1件のメールに対応する PFMailInformationオブジェクト)を設定して、本コンポーネントのメソッドを 呼び出すことで、電子メールメッセージの内容にアクセスできる。

※基本的には格納されたPFMailInformationオブジェクトの対応するメソッドを呼び出す。 ファイル保存やイベント発生は本コンポーネントが行う。

※PFVariableクラスを継承する。

関連項目:
直列化された形式

フィールドの概要
 
クラス jp.go.aist.dmrc.platform.beans.util.variable.PFVariable から継承されたフィールド
PROPERTY_EXCEPTION_NULL
 
コンストラクタの概要
PFMailInformationVariable()
          コンポーネントを生成する。
 
メソッドの概要
 PFObjectList getAllAttachmentContentTypeParameterNames()
          Content-Typeパラメータ名の全取得。
 PFObjectList getAllAttachmentContentTypeParameters(java.lang.String parameterName)
          Content-Typeパラメータの全取得。
 PFObjectList getAllAttachmentContentTypes()
          Content-Typeの全取得。
 PFObjectList getAllAttachmentFileNames()
          ファイル名の全取得。
 java.lang.String getAttachmentContentType(int attachementFileNumber)
          Content-Typeの取得
 java.lang.String getAttachmentContentTypeParameter(int attachementFileNumber, java.lang.String parameterName)
          Content-Typeパラメータの取得
 PFObjectList getAttachmentContentTypeParameterNames(int attachementFileNumber)
          Content-Typeパラメータ名の取得
 java.lang.String getAttachmentFileName(int attachementFileNumber)
          ファイル名の取得。
 java.lang.String getBodyHtml()
          HTMLメール本文の取得
MIMEマルチパートメールの場合、Content-Typeがtext/htmlである最初のパートをメール本文とする。
 java.lang.String getBodyRich()
          RichTextメール本文の取得
MIMEマルチパートメールの場合、Content-Typeがtext/richである最初のパートをメール本文とする。
 java.lang.String getBodyText()
          メール本文の取得
MIMEマルチパートメールの場合、Content-Typeがtext/plainである最初のパートをメール本文とする。
 PFObjectList getCcAddress()
          Ccの取得。
 int getComponentID()
          コンポーネントIDを取得する。
 java.lang.String getComponentKey()
          コンポーネントキーを取得する。
 PFMultiLocaleString getComponentKeys()
          全ロケール分のコンポーネントキーを返す。
 java.lang.String getComponentName()
          コンポーネント名称を取得する。
 java.lang.String getComponentPublicName()
          コンポーネント公開名を取得する.
 java.lang.String getComponentString()
          コンポーネントの文字列表現を取得する。
 java.lang.String getFromAddress()
          Fromの取得。
 PFObjectList getHeaderNames()
          ヘッダ名一覧の取得。
 PFObjectList getHeaderValue(java.lang.String headerName)
          ヘッダ値取得
 PFMailInformation getMailInformation()
          メール情報を取得する。
 int getMailSize()
          メールサイズの取得。
 java.lang.String getMailUIDL()
          メールUIDLの取得。
 java.lang.String getMessageId()
          メッセージIDを取得。
 java.lang.String getMessageSource()
          メッセージソースの取得。
 int getNumberOfAttachmentFiles()
          添付ファイル数の取得。
 java.lang.String getReplyToAddress()
          Reply-Toの取得。
 java.util.Date getSentDate()
          送信日時の取得。
 java.lang.String getSubject()
          Subjectの取得。
 PFObjectList getToAddress()
          Toの取得。
 boolean isAllowPullTransfer()
          他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
 boolean isAllowPushTransfer()
          他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
 boolean isAllowRemoteInvocation()
          他PFからのコンポーネント連携要求に対する可否属性を取得する.
 void localeUpdated()
          ロケール変更に対応する。
 void readXML(PFXMLLoader in)
          XMLを入力する.
 void saveAllAttachmentFiles(java.lang.String folderName)
          添付ファイルの全保存。
 void saveAttachmentFile(int attachementFileNumber, java.lang.String fileName)
          添付ファイルを保存する。
 void saveMessageSource(java.lang.String fileName)
          メッセージソースを保存する。
 void setAllowPullTransfer(boolean flag)
          他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.
 void setAllowPushTransfer(boolean flag)
          他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.
 void setAllowRemoteInvocation(boolean flag)
          他PFからのコンポーネント連携要求に対する可否属性を設定する.
 void setComponentID(int id)
          コンポーネントIDを設定する。
 void setComponentKey(java.lang.String key)
          コンポーネントキーを設定する。
 void setComponentKeys(PFMultiLocaleString keys)
          全ロケール分のコンポーネントキーを設定する。
 void setComponentPublicName(java.lang.String publicName)
          コンポーネント公開名を設定する.
 void setMailInformation(PFMailInformation message)
          メール情報を設定する。
 void setMailInformationQuiet(PFMailInformation message)
          メール情報を設定する。
 void writeXML(PFXMLGenerator out)
          XMLを出力する.
 
クラス jp.go.aist.dmrc.platform.beans.util.variable.PFVariable から継承されたメソッド
addPFDataSetListener, getDuplicateObject, getName, getObject, getPFDataSetListenerList, getResult, hasInstanceOf, hasResult, isNull, removePFDataSetListener, setName, setNull, setObject, setObjectQuiet, setResult
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

PFMailInformationVariable

public PFMailInformationVariable()
コンポーネントを生成する。

メソッドの詳細

getComponentName

public java.lang.String getComponentName()
コンポーネント名称を取得する。

定義:
インタフェース PFComponent 内の getComponentName
戻り値:
コンポーネント名

getComponentKey

public java.lang.String getComponentKey()
コンポーネントキーを取得する。

定義:
インタフェース PFComponent 内の getComponentKey
オーバーライド:
クラス PFVariable 内の getComponentKey
戻り値:
コンポーネントキー
関連項目:
PFComponent.getComponentKey()

setComponentKey

public void setComponentKey(java.lang.String key)
コンポーネントキーを設定する。

定義:
インタフェース PFComponent 内の setComponentKey
オーバーライド:
クラス PFVariable 内の setComponentKey
パラメータ:
key - コンポーネントキー
関連項目:
PFComponent.setComponentKey(java.lang.String)

getComponentKeys

public PFMultiLocaleString getComponentKeys()
全ロケール分のコンポーネントキーを返す。

オーバーライド:
クラス PFVariable 内の getComponentKeys
戻り値:
全ロケール分のコンポーネントキー

setComponentKeys

public void setComponentKeys(PFMultiLocaleString keys)
全ロケール分のコンポーネントキーを設定する。

オーバーライド:
クラス PFVariable 内の setComponentKeys
パラメータ:
keys - 全ロケール分のコンポーネントキー

getComponentID

public int getComponentID()
コンポーネントIDを取得する。

定義:
インタフェース PFComponent 内の getComponentID
オーバーライド:
クラス PFVariable 内の getComponentID
戻り値:
コンポーネントID
関連項目:
PFComponent.getComponentID()

setComponentID

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

定義:
インタフェース PFComponent 内の setComponentID
オーバーライド:
クラス PFVariable 内の setComponentID
パラメータ:
id - 設定するコンポーネントID
関連項目:
PFComponent.setComponentID(int)

getComponentString

public java.lang.String getComponentString()
コンポーネントの文字列表現を取得する。
形式:"Component Name" [ ID : "ID" ]

定義:
インタフェース PFComponent 内の getComponentString
オーバーライド:
クラス PFVariable 内の getComponentString
戻り値:
文字列表現
関連項目:
PFComponent.getComponentString()

getComponentPublicName

public java.lang.String getComponentPublicName()
コンポーネント公開名を取得する.

定義:
インタフェース PFComponent 内の getComponentPublicName
オーバーライド:
クラス PFVariable 内の getComponentPublicName
戻り値:
コンポーネント公開名

setComponentPublicName

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

定義:
インタフェース PFComponent 内の setComponentPublicName
オーバーライド:
クラス PFVariable 内の setComponentPublicName
パラメータ:
publicName - 設定するコンポーネント公開名
例外:
PFComponentException - 規約に反する名前が設定されようとした場合

isAllowRemoteInvocation

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

定義:
インタフェース PFComponent 内の isAllowRemoteInvocation
オーバーライド:
クラス PFVariable 内の isAllowRemoteInvocation
戻り値:
コンポーネント連携要求可否属性

setAllowRemoteInvocation

public void setAllowRemoteInvocation(boolean flag)
他PFからのコンポーネント連携要求に対する可否属性を設定する.

定義:
インタフェース PFComponent 内の setAllowRemoteInvocation
オーバーライド:
クラス PFVariable 内の setAllowRemoteInvocation
パラメータ:
flag - コンポーネント連携要求に対する可否

isAllowPullTransfer

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

定義:
インタフェース PFComponent 内の isAllowPullTransfer
オーバーライド:
クラス PFVariable 内の isAllowPullTransfer
戻り値:
Pull型コンポーネント転送要求可否属性

setAllowPullTransfer

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

定義:
インタフェース PFComponent 内の setAllowPullTransfer
オーバーライド:
クラス PFVariable 内の setAllowPullTransfer
パラメータ:
flag - Pull型コンポーネント転送要求に対する可否

isAllowPushTransfer

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

定義:
インタフェース PFComponent 内の isAllowPushTransfer
オーバーライド:
クラス PFVariable 内の isAllowPushTransfer
戻り値:
Push型コンポーネント転送要求可否属性

setAllowPushTransfer

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

定義:
インタフェース PFComponent 内の setAllowPushTransfer
オーバーライド:
クラス PFVariable 内の setAllowPushTransfer
パラメータ:
flag - Push型コンポーネント転送要求に対する可否

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入力ユーティリティ

setMailInformation

public void setMailInformation(PFMailInformation message)
                        throws PFException
メール情報を設定する。

パラメータ:
message - メール情報
例外:
PFException

setMailInformationQuiet

public void setMailInformationQuiet(PFMailInformation message)
メール情報を設定する。ただし、データ設定イベントが発生しない。

パラメータ:
message - メール情報

getMailInformation

public PFMailInformation getMailInformation()
メール情報を取得する。

戻り値:
メール情報

getFromAddress

public java.lang.String getFromAddress()
Fromの取得。

戻り値:
メールアドレス

getToAddress

public PFObjectList getToAddress()
Toの取得。

戻り値:
メールアドレスのリスト

getSubject

public java.lang.String getSubject()
Subjectの取得。

戻り値:
件名

getCcAddress

public PFObjectList getCcAddress()
Ccの取得。

戻り値:
メールアドレスのリスト

getReplyToAddress

public java.lang.String getReplyToAddress()
Reply-Toの取得。

戻り値:
メールアドレス

getSentDate

public java.util.Date getSentDate()
送信日時の取得。

戻り値:
日時

getMessageId

public java.lang.String getMessageId()
メッセージIDを取得。

戻り値:
メッセージID

getHeaderNames

public PFObjectList getHeaderNames()
ヘッダ名一覧の取得。

戻り値:
ヘッダ名のリスト

getHeaderValue

public PFObjectList getHeaderValue(java.lang.String headerName)
ヘッダ値取得

パラメータ:
headerName - ヘッダ名
戻り値:
ヘッダ値のリスト

getBodyText

public java.lang.String getBodyText()
メール本文の取得
MIMEマルチパートメールの場合、Content-Typeがtext/plainである最初のパートをメール本文とする。

戻り値:
メール本文

getBodyHtml

public java.lang.String getBodyHtml()
HTMLメール本文の取得
MIMEマルチパートメールの場合、Content-Typeがtext/htmlである最初のパートをメール本文とする。

戻り値:
メール本文

getBodyRich

public java.lang.String getBodyRich()
RichTextメール本文の取得
MIMEマルチパートメールの場合、Content-Typeがtext/richである最初のパートをメール本文とする。

戻り値:
メール本文

getMailSize

public int getMailSize()
メールサイズの取得。

戻り値:
メールサイズ(バイト)

getMailUIDL

public java.lang.String getMailUIDL()
メールUIDLの取得。

戻り値:
メールUIDL

getMessageSource

public java.lang.String getMessageSource()
メッセージソースの取得。

戻り値:
メッセージソース

saveMessageSource

public void saveMessageSource(java.lang.String fileName)
                       throws PFComponentException
メッセージソースを保存する。

パラメータ:
fileName - 保存するファイル名(絶対パス)
例外:
PFComponentException - 入出力例外

getNumberOfAttachmentFiles

public int getNumberOfAttachmentFiles()
添付ファイル数の取得。

戻り値:
添付ファイル数

saveAllAttachmentFiles

public void saveAllAttachmentFiles(java.lang.String folderName)
                            throws PFComponentException
添付ファイルの全保存。

パラメータ:
folderName - フォルダ名(絶対パス)
例外:
PFComponentException

getAllAttachmentFileNames

public PFObjectList getAllAttachmentFileNames()
ファイル名の全取得。

戻り値:
添付ファイル名のリスト

getAllAttachmentContentTypes

public PFObjectList getAllAttachmentContentTypes()
Content-Typeの全取得。

戻り値:
添付ファイルのContent-Typeのリスト

getAllAttachmentContentTypeParameterNames

public PFObjectList getAllAttachmentContentTypeParameterNames()
Content-Typeパラメータ名の全取得。

戻り値:
添付ファイルのContent-Typeパラメータ名のリスト

getAllAttachmentContentTypeParameters

public PFObjectList getAllAttachmentContentTypeParameters(java.lang.String parameterName)
Content-Typeパラメータの全取得。

パラメータ:
parameterName - パラメータ名
戻り値:
添付ファイルのContent-Typeパラメータのリスト

saveAttachmentFile

public void saveAttachmentFile(int attachementFileNumber,
                               java.lang.String fileName)
                        throws PFComponentException
添付ファイルを保存する。

パラメータ:
attachementFileNumber - 添付ファイルの番号
fileName - ファイル名
例外:
PFComponentException

getAttachmentFileName

public java.lang.String getAttachmentFileName(int attachementFileNumber)
ファイル名の取得。

パラメータ:
attachementFileNumber - 添付ファイルの番号
戻り値:
添付ファイル名

getAttachmentContentType

public java.lang.String getAttachmentContentType(int attachementFileNumber)
Content-Typeの取得

パラメータ:
attachementFileNumber - 添付ファイルの番号
戻り値:
添付ファイルのContent-Type

getAttachmentContentTypeParameterNames

public PFObjectList getAttachmentContentTypeParameterNames(int attachementFileNumber)
Content-Typeパラメータ名の取得

パラメータ:
attachementFileNumber - 添付ファイルの番号
戻り値:
添付ファイルのContent-Typeパラメータ名のリスト

getAttachmentContentTypeParameter

public java.lang.String getAttachmentContentTypeParameter(int attachementFileNumber,
                                                          java.lang.String parameterName)
Content-Typeパラメータの取得

パラメータ:
attachementFileNumber - 添付ファイルの番号
parameterName - パラメータ名
戻り値:
添付ファイルのContent-Typeパラメータ