commons-mail
b2007062501

org.phosphoresce.commons.mail
クラス MailConfiguration

java.lang.Object
  拡張org.phosphoresce.commons.mail.MailConfiguration
すべての実装インタフェース:
MailDeclareInterface, java.io.Serializable
直系の既知のサブクラス:
MailPOP3Configuration, MailSMTPConfiguration

public abstract class MailConfiguration
extends java.lang.Object
implements java.io.Serializable, MailDeclareInterface

メール環境設定抽象クラス。

作成者:
Kitagawa
関連項目:
直列化された形式

フィールドの概要
 
インタフェース org.phosphoresce.commons.mail.MailDeclareInterface から継承したフィールド
CHARSET_ISO_2022_JP, DEFAULT_MIME_CHARSET, EMAIL_EXTENSION, PRIMARY_FOLDER
 
コンストラクタの概要
MailConfiguration()
          コンストラクタ
MailConfiguration(java.lang.String protocol, java.lang.String server, int port, java.lang.String user, java.lang.String password)
          コンストラクタ
 
メソッドの概要
protected abstract  void appendSessionProperties(java.util.Properties properties)
          各環境設定オブジェクトが保持する情報をPropertiesオブジェクトに追加します。
static boolean checkConnection(MailConfiguration configuration)
          指定されたサーバー接続環境設定が妥当であるかチェックします。
protected  java.util.Properties createSessionProperties()
          JavaMailに提供するPropertiesオブジェクトを生成します。
 boolean getDebug()
          JavaMailデバッグフラグを取得します。
 java.lang.String getPassword()
          サーバー認証パスワードを取得します。
 int getPort()
          portを取得します。
 java.lang.String getProtocol()
          サーバープロトコルを取得します。
 java.lang.String getServer()
          サーバーアドレスを取得します。
protected  javax.mail.Session getSession()
          JavaMailセッションオブジェクトを取得します。
 java.lang.String getUser()
          サーバー認証ユーザーを取得します。
protected abstract  boolean isSender()
          環境設定情報が送信用定義であるか取得します。
 void setDebug(boolean debug)
          JavaMailデバッグフラグを設定します。
 void setPassword(java.lang.String password)
          サーバー認証パスワードを設定します。
 void setPort(int port)
          サーバーポートを設定します。
 void setProtocol(java.lang.String protocol)
          サーバープロトコルを設定します。
 void setServer(java.lang.String server)
          サーバーアドレスを設定します。
 void setUser(java.lang.String user)
          サーバー認証ユーザーを設定します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

MailConfiguration

public MailConfiguration()
コンストラクタ


MailConfiguration

public MailConfiguration(java.lang.String protocol,
                         java.lang.String server,
                         int port,
                         java.lang.String user,
                         java.lang.String password)
コンストラクタ

パラメータ:
protocol - サーバープロトコル
server - サーバーアドレス
port - サーバーポート
user - サーバー認証ユーザー
password - サーバー認証パスワード
メソッドの詳細

createSessionProperties

protected final java.util.Properties createSessionProperties()
JavaMailに提供するPropertiesオブジェクトを生成します。

戻り値:
JavaMailに提供するPropertiesオブジェクト

appendSessionProperties

protected abstract void appendSessionProperties(java.util.Properties properties)
各環境設定オブジェクトが保持する情報をPropertiesオブジェクトに追加します。

パラメータ:
properties - Propertiesオブジェクト

isSender

protected abstract boolean isSender()
環境設定情報が送信用定義であるか取得します。

戻り値:
送信用定義である場合、trueを返却

checkConnection

public static final boolean checkConnection(MailConfiguration configuration)
指定されたサーバー接続環境設定が妥当であるかチェックします。

パラメータ:
configuration - サーバー接続環境設定
戻り値:
指定されたサーバー接続環境で正常に接続できる場合にtrueを返却します

getSession

protected final javax.mail.Session getSession()
JavaMailセッションオブジェクトを取得します。

戻り値:
JavaMailセッションオブジェクト

getDebug

public final boolean getDebug()
JavaMailデバッグフラグを取得します。

戻り値:
JavaMailデバッグフラグ

setDebug

public final void setDebug(boolean debug)
JavaMailデバッグフラグを設定します。

パラメータ:
debug - JavaMailデバッグフラグ

getPassword

public final java.lang.String getPassword()
サーバー認証パスワードを取得します。

戻り値:
サーバー認証パスワード

setPassword

public final void setPassword(java.lang.String password)
サーバー認証パスワードを設定します。

パラメータ:
password - サーバー認証パスワード

getPort

public final int getPort()
portを取得します。

戻り値:
port

setPort

public final void setPort(int port)
サーバーポートを設定します。

パラメータ:
port - サーバーポート

getProtocol

public final java.lang.String getProtocol()
サーバープロトコルを取得します。

戻り値:
サーバープロトコル

setProtocol

public final void setProtocol(java.lang.String protocol)
サーバープロトコルを設定します。

パラメータ:
protocol - サーバープロトコル

getServer

public final java.lang.String getServer()
サーバーアドレスを取得します。

戻り値:
サーバーアドレス

setServer

public final void setServer(java.lang.String server)
サーバーアドレスを設定します。

パラメータ:
server - サーバーアドレス

getUser

public final java.lang.String getUser()
サーバー認証ユーザーを取得します。

戻り値:
サーバー認証ユーザー

setUser

public final void setUser(java.lang.String user)
サーバー認証ユーザーを設定します。

パラメータ:
user - サーバー認証ユーザー

commons-mail
b2007062501