OPRO X Server API

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

Object
  拡張net.opro.product.odcaw.api.ParameterImpl
      拡張net.opro.product.odcaw.api.CooperateDeviceImpl
          拡張net.opro.product.odcaw.api.MailDevice
すべての実装インタフェース:
CooperateDevice, net.opro.product.odcaw.api.Parameter

public class MailDevice
extends CooperateDeviceImpl

MailServer で使用するための、 OXS Mail Service で使用するSMTPサーバに関するパラメータを定義します。

導入されたバージョン:
2.2.1.0
関連項目:
MailServer

メソッドの概要
 void addBcc(String Bcc)
          メールのBCCを追加します。
 void addBcc(String[] Bcc)
          メールのBCCを複数追加します。
 void addCc(String Cc)
          メールのCCを追加します。
 void addCc(String[] Cc)
          メールのCCを複数追加します。
 void addTo(String To)
          メールの宛先を追加します。
 void addTo(String[] To)
          メールの宛先を複数追加します。
 String bccAt(int Index)
          指定したメールのBCCを返します。
 int bccIndexOf(String Bcc)
          指定したメールのBCCの最初のインデックスを返します。
 String ccAt(int Index)
          指定したメールのCCを返します。
 int ccIndexOf(String Cc)
          指定したメールのCCの最初のインデックスを返します。
 void clearBcc()
          全てのメールのBCCを削除します。
 void clearCc()
          全てのメールのCCを削除します。
 void clearTo()
          全てのメールの宛先を削除します。
 boolean getHtmlMail()
          setHtmlMail で設定したHTMLメールとするかどうかを示す boolean を返します。
 boolean getNotification()
          setNotification で設定した開封確認要求を行うかどうかを示す boolean を返します。
 void removeBcc(int Index)
          指定したメールのBCCを削除します。
 void removeBcc(String Bcc)
          指定したメールのBCCを削除します。
 void removeCc(int Index)
          指定したメールのCCを削除します。
 void removeCc(String Cc)
          指定したメールのCCを削除します。
 void removeTo(int Index)
          指定したメールの宛先を削除します。
 void removeTo(String To)
          指定したメールの宛先を削除します。
 void setHtmlMail(boolean Value)
          生成したドキュメントを内容とするHTMLメールとするかどうかを設定します。
 void setNotification(boolean Value)
          開封確認要求を行うかどうかを設定します。
 int sizeBcc()
          メールのBCCの数を返します。
 int sizeCc()
          メールのCCの数を返します。
 int sizeTo()
          メールの宛先の数を返します。
 String toAt(int Index)
          指定したメールの宛先を返します。
 int toIndexOf(String To)
          指定したメールの宛先の最初のインデックスを返します。
 
クラス net.opro.product.odcaw.api.CooperateDeviceImpl から継承したメソッド
getExecuteTime, getGenerateTime, getName, setExecuteTime, setExecuteTime, setGenerateTime, setGenerateTime, setName
 
クラス Object から継承したメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

メソッドの詳細

addTo

public void addTo(String To)
メールの宛先を追加します。

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

パラメータ:
To - 追加する宛先

addTo

public void addTo(String[] To)
メールの宛先を複数追加します。

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

パラメータ:
To - 追加する宛先

sizeTo

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

戻り値:
宛先の数

clearTo

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


removeTo

public void removeTo(String To)
指定したメールの宛先を削除します。

パラメータ:
To - 削除する宛先

removeTo

public void removeTo(int Index)
指定したメールの宛先を削除します。

パラメータ:
Index - 削除する宛先のインデックス
例外:
ArrayIndexOutOfBoundsException - Index が負の場合、または現在の sizeTo よりも大きい場合

toAt

public String toAt(int Index)
指定したメールの宛先を返します。

パラメータ:
Index - 返される宛先のインデックス
戻り値:
指定した宛先
例外:
ArrayIndexOutOfBoundsException - Index が負の場合、または現在の sizeTo よりも大きい場合

toIndexOf

public int toIndexOf(String To)
指定したメールの宛先の最初のインデックスを返します。

パラメータ:
To - 検索対象の宛先
戻り値:
指定した宛先の最初のインデックス。見つからない場合は -1。

addCc

public void addCc(String Cc)
メールのCCを追加します。

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

パラメータ:
Cc - 追加するCC

addCc

public void addCc(String[] Cc)
メールのCCを複数追加します。

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

パラメータ:
Cc - 追加するCC

sizeCc

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

戻り値:
CCの数

clearCc

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


removeCc

public void removeCc(String Cc)
指定したメールのCCを削除します。

パラメータ:
Cc - 削除するCC

removeCc

public void removeCc(int Index)
指定したメールのCCを削除します。

パラメータ:
Index - 削除するCCのインデックス
例外:
ArrayIndexOutOfBoundsException - Index が負の場合、または現在の sizeCc よりも大きい場合

ccAt

public String ccAt(int Index)
指定したメールのCCを返します。

パラメータ:
Index - 返されるCCのインデックス
戻り値:
指定したCC
例外:
ArrayIndexOutOfBoundsException - Index が負の場合、または現在の sizeCc よりも大きい場合

ccIndexOf

public int ccIndexOf(String Cc)
指定したメールのCCの最初のインデックスを返します。

パラメータ:
Cc - 検索対象のCC
戻り値:
指定したCCの最初のインデックス。見つからない場合は -1。

addBcc

public void addBcc(String Bcc)
メールのBCCを追加します。

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

パラメータ:
Bcc - 追加するBCC

addBcc

public void addBcc(String[] Bcc)
メールのBCCを複数追加します。

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

パラメータ:
Bcc - 追加するBCC

sizeBcc

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

戻り値:
BCCの数

clearBcc

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


removeBcc

public void removeBcc(String Bcc)
指定したメールのBCCを削除します。

パラメータ:
Bcc - 削除するBCC

removeBcc

public void removeBcc(int Index)
指定したメールのBCCを削除します。

パラメータ:
Index - 削除するBCCのインデックス
例外:
ArrayIndexOutOfBoundsException - Index が負の場合、または現在の sizeBcc よりも大きい場合

bccAt

public String bccAt(int Index)
指定したメールのBCCを返します。

パラメータ:
Index - 返されるBCCのインデックス
戻り値:
指定したBCC
例外:
ArrayIndexOutOfBoundsException - Index が負の場合、または現在の sizeBcc よりも大きい場合

bccIndexOf

public int bccIndexOf(String Bcc)
指定したメールのBCCの最初のインデックスを返します。

パラメータ:
Bcc - 検索対象のBCC
戻り値:
指定したBCCの最初のインデックス。見つからない場合は -1。

setNotification

public void setNotification(boolean Value)
開封確認要求を行うかどうかを設定します。

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

パラメータ:
Value - 開封確認要求を行うかどうかを示す boolean。開封確認要求を行う場合は true、そうでない場合は false。

getNotification

public boolean getNotification()
setNotification で設定した開封確認要求を行うかどうかを示す boolean を返します。

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

戻り値:
setNotification で設定した開封確認要求を行うかどうかを示す boolean。開封確認要求を行う場合は true、そうでない場合は false。

setHtmlMail

public void setHtmlMail(boolean Value)
生成したドキュメントを内容とするHTMLメールとするかどうかを設定します。
フォーマットがHTML形式の場合のみ、HTMLメールとすることができます。

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

パラメータ:
Value - HTMLメールとするかどうかを示す boolean 。HTMLメールとする場合は true、そうでない場合は false。
関連項目:
OXSParameter.setFormat, OXSHandler.FORMAT_HTML

getHtmlMail

public boolean getHtmlMail()
setHtmlMail で設定したHTMLメールとするかどうかを示す boolean を返します。

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

戻り値:
setHtmlMail で設定したHTMLメールとするかどうかを示す boolean。HTMLメールとする場合は true、そうでない場合は false。

OPRO Japan Co.,Ltd.