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

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

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

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

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

SMTPメール送信コンポーネント。
SMTPでサーバにメールを送信する。
メールには添付ファイルをつけることも可能。
送信が完了したら、そのステータスをイベント番号として持たせた処理完了イベントを 送信する。
サーバとのSMTP通信は、その認証方法・暗号化を選択できる。

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

• 処理完了イベント

  トリガ	対象データ	イベント番号
  sendMail(...)を実行してメール送信に成功したとき	null	0
  sendMail(...)を実行してメール送信に失敗したとき	null	-1

関連項目:

直列化された形式

フィールドの概要

static int	AUTH_METHOD_NO_AUTH 認証方法 認証なし。
static int	AUTH_METHOD_POP_BEFORE_SMTP 認証方法 POP Before SMTP。
static int	AUTH_METHOD_SMTP_AUTH 認証方法 SMTP Auth。
static java.lang.String	DEFAULT_SERVER_PORT_NO_SSL デフォルトサーバポート番号・SSLなし
static java.lang.String	DEFAULT_SERVER_PORT_SSL デフォルトサーバポート番号・SSLあり

コンストラクタの概要

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

メソッドの概要

void	addPFProcessTerminateListener(PFProcessTerminateListener lis) 引数で与えられたイベントリスナを登録し、 処理完了イベント発生時に処理を行う対象とする。
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.String	getFromAddress() 送信元アドレス情報の取得。
java.util.Iterator	getPFProcessTerminateListenerList() 処理完了イベントリスナ配列を取得する。
PFPOP3MailReceiver	getPOP3MailReceiverComponent() POPサーバ設定、メール受信コンポーネントを取得する。
java.lang.String	getServerAddress() SMTPサーバアドレスの取得。
java.lang.String	getServerPort() SMTPサーバのポート番号の取得。
java.lang.String	getSmtpAuthMechanism() 認証機構の取得。
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	removePFProcessTerminateListener(PFProcessTerminateListener lis) 引数で与えられたイベントリスナを削除し、 処理完了イベント発生時に処理を行う対象から外す。
void	sendMail(PFObjectList toAddressList, PFObjectList ccAddressList, PFObjectList bccAddressList, java.lang.String subject, java.lang.String bodyText, PFObjectList attachedFileAbsolutePathList) メールを送信する。
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	setFromAddress(java.lang.String fromAddress) 送信元アドレスの設定。
void	setPOP3MailReceiverComponent(PFPOP3MailReceiver pop3MailReceiverComponent) POPサーバ設定、メール受信コンポーネントを設定する。
void	setServerAddress(java.lang.String serverAddress) SMTPサーバアドレスの設定。
void	setServerPort(java.lang.String serverPort) SMTPサーバのポート番号の設定。
void	setSmtpAuthMechanism(java.lang.String smtpAuthMechanism) 認証機構の設定。
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_NO_AUTH

public static final int AUTH_METHOD_NO_AUTH

認証方法 認証なし。

関連項目:

定数フィールド値

AUTH_METHOD_POP_BEFORE_SMTP

public static final int AUTH_METHOD_POP_BEFORE_SMTP

認証方法 POP Before SMTP。

関連項目:

定数フィールド値

AUTH_METHOD_SMTP_AUTH

public static final int AUTH_METHOD_SMTP_AUTH

認証方法 SMTP Auth。

関連項目:

定数フィールド値

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あり

関連項目:

定数フィールド値

コンストラクタの詳細

PFSMTPMailSender

public PFSMTPMailSender()

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

メソッドの詳細

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 - 削除対象イベントリスナ

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()

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

戻り値:

アドレス

setServerAddress

public void setServerAddress(java.lang.String serverAddress)

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

パラメータ:

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

getServerPort

public java.lang.String getServerPort()

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

戻り値:

ポート番号

setServerPort

public void setServerPort(java.lang.String serverPort)

SMTPサーバのポート番号の設定。
ポート番号が未指定の場合、25（SSL/TLS未使用時）もしくは465（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=認証なし
1=POP before SMTP
2=SMTP AUTH

戻り値:

認証方法の種類

setAuthMethod

public void setAuthMethod(int authMethod)

認証方法の設定。
認証方法の種類は
0=認証なし
1=POP before SMTP
2=SMTP AUTH

パラメータ:

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可）

getSmtpAuthMechanism

public java.lang.String getSmtpAuthMechanism()

認証機構の取得。

戻り値:

認証機構を空白で区切った文字列

setSmtpAuthMechanism

public void setSmtpAuthMechanism(java.lang.String smtpAuthMechanism)

認証機構の設定。 SMTP AUTHの認証機構のうち"LOGIN"と"PLAIN"のみをサポートする。

パラメータ:

smtpAuthMechanism - 認証機構を空白で区切った文字列

getFromAddress

public java.lang.String getFromAddress()

送信元アドレス情報の取得。

戻り値:

メールアドレス

setFromAddress

public void setFromAddress(java.lang.String fromAddress)

送信元アドレスの設定。

パラメータ:

fromAddress - メールアドレス

getPOP3MailReceiverComponent

public PFPOP3MailReceiver getPOP3MailReceiverComponent()

POPサーバ設定、メール受信コンポーネントを取得する。

戻り値:

メール受信コンポーネント

setPOP3MailReceiverComponent

public void setPOP3MailReceiverComponent(PFPOP3MailReceiver pop3MailReceiverComponent)

POPサーバ設定、メール受信コンポーネントを設定する。

パラメータ:

pop3MailReceiverComponent - メール受信コンポーネント

sendMail

public void sendMail(PFObjectList toAddressList,
                     PFObjectList ccAddressList,
                     PFObjectList bccAddressList,
                     java.lang.String subject,
                     java.lang.String bodyText,
                     PFObjectList attachedFileAbsolutePathList)
              throws PFException

メールを送信する。
To/Cc/Bccはどれかに１件アドレスがあればよい。他はnullもしくは空リストで可。
添付ファイルパスのリストはnullもしくは空リスト可。
件名はnullもしくは空文字可。
本文はnullもしくは空文字可。
ファイル添付以外のMIMEマルチパートメールの送信はサポートしない。

パラメータ:

toAddressList - 宛先アドレスのリスト

ccAddressList - Ccアドレスのリスト

bccAddressList - Bccアドレスのリスト

subject - 件名。nullもしく空文字でもよい。

bodyText - 本文。nullもしく空文字でもよい。

attachedFileAbsolutePathList - 添付ファイルの絶対パスのリスト。nullもしくは空リスト可。

例外:

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