|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Object jp.go.aist.dmrc.platform.beans.util.variable.PFVariable jp.go.aist.dmrc.platform.beans.mail.PFMailInformationVariable
public class PFMailInformationVariable
メール情報格納変数。
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 |
コンストラクタの詳細 |
---|
public PFMailInformationVariable()
メソッドの詳細 |
---|
public java.lang.String getComponentName()
PFComponent
内の getComponentName
public java.lang.String getComponentKey()
PFComponent
内の getComponentKey
PFVariable
内の getComponentKey
PFComponent.getComponentKey()
public void setComponentKey(java.lang.String key)
PFComponent
内の setComponentKey
PFVariable
内の setComponentKey
key
- コンポーネントキーPFComponent.setComponentKey(java.lang.String)
public PFMultiLocaleString getComponentKeys()
PFVariable
内の getComponentKeys
public void setComponentKeys(PFMultiLocaleString keys)
PFVariable
内の setComponentKeys
keys
- 全ロケール分のコンポーネントキーpublic int getComponentID()
PFComponent
内の getComponentID
PFVariable
内の getComponentID
PFComponent.getComponentID()
public void setComponentID(int id)
PFComponentBus
から設定される。
各コンポーネント内では操作しないこと。
PFComponent
内の setComponentID
PFVariable
内の setComponentID
id
- 設定するコンポーネントIDPFComponent.setComponentID(int)
public java.lang.String getComponentString()
PFComponent
内の getComponentString
PFVariable
内の getComponentString
PFComponent.getComponentString()
public java.lang.String getComponentPublicName()
PFComponent
内の getComponentPublicName
PFVariable
内の getComponentPublicName
public void setComponentPublicName(java.lang.String publicName) throws PFComponentException
PFComponent
内の setComponentPublicName
PFVariable
内の setComponentPublicName
publicName
- 設定するコンポーネント公開名
PFComponentException
- 規約に反する名前が設定されようとした場合public boolean isAllowRemoteInvocation()
PFComponent
内の isAllowRemoteInvocation
PFVariable
内の isAllowRemoteInvocation
public void setAllowRemoteInvocation(boolean flag)
PFComponent
内の setAllowRemoteInvocation
PFVariable
内の setAllowRemoteInvocation
flag
- コンポーネント連携要求に対する可否public boolean isAllowPullTransfer()
PFComponent
内の isAllowPullTransfer
PFVariable
内の isAllowPullTransfer
public void setAllowPullTransfer(boolean flag)
PFComponent
内の setAllowPullTransfer
PFVariable
内の setAllowPullTransfer
flag
- Pull型コンポーネント転送要求に対する可否public boolean isAllowPushTransfer()
PFComponent
内の isAllowPushTransfer
PFVariable
内の isAllowPushTransfer
public void setAllowPushTransfer(boolean flag)
PFComponent
内の setAllowPushTransfer
PFVariable
内の setAllowPushTransfer
flag
- Push型コンポーネント転送要求に対する可否public void localeUpdated()
PFComponent
内の localeUpdated
public void writeXML(PFXMLGenerator out) throws java.io.IOException
PFXMLSerializable
内の writeXML
out
- XML出力ユーティリティ
java.io.IOException
public void readXML(PFXMLLoader in)
PFXMLSerializable
内の readXML
in
- XML入力ユーティリティpublic void setMailInformation(PFMailInformation message) throws PFException
message
- メール情報
PFException
public void setMailInformationQuiet(PFMailInformation message)
message
- メール情報public PFMailInformation getMailInformation()
public java.lang.String getFromAddress()
public PFObjectList getToAddress()
public java.lang.String getSubject()
public PFObjectList getCcAddress()
public java.lang.String getReplyToAddress()
public java.util.Date getSentDate()
public java.lang.String getMessageId()
public PFObjectList getHeaderNames()
public PFObjectList getHeaderValue(java.lang.String headerName)
headerName
- ヘッダ名
public java.lang.String getBodyText()
public java.lang.String getBodyHtml()
public java.lang.String getBodyRich()
public int getMailSize()
public java.lang.String getMailUIDL()
public java.lang.String getMessageSource()
public void saveMessageSource(java.lang.String fileName) throws PFComponentException
fileName
- 保存するファイル名(絶対パス)
PFComponentException
- 入出力例外public int getNumberOfAttachmentFiles()
public void saveAllAttachmentFiles(java.lang.String folderName) throws PFComponentException
folderName
- フォルダ名(絶対パス)
PFComponentException
public PFObjectList getAllAttachmentFileNames()
public PFObjectList getAllAttachmentContentTypes()
public PFObjectList getAllAttachmentContentTypeParameterNames()
public PFObjectList getAllAttachmentContentTypeParameters(java.lang.String parameterName)
parameterName
- パラメータ名
public void saveAttachmentFile(int attachementFileNumber, java.lang.String fileName) throws PFComponentException
attachementFileNumber
- 添付ファイルの番号fileName
- ファイル名
PFComponentException
public java.lang.String getAttachmentFileName(int attachementFileNumber)
attachementFileNumber
- 添付ファイルの番号
public java.lang.String getAttachmentContentType(int attachementFileNumber)
attachementFileNumber
- 添付ファイルの番号
public PFObjectList getAttachmentContentTypeParameterNames(int attachementFileNumber)
attachementFileNumber
- 添付ファイルの番号
public java.lang.String getAttachmentContentTypeParameter(int attachementFileNumber, java.lang.String parameterName)
attachementFileNumber
- 添付ファイルの番号parameterName
- パラメータ名
|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |