OPROARTS API

net.opro.product.odcaw.oproarts.api
クラス MailParameter

Object
  上位を拡張 MailParameter

public class MailParameter
extends Object

OPROARTSParameter.setMail(MailParameter) で使用するための、メールに関するパラメータを定義します。

作成者:
OPRO Japan Co.,Ltd. R&D Center
関連項目:
OPROARTSHandler.sendMail(OPROARTSParameter)

コンストラクタの概要
MailParameter()
          メールに関する情報がクリアされた MailParameter を作成します。
 
メソッドの概要
 void addBcc(String value)
          BCC(Blind Carbon Copy)メールアドレスを追加します。
 void addCc(String value)
          CC(Carbon Copy)メールアドレスを追加します。
 void addTo(String value)
          宛先メールアドレスを追加します。
 void clearBcc()
          全てのBCCメールアドレスを削除します。
 void clearCc()
          全てのCCメールアドレスを削除します。
 void clearTo()
          全ての宛先メールアドレスを削除します。
 String getAttachName()
          getAttachName() で設定した添付ファイル名を返します。
 String getBody()
          setBody(String) で設定したメール本文を返します。
 String getFrom()
          setFrom(String) で設定した送信元を返します。
 String getReplyTo()
          setReplyTo(String) で設定した返信先を返します。
 String getSubject()
          setSubject(String) で設定した件名を返します。
 boolean getUseFromForEnvelopeFrom()
          setUseFromForEnvelopeFrom(boolean) で設定した送信元アドレスを envelope-from に使用するか否かを示す boolean を返します。
 void removeBcc(int index)
          指定したBCCメールアドレスを削除します。
 void removeCc(int index)
          指定したCCメールアドレスを削除します。
 void removeTo(int index)
          指定した宛先メールアドレスを削除します。
 void setAttachName(String value)
          添付ファイルのファイル名を設定します。
 void setBody(String value)
          メールの本文を設定します。
 void setFrom(String value)
          メールの送信元アドレスを設定します。
 void setReplyTo(String value)
          メールの返信先アドレスを設定します。
 void setSubject(String value)
          メールの件名を設定します。
 void setUseFromForEnvelopeFrom(boolean value)
          送信元アドレスを envelope-from に使用するか否かを指定します。
 int sizeBcc()
          BCCメールアドレスの数を返します。
 int sizeCc()
          CCメールアドレスの数を返します。
 int sizeTo()
          宛先メールアドレスの数を返します。
 
クラス Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

MailParameter

public MailParameter()
メールに関する情報がクリアされた MailParameter を作成します。

メソッドの詳細

setFrom

public void setFrom(String value)
メールの送信元アドレスを設定します。

OPROARTSHandler.sendMail(OPROARTSParameter) メソッド呼び出し前に、本メソッドを使用して MailParameter に適切な値をセットしてください。

パラメータ:
value - 設定する送信元メールアドレス

getFrom

public String getFrom()
setFrom(String) で設定した送信元を返します。

戻り値:
setFrom(String) で設定した送信元

setUseFromForEnvelopeFrom

public void setUseFromForEnvelopeFrom(boolean value)
送信元アドレスを envelope-from に使用するか否かを指定します。
trueを指定すると、setFrom(String) で設定された値が envelope-from に用いられます。
trueを指定しない場合、OPROARTSサーバで定義された初期値が envelope-from に用いられます。

パラメータ:
value - 送信元アドレスを envelope-from に使用する場合は true、そうでない場合は false。既定値は false。
導入されたバージョン:
2011.01.07

getUseFromForEnvelopeFrom

public boolean getUseFromForEnvelopeFrom()
setUseFromForEnvelopeFrom(boolean) で設定した送信元アドレスを envelope-from に使用するか否かを示す boolean を返します。

戻り値:
setUseFromForEnvelopeFrom(boolean) で設定した送信元アドレスを envelope-from に使用するか否かを示す boolean
導入されたバージョン:
2011.01.07

setReplyTo

public void setReplyTo(String value)
メールの返信先アドレスを設定します。

パラメータ:
value - 設定する返信先メールアドレス
導入されたバージョン:
2010.12.09

getReplyTo

public String getReplyTo()
setReplyTo(String) で設定した返信先を返します。

戻り値:
setReplyTo(String) で設定した返信先
導入されたバージョン:
2010.12.09

setSubject

public void setSubject(String value)
メールの件名を設定します。

パラメータ:
value - 設定するメール件名

getSubject

public String getSubject()
setSubject(String) で設定した件名を返します。

戻り値:
setSubject(String) で設定した件名

setBody

public void setBody(String value)
メールの本文を設定します。

パラメータ:
value - 設定するメール本文

getBody

public String getBody()
setBody(String) で設定したメール本文を返します。

戻り値:
setBody(String) で設定したメール本文

setAttachName

public void setAttachName(String value)
添付ファイルのファイル名を設定します。
引数valueの値に、OPROARTSParameter.setFormat(int) で指定されたフォーマットに基づく拡張子が付加されたファイル名が、添付ファイルのファイル名となります。

本パラメータが省略された場合、OPROARTSサーバー が決定したファイル名が、添付ファイルの名称として使用されます。

パラメータ:
value - 設定する添付ファイル名

getAttachName

public String getAttachName()
getAttachName() で設定した添付ファイル名を返します。

戻り値:
getAttachName() で設定した添付ファイル名

addTo

public void addTo(String value)
宛先メールアドレスを追加します。

OPROARTSHandler.sendMail(OPROARTSParameter) メソッド呼び出し前に、本メソッドを使用して MailParameter に1つ以上の送信先を追加してください。

パラメータ:
value - 追加する宛先メールアドレス

sizeTo

public int sizeTo()
宛先メールアドレスの数を返します。

戻り値:
宛先メールアドレスの数

clearTo

public void clearTo()
全ての宛先メールアドレスを削除します。


removeTo

public void removeTo(int index)
指定した宛先メールアドレスを削除します。

パラメータ:
index - 削除する宛先メールアドレスのインデックス

addCc

public void addCc(String value)
CC(Carbon Copy)メールアドレスを追加します。

パラメータ:
value - 追加するCCメールアドレス

sizeCc

public int sizeCc()
CCメールアドレスの数を返します。

戻り値:
CCメールアドレスの数

clearCc

public void clearCc()
全てのCCメールアドレスを削除します。


removeCc

public void removeCc(int index)
指定したCCメールアドレスを削除します。

パラメータ:
index - 削除するCCメールアドレスのインデックス

addBcc

public void addBcc(String value)
BCC(Blind Carbon Copy)メールアドレスを追加します。

パラメータ:
value - 追加するBCCメールアドレス

sizeBcc

public int sizeBcc()
BCCメールアドレスの数を返します。

戻り値:
BCCメールアドレスの数

clearBcc

public void clearBcc()
全てのBCCメールアドレスを削除します。


removeBcc

public void removeBcc(int index)
指定したBCCメールアドレスを削除します。

パラメータ:
index - 削除するBCCメールアドレスのインデックス

OPRO Japan Co.,Ltd.