com.ozacc.mail
クラス Mail

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

public class Mail
extends Object

メール。

導入されたバージョン:
1.0
バージョン:
$Id: Mail.java,v 1.11 2005/01/17 09:08:16 otsuka Exp $
作成者:
Tomohiro Otsuka

入れ子クラスの概要
 class Mail.AttachmentFile
          添付ファイル。
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 addFile(File file)
          指定されたファイルを添付します。
 void addFile(File file, String fileName)
          指定されたファイルを添付します。
 void addFile(InputStream is, String fileName)
          指定されたInputStreamをファイルとして添付します。
 void addFile(URL url, String fileName)
          指定されたURLのファイルを添付します。
 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 clearFile()
          セットされている添付ファイルを全てクリアします。
 void clearTo()
          セットされている送信先アドレス(Toアドレス)を全てクリアします。
 Mail.AttachmentFile[] getAttachmentFiles()
          添付ファイルの配列を返します。
 InternetAddress[] getBcc()
          メールのBCCアドレスの配列を返します。
 InternetAddress[] getCc()
          メールのCCアドレス配列を返します。
 String getCharset()
          エンコードに使用する文字コードを返します。
 InternetAddress getFrom()
          メールの差出人アドレスを返します。
 String getHtmlText()
          HTMLの本文を返します。
 String getImportance()
          メールの重要度を返します。
 InternetAddress getReplyTo()
          メールの返信先アドレスを返します。
 InternetAddress getReturnPath()
          Return-Pathアドレスを返します。
 String getSubject()
          メールの件名を返します。
 String getText()
          メール本文を返します。
 InternetAddress[] getTo()
          メールの送信先アドレスの配列を返します。
 Map getXHeaders()
          メールの任意ヘッダ名と値のMapインスタンスを返します。
 boolean isFileAttached()
          ファイルが添付されているかどうか判定します。
 boolean isHtmlMail()
          HTMLの本文がセットされているかどうか判定します。
 boolean isMultipartMail()
          マルチパート・メールかどうか判定します。
 void setFrom(InternetAddress address)
          メールの差出人アドレスをセットします。
 void setFrom(String email)
          メールの差出人アドレスをセットします。
 void setFrom(String email, String name)
          メールの差出人名とアドレスをセットします。
 void setHtmlText(String htmlText)
          HTMLの本文をセットします。
 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)
コピーコンストラクタ。 シャローコピー(shallow copy)です。

パラメータ:
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

setHtmlText

public void setHtmlText(String htmlText)
HTMLの本文をセットします。

パラメータ:
htmlText - HTMLの本文
導入されたバージョン:
1.1

getHtmlText

public String getHtmlText()
HTMLの本文を返します。

戻り値:
HTMLの本文。またはnull。
導入されたバージョン:
1.1

addFile

public void addFile(File file)
指定されたファイルを添付します。 添付ファイル名には、指定されたファイルの名前が使用されます。 このファイルの名前は適切な拡張子が付けられている必要があります。

パラメータ:
file - 添付ファイル
導入されたバージョン:
1.1

addFile

public void addFile(File file,
                    String fileName)
指定されたファイルを添付します。 指定するファイル名には適切な拡張子が付けられている必要があります。

パラメータ:
file - 添付ファイル
fileName - ファイル名
導入されたバージョン:
1.1

addFile

public void addFile(URL url,
                    String fileName)
指定されたURLのファイルを添付します。 指定するファイル名には適切な拡張子が付けられている必要があります。

パラメータ:
url - 添付ファイル
fileName - ファイル名
導入されたバージョン:
1.1

addFile

public void addFile(InputStream is,
                    String fileName)
指定されたInputStreamをファイルとして添付します。 指定するファイル名には適切な拡張子が付けられている必要があります。

パラメータ:
is - 添付ファイルを生成するInputStream
fileName - ファイル名
導入されたバージョン:
1.1

getAttachmentFiles

public Mail.AttachmentFile[] getAttachmentFiles()
添付ファイルの配列を返します。 添付ファイルがセットされていない場合は、空の配列を返します。

戻り値:
添付ファイルの配列。または空の配列。
導入されたバージョン:
1.1

isHtmlMail

public boolean isHtmlMail()
HTMLの本文がセットされているかどうか判定します。

戻り値:
HTMLの本文がセットされている場合 true
導入されたバージョン:
1.1

isFileAttached

public boolean isFileAttached()
ファイルが添付されているかどうか判定します。

戻り値:
ファイルが添付されている場合 true
導入されたバージョン:
1.1

isMultipartMail

public boolean isMultipartMail()
マルチパート・メールかどうか判定します。
HTML本文がセットされているか、ファイルが添付されている場合に true が返されます。

注: ここで判定されるマルチパートは、厳密な意味でのマルチパートではありません。

戻り値:
マルチパート・メールの場合 true
導入されたバージョン:
1.1

clearFile

public void clearFile()
セットされている添付ファイルを全てクリアします。

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


Copyright © 2004-2005 OZACC. All Rights Reserved.