OPRO X Server API

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

Object
  拡張net.opro.product.odcaw.api.CooperateParameterImpl
      拡張net.opro.product.odcaw.api.MailParameter
すべての実装インタフェース:
CooperateParameter

public class MailParameter
extends CooperateParameterImpl

OXSHandler.asyncMail で使用するための、 OXS Mail Service を利用するためのパラメータを定義します。
このクラスでは CooperateServer として MailServer を使用します。

導入されたバージョン:
2.2.1.0
関連項目:
OXSParameter.setMail, OXSHandler.asyncMail, MailServer

コンストラクタの概要
MailParameter(String UserName, String Password)
          CooperateServer 数がゼロの MailParameter を作成します。
 
メソッドの概要
 MailServer addMailServer()
          OXS Mail Service に関するパラメータを定義する MailServer を追加します。
 MailServer addMailServer(String Name)
          OXS Mail Service に関するパラメータを定義する MailServer を追加し、指定した名前を設定します。
 String getAttachName()
          getAttachName で設定した添付ファイル名を返します。
 Object getBody()
          setBody で設定した本文を返します。
 String getFrom()
          setFrom で設定した送信元を返します。
 String getReplyTo()
          setReplyTo で設定した返信先を返します。
 String getSubject()
          setSubject で設定した件名を返します。
 void setAttachName(String Value)
          ドキュメントを添付する際に用いる添付ファイル名を設定します。
 void setBody(Reader Value)
          メールの本文を設定します。
 void setBody(String Value)
          メールの本文を設定します。
 void setFrom(String Value)
          メールの送信元を設定します。
 void setReplyTo(String Value)
          メールの返信先を設定します。
 void setSubject(String Value)
          メールの件名を設定します。
 
クラス net.opro.product.odcaw.api.CooperateParameterImpl から継承したメソッド
addServer, addServer, clearServer, getConfirmation, getPassword, getUserName, removeServer, removeServer, removeServer, serverAt, serverAt, serverIndexOf, setConfirmation, sizeServer
 
クラス Object から継承したメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

MailParameter

public MailParameter(String UserName,
                     String Password)
CooperateServer 数がゼロの MailParameter を作成します。

パラメータ:
UserName - 連携サーバ・サービスへのログインユーザ名
Password - 連携サーバ・サービスへのログインパスワード
メソッドの詳細

addMailServer

public MailServer addMailServer()
OXS Mail Service に関するパラメータを定義する MailServer を追加します。
このメソッドは
(MailServer)addServer();
と等価です。

戻り値:
追加された MailServer
関連項目:
addServer, MailServer

addMailServer

public MailServer addMailServer(String Name)
OXS Mail Service に関するパラメータを定義する MailServer を追加し、指定した名前を設定します。
このメソッドは
(MailServer)addServer(Name);
と等価です。

パラメータ:
Name - 追加された MailServer に設定する名前
戻り値:
追加された MailServer
関連項目:
addServer, MailServer

setFrom

public void setFrom(String Value)
メールの送信元を設定します。

HTTP によるリクエストの、MFパラメータに相当します。

パラメータ:
Value - 設定する送信元

getFrom

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

HTTP によるリクエストの、MFパラメータに相当します。

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

setReplyTo

public void setReplyTo(String Value)
メールの返信先を設定します。

HTTP によるリクエストの、RTパラメータに相当します。

パラメータ:
Value - 設定する返信先

getReplyTo

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

HTTP によるリクエストの、RTパラメータに相当します。

戻り値:
setReplyTo で設定した返信先

setSubject

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

HTTP によるリクエストの、MSJパラメータに相当します。

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

getSubject

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

HTTP によるリクエストの、MSJパラメータに相当します。

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

setBody

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

HTTP によるリクエストの、MBパラメータに相当します。

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

setBody

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

引数 Value から読み出される値は、UTF-8である必要があります。
java.io.InputStreamReader 等で、正しくUTF-8に変換してください。

HTTP によるリクエストの、MBパラメータに相当します。

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

getBody

public Object getBody()
setBody で設定した本文を返します。

HTTP によるリクエストの、MBパラメータに相当します。

戻り値:
setBody で設定した本文

setAttachName

public void setAttachName(String Value)
ドキュメントを添付する際に用いる添付ファイル名を設定します。
拡張子は、フォーマットに応じて OXS によって付加されます。

HTTP によるリクエストの、MAパラメータに相当します。

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

getAttachName

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

HTTP によるリクエストの、MAパラメータに相当します。

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

OPRO Japan Co.,Ltd.