com.ozacc.mail.impl
クラス SendMailProImpl

java.lang.Object
  拡張com.ozacc.mail.impl.SendMailProImpl
すべての実装インタフェース:
SendMailPro

public class SendMailProImpl
extends Object
implements SendMailPro

SendMailProインターフェースの実装クラス。

導入されたバージョン:
1.0
バージョン:
$Id: SendMailProImpl.java,v 1.5 2005/01/17 15:28:18 otsuka Exp $
作成者:
Tomohiro Otsuka

フィールドの概要
static String DEFAULT_HOST
          localhost
static int DEFAULT_PORT
          -1
static String DEFAULT_PROTOCOL
          smtp
static String JIS_CHARSET
          ISO-2022-JP
 
コンストラクタの概要
SendMailProImpl()
          コンストラクタ。
SendMailProImpl(String host)
          コンストラクタ。
 
メソッドの概要
 void connect()
          SMTPサーバに接続します。
 MimeMessage createMimeMessage()
          新しいMimeMessageオブジェクトを生成します。
 void disconnect()
          SMTPサーバとの接続をクローズします。
 String getCharset()
          エンコーディングに使用する文字コードを返します。
 String getHost()
           
 String getPassword()
           
 int getPort()
           
 String getProtocol()
           
 String getReturnPath()
           
protected  Session getSession()
           
 String getUsername()
           
 void send(Mail mail)
          指定されたMailを送信します。
 void send(MimeMessage mimeMessage)
          指定されたMimeMessageを送信します。
 void setCharset(String charset)
          メールの件名や本文のエンコーディングに使用する文字コードを指定します。
 void setConnectionTimeout(int connectionTimeout)
          SMTPサーバとの接続タイムアウトをセットします。
 void setHost(String host)
          SMTPサーバのホスト名、またはIPアドレスをセットします。
 void setMessageId(String messageId)
          生成されるMimeMessageに付けられるMessage-Idヘッダのドメイン部分を指定します。
 void setPassword(String password)
          SMTPサーバの接続認証が必要な場合にパスワードをセットします。
 void setPort(int port)
          SMTPサーバのポート番号をセットします。
 void setProtocol(String protocol)
           
 void setReadTimeout(int readTimeout)
          SMTPサーバへの送受信時のタイムアウトをセットします。
 void setReturnPath(String returnPath)
          Return-Pathアドレスをセットします。
 void setUsername(String username)
          SMTPサーバの接続認証が必要な場合にユーザ名をセットします。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

DEFAULT_PROTOCOL

public static final String DEFAULT_PROTOCOL
smtp

関連項目:
定数フィールド値

DEFAULT_PORT

public static final int DEFAULT_PORT
-1

関連項目:
定数フィールド値

DEFAULT_HOST

public static final String DEFAULT_HOST
localhost

関連項目:
定数フィールド値

JIS_CHARSET

public static final String JIS_CHARSET
ISO-2022-JP

関連項目:
定数フィールド値
コンストラクタの詳細

SendMailProImpl

public SendMailProImpl()
コンストラクタ。


SendMailProImpl

public SendMailProImpl(String host)
コンストラクタ。使用するSMTPサーバを指定します。

パラメータ:
host - SMTPサーバのホスト名、またはIPアドレス
メソッドの詳細

connect

public void connect()
             throws MailException
インタフェース SendMailPro の記述:
SMTPサーバに接続します。

定義:
インタフェース SendMailPro 内の connect
例外:
MailException
関連項目:
SendMailPro.connect()

disconnect

public void disconnect()
                throws MailException
インタフェース SendMailPro の記述:
SMTPサーバとの接続をクローズします。 接続していない時にこのメソッドを呼んでも何も行いません。

定義:
インタフェース SendMailPro 内の disconnect
例外:
MailException
関連項目:
SendMailPro.disconnect()

send

public void send(MimeMessage mimeMessage)
          throws MailException
インタフェース SendMailPro の記述:
指定されたMimeMessageを送信します。SMTPサーバに接続していない場合は例外をスローします。

定義:
インタフェース SendMailPro 内の send
パラメータ:
mimeMessage -
例外:
MailException
関連項目:
SendMailPro.send(javax.mail.internet.MimeMessage)

send

public void send(Mail mail)
          throws MailException
インタフェース SendMailPro の記述:
指定されたMailを送信します。SMTPサーバに接続していない場合は例外をスローします。

定義:
インタフェース SendMailPro 内の send
パラメータ:
mail -
例外:
MailException
関連項目:
SendMailPro.send(com.ozacc.mail.Mail)

createMimeMessage

public MimeMessage createMimeMessage()
新しいMimeMessageオブジェクトを生成します。

戻り値:
新しいMimeMessageオブジェクト

getSession

protected Session getSession()
戻り値:
Returns the session.

getCharset

public String getCharset()
エンコーディングに使用する文字コードを返します。

戻り値:
エンコーディングに使用する文字コード

setCharset

public void setCharset(String charset)
メールの件名や本文のエンコーディングに使用する文字コードを指定します。 デフォルトは ISO-2022-JP です。

日本語環境で利用する場合は通常変更する必要はありません。

パラメータ:
charset - エンコーディングに使用する文字コード

getHost

public String getHost()
戻り値:
Returns the host.

setHost

public void setHost(String host)
SMTPサーバのホスト名、またはIPアドレスをセットします。 デフォルトは localhost です。

パラメータ:
host - SMTPサーバのホスト名、またはIPアドレス

getPassword

public String getPassword()
戻り値:
SMTPサーバ認証パスワード

setPassword

public void setPassword(String password)
SMTPサーバの接続認証が必要な場合にパスワードをセットします。

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

getPort

public int getPort()
戻り値:
SMTPサーバのポート番号

setPort

public void setPort(int port)
SMTPサーバのポート番号をセットします。

パラメータ:
port - SMTPサーバのポート番号

getProtocol

public String getProtocol()
戻り値:
Returns the protocol.

setProtocol

public void setProtocol(String protocol)
パラメータ:
protocol - The protocol to set.

getReturnPath

public String getReturnPath()
戻り値:
Return-Pathアドレス

setReturnPath

public void setReturnPath(String returnPath)
Return-Pathアドレスをセットします。

送信するMailインスタンスに指定されたFromアドレス以外のアドレスをReturn-Pathとしたい場合に使用します。 ここでセットされたReturn-Pathより、MailインスタンスにセットされたReturn-Pathが優先されます。

パラメータ:
returnPath - Return-Pathアドレス

getUsername

public String getUsername()
戻り値:
SMTPサーバ認証ユーザ名

setUsername

public void setUsername(String username)
SMTPサーバの接続認証が必要な場合にユーザ名をセットします。

パラメータ:
username - SMTPサーバ認証ユーザ名

setMessageId

public void setMessageId(String messageId)
生成されるMimeMessageに付けられるMessage-Idヘッダのドメイン部分を指定します。
指定されない場合(nullや空文字列の場合)は、JavaMailがMessage-Idヘッダを生成します。 JavaMailが生成する「JavaMail.実行ユーザ名@ホスト名」のMessage-Idを避けたい場合に、このメソッドを使用します。

messageIdプロパティがセットされている場合、Mailから生成されるMimeMessageのMessage-Idには タイムスタンプ + ランダムに生成される16桁の数値 + ここでセットされた値 が使用されます。

生成されるMessage-Idの例。 (実際の数値部分は送信メール毎に変わります)

注: このMessage-Idはsend(Mail)send(Mail[])メソッドが呼びだれた時にのみ有効です。MimeMessageを直接送信する場合には適用されません。

パラメータ:
messageId - メールに付けられるMessage-Idヘッダのドメイン部分
例外:
IllegalArgumentException - @を複数含んだ文字列を指定した場合

setConnectionTimeout

public void setConnectionTimeout(int connectionTimeout)
SMTPサーバとの接続タイムアウトをセットします。 単位はミリ秒。デフォルトは5,000ミリ秒(5秒)です。

-1を指定すると無限大になりますが、お薦めしません。

パラメータ:
connectionTimeout - SMTPサーバとの接続タイムアウト
導入されたバージョン:
1.1.4

setReadTimeout

public void setReadTimeout(int readTimeout)
SMTPサーバへの送受信時のタイムアウトをセットします。 単位はミリ秒。デフォルトは5,000ミリ秒(5秒)です。

-1を指定すると無限大になりますが、お薦めしません。

パラメータ:
readTimeout - SMTPサーバへの送受信時のタイムアウト
導入されたバージョン:
1.1.4


Copyright © 2004-2005 OZACC. All Rights Reserved.