com.ozacc.mail
クラス Mail

java.lang.Object
  拡張com.ozacc.mail.Mail
直系の既知のサブクラス:
MockMail

public class Mail
extends Object

メール。

導入されたバージョン:
1.0
バージョン:
$Id: Mail.java,v 1.7 2004/09/14 00:04:57 otsuka Exp $
作成者:
Tomohiro Otsuka

入れ子クラスの概要
static class Mail.Importance
          メールの重要度。
 
フィールドの概要
static String DOCTYPE_PUBLIC
           
static String DOCTYPE_SYSTEM
           
static String JIS_CHARSET
          ISO-2022-JP
 
コンストラクタの概要
Mail()
          コンストラクタ。
Mail(Mail original)
          コピーコンストラクタ。
Mail(String charset)
          コンストラクタ。
 
メソッドの概要
 void addBcc(InternetAddress address)
          BCCアドレスを追加します。
 void addBcc(String email)
          BCCアドレスを追加します。
 void addCc(InternetAddress address)
          CCアドレスを追加します。
 void addCc(String email)
          CCアドレスを追加します。
 void addCc(String email, String name)
          CCの宛名とアドレスを追加します。
 void addTo(InternetAddress address)
          メールの送信先アドレスを追加します。
 void addTo(String email)
          メールの送信先アドレスを追加します。
 void addTo(String email, String name)
          メールの送信先名とアドレスを追加します。
 void addXHeader(String key, String value)
          メールヘッダに任意のヘッダを追加します。
 void clearBcc()
          セットされているBCCアドレスを全てクリアします。
 void clearCc()
          セットされているCCアドレスを全てクリアします。
 void clearTo()
          セットされている送信先アドレス(Toアドレス)を全てクリアします。
 InternetAddress[] getBcc()
          メールのBCCアドレスの配列を返します。
 InternetAddress[] getCc()
          メールのCCアドレス配列を返します。
 String getCharset()
          エンコードに使用する文字コードを返します。
 InternetAddress getFrom()
          メールの差出人アドレスを返します。
 String getImportance()
          メールの重要度を返します。
 InternetAddress getReplyTo()
          メールの返信先アドレスを返します。
 InternetAddress getReturnPath()
          Return-Pathアドレスを返します。
 String getSubject()
          メールの件名を返します。
 String getText()
          メール本文を返します。
 InternetAddress[] getTo()
          メールの送信先アドレスの配列を返します。
 Map getXHeaders()
          メールの任意ヘッダ名と値のMapインスタンスを返します。
 void setFrom(InternetAddress address)
          メールの差出人アドレスをセットします。
 void setFrom(String email)
          メールの差出人アドレスをセットします。
 void setFrom(String email, String name)
          メールの差出人名とアドレスをセットします。
 void setImportance(String importance)
          メールの重要度をセットします。
 void setReplyTo(InternetAddress address)
          返信先アドレスをセットします。
 void setReplyTo(String email)
          返信先アドレスをセットします。
 void setReturnPath(InternetAddress address)
          Return-Pathアドレスをセットします。
 void setReturnPath(String email)
          Return-Pathアドレスをセットします。
 void setSubject(String subject)
          メールの件名をセットします。
 void setText(String text)
          メール本文をセットします。
 String toString()
          メール内容を出力します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

フィールドの詳細

JIS_CHARSET

public static final String JIS_CHARSET
ISO-2022-JP

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

DOCTYPE_PUBLIC

public static final String DOCTYPE_PUBLIC
関連項目:
定数フィールド値

DOCTYPE_SYSTEM

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

Mail

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


Mail

public Mail(String charset)
コンストラクタ。 宛先や差出人の名前をエンコードする時に使用する文字コードを指定します。 デフォルトはISO-2022-JPです。

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

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

Mail

public Mail(Mail original)
コピーコンストラクタ。

パラメータ:
original - コピー元のMailインスタンス
導入されたバージョン:
1.0.2
メソッドの詳細

getCharset

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

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

setImportance

public void setImportance(String importance)
                   throws IllegalArgumentException
メールの重要度をセットします。 引数で指定可能な値は「high」、「normal」、「low」のいずれかです。

パラメータ:
importance - メールの重要度。「high」、「normal」、「low」のいずれか。
例外:
IllegalArgumentException - 指定可能な値以外が指定された場合
関連項目:
Mail.Importance

getImportance

public String getImportance()
メールの重要度を返します。 値は「high」、「normal」、「low」のいずれかです。

戻り値:
メールの重要度。「high」、「normal」、「low」のいずれか。

addTo

public void addTo(InternetAddress address)
メールの送信先アドレスを追加します。

パラメータ:
address - 送信先アドレス

addTo

public void addTo(String email)
           throws IllegalArgumentException
メールの送信先アドレスを追加します。

パラメータ:
email - 送信先アドレス
例外:
IllegalArgumentException - 不正なフォーマットのアドレスが指定された場合

addTo

public void addTo(String email,
                  String name)
           throws IllegalArgumentException
メールの送信先名とアドレスを追加します。 名前はJIS_CHARSETでエンコードされます。

パラメータ:
email - 送信先アドレス
name - 送信先名
例外:
IllegalArgumentException - 不正なフォーマットのアドレスが指定された場合

getTo

public InternetAddress[] getTo()
メールの送信先アドレスの配列を返します。 送信先アドレスが一件もセットされていないときは空の配列を返します。

戻り値:
送信先アドレスの配列

addCc

public void addCc(InternetAddress address)
CCアドレスを追加します。

パラメータ:
address - CCのアドレス

addCc

public void addCc(String email)
           throws IllegalArgumentException
CCアドレスを追加します。

パラメータ:
email - CCのアドレス
例外:
IllegalArgumentException - 不正なフォーマットのアドレスが指定された場合

addCc

public void addCc(String email,
                  String name)
           throws IllegalArgumentException
CCの宛名とアドレスを追加します。 名前はJIS_CHARSETでエンコードされます。

パラメータ:
email - CCのアドレス
name - CCの宛名
例外:
IllegalArgumentException - 不正なフォーマットのアドレスが指定された場合

getCc

public InternetAddress[] getCc()
メールのCCアドレス配列を返します。 CCアドレスが一件もセットされていないときは空の配列を返します。

戻り値:
CCアドレスの配列

addBcc

public void addBcc(InternetAddress address)
BCCアドレスを追加します。

パラメータ:
address - BCCのアドレス

addBcc

public void addBcc(String email)
            throws IllegalArgumentException
BCCアドレスを追加します。

パラメータ:
email - BCCのアドレス
例外:
IllegalArgumentException - 不正なフォーマットのアドレスが指定された場合

getBcc

public InternetAddress[] getBcc()
メールのBCCアドレスの配列を返します。 BCCアドレスが一件もセットされていないときは空の配列を返します。

戻り値:
BCCアドレスの配列

setFrom

public void setFrom(InternetAddress address)
メールの差出人アドレスをセットします。

パラメータ:
address - 差出人アドレス

setFrom

public void setFrom(String email)
             throws IllegalArgumentException
メールの差出人アドレスをセットします。

パラメータ:
email - 差出人アドレス
例外:
IllegalArgumentException - 不正なフォーマットのアドレスが指定された場合

setFrom

public void setFrom(String email,
                    String name)
             throws IllegalArgumentException
メールの差出人名とアドレスをセットします。 名前はJIS_CHARSETでエンコードされます。

パラメータ:
email - 差出人アドレス
name - 差出人名
例外:
IllegalArgumentException - 不正なフォーマットのアドレスが指定された場合

getFrom

public InternetAddress getFrom()
メールの差出人アドレスを返します。セットされていない場合はnullを返します。

戻り値:
メールの差出人アドレス

setReturnPath

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

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

setReturnPath

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

パラメータ:
email - Return-Pathアドレス
例外:
IllegalArgumentException - 不正なフォーマットのアドレスが指定された場合

getReturnPath

public InternetAddress getReturnPath()
Return-Pathアドレスを返します。

戻り値:
Return-Pathアドレス

setReplyTo

public void setReplyTo(InternetAddress address)
返信先アドレスをセットします。

パラメータ:
address - 返信先アドレス

setReplyTo

public void setReplyTo(String email)
                throws IllegalArgumentException
返信先アドレスをセットします。

パラメータ:
email - 返信先アドレス
例外:
IllegalArgumentException - 不正なフォーマットのアドレスが指定された場合

getReplyTo

public InternetAddress getReplyTo()
メールの返信先アドレスを返します。セットされていない場合はnullを返します。

戻り値:
返信先アドレス

getSubject

public String getSubject()
メールの件名を返します。セットされていない場合は空文字列を返します。

戻り値:
メールの件名

setSubject

public void setSubject(String subject)
メールの件名をセットします。

パラメータ:
subject - メールの件名

getText

public String getText()
メール本文を返します。 本文セットされていない場合は空文字列を返します。

戻り値:
メール本文

setText

public void setText(String text)
メール本文をセットします。

パラメータ:
text - メール本文

addXHeader

public void addXHeader(String key,
                       String value)
メールヘッダに任意のヘッダを追加します。 任意ヘッダは「X-key: value」のフォーマットでメールヘッダに組み込まれます。

パラメータ:
key - 任意ヘッダ名。頭が"X-"で始まっていなければ、自動的に付与されます。
value - 任意ヘッダの値

getXHeaders

public Map getXHeaders()
メールの任意ヘッダ名と値のMapインスタンスを返します。 任意ヘッダが一件もセットされていないときはnullを返します。

このMapインスタンスへの修正はできません。(unmodifiableMapになっています。)

戻り値:
メールの任意ヘッダ名と値のMapインスタンス。またはnull。

toString

public String toString()
メール内容を出力します。
メールのソースに似たフォーマットで出力されます。

関連項目:
Object.toString()

clearTo

public void clearTo()
セットされている送信先アドレス(Toアドレス)を全てクリアします。

導入されたバージョン:
1.0.2

clearCc

public void clearCc()
セットされているCCアドレスを全てクリアします。

導入されたバージョン:
1.0.2

clearBcc

public void clearBcc()
セットされているBCCアドレスを全てクリアします。

導入されたバージョン:
1.0.2


Copyright © 2004 OZACC. All Rights Reserved.