pure.sendmail
[ class tree: pure.sendmail ] [ index: pure.sendmail ] [ all elements ]
Packages:
com.arcadiangarden.ssx.calendar
com.arcadiangarden.ssx.logbook
com.arcadiangarden.ssx.struct
core
pure.db.datasource
pure.db.oci8
pure.db.util
pure.fw.brownie
pure.fw.filter.final
pure.fw.rss
pure.fw.taglib
pure.sendmail
pure.session
pure.util


Files:
MailAddress.inc
MailMessage.inc
MailPart.inc
MIMEMAIL.inc
SendmailException.inc
SMTP.inc

Classes:
ESendmailException
MailAddress
MailMessage
MailPart
MIMEMAIL
SMTP

Class: MailMessage

Source Location: /package/pure/sendmail/MailMessage.inc

Class Overview

PURE_Class
   |
   --MailPart
      |
      --MailMessage

MIME形式インターネットメールのメールメッセージを保持するクラスです。

Methods

Inherited Methods

Class: MailPart

MailPart::__construct()
コンストラクタです。
MailPart::addPart()
マルチパートメッセージを作成するために、含まれるパートを追加します。
MailPart::getBody()
ボディに設定されている内容を取得します。
MailPart::getContentType()
現在設定されているContent-Typeを取得します。
MailPart::getName()
ボディの名前を取得します。
MailPart::partCount()
含まれているパートの個数を取得します。
MailPart::parts()
指定のインデックスのパートを取得します。
MailPart::setBody()
ボディを設定します。
MailPart::setName()
ボディの名前を設定します。
MailPart::toMailPart()
パートのメールメッセージの整形して返します。

Class Details

[line 32]
MIME形式インターネットメールのメールメッセージを保持するクラスです。

MailMessageクラスは単純なテキストメールから、添付ファイルのあるメール、複雑なマルチパートメッセージまで対応しています。




[ Top ]

Class Methods

constructor __construct [line 68]

MailMessage __construct( )

コンストラクタです。



Tags:

access:  public


Overrides MailPart::__construct() (コンストラクタです。)

[ Top ]

method addAttachFile [line 315]

void addAttachFile( string $content, string $name, string $contentType)

メールに添付ファイルを設定します。

addAttachFileメソッドはメールに添付ファイルを設定する簡易的な手段です。




Tags:

access:  public


Parameters:

string   $content   添付ファイルの内容
string   $name   添付ファイル名
string   $contentType   添付ファイルのContent-Type

[ Top ]

method addBcc [line 227]

void addBcc( string $address, [string $name = false])

BCCにアドレスを追加設定します。

メールアドレスが不正の場合にはESendmailException例外が発生します。 名前に含まれる半角カタカナは全角カタカナへ変換されます。 同じメールアドレスが既にBCCに登楼されている場合には無視されます。




Tags:

throws:  ESendmailException メールアドレスが不正
access:  public


Parameters:

string   $address   メールアドレス
string   $name   メールアドレスの持ち主の名前

[ Top ]

method addCc [line 170]

void addCc( string $address, [string $name = false])

CCにアドレスを追加設定します。

メールアドレスが不正の場合にはESendmailException例外が発生します。 名前に含まれる半角カタカナは全角カタカナへ変換されます。 同じメールアドレスが既にCCに登楼されている場合には無視されます。




Tags:

throws:  ESendmailException メールアドレスが不正
access:  public


Parameters:

string   $address   メールアドレス
string   $name   メールアドレスの持ち主の名前

[ Top ]

method addTo [line 113]

void addTo( string $address, [string $name = false])

Toにアドレスを追加設定します。

メールアドレスが不正の場合にはESendmailException例外が発生します。 名前に含まれる半角カタカナは全角カタカナへ変換されます。 同じメールアドレスが既にToに登楼されている場合には無視されます。




Tags:

throws:  ESendmailException メールアドレスが不正
access:  public


Parameters:

string   $address   メールアドレス
string   $name   メールアドレスの持ち主の名前

[ Top ]

method getBcc [line 255]

MailAddress getBcc( int $index)

BCCに登録されている指定のインデックスのアドレスを取得します。

範囲外のインデックスを指定した場合にはEIlligalParameterException例外が発生します。




Tags:

return:  メールアドレス情報
throws:  EIlligalParameterException インデックスが不正
access:  public


Parameters:

int   $index   インデックス

[ Top ]

method getBccCount [line 268]

int getBccCount( )

BCCに登録されているアドレスの数を取得します。



Tags:

return:  BCCに登録されているアドレスの数
access:  public


[ Top ]

method getCc [line 198]

MailAddress getCc( int $index)

CCに登録されている指定のインデックスのアドレスを取得します。

範囲外のインデックスを指定した場合にはEIlligalParameterException例外が発生します。




Tags:

return:  メールアドレス情報
throws:  EIlligalParameterException インデックスが不正
access:  public


Parameters:

int   $index   インデックス

[ Top ]

method getCcCount [line 211]

int getCcCount( )

CCに登録されているアドレスの数を取得します。



Tags:

return:  CCに登録されているアドレスの数
access:  public


[ Top ]

method getFrom [line 301]

MailAddress getFrom( )

Fromに登録されているアドレスを取得します。

設定されていない場合にはnullを返します。




Tags:

return:  Fromに登録されているアドレス
access:  public


[ Top ]

method getRcptTo [line 386]

array getRcptTo( )

MTAにRCPT TO:命令で指示する送信先メールアドレスの一覧を保持する配列を取得します。

To、CC、BCC各送信先のメールアドレスをまとめた物になります。 万が一同じメールアドレスが存在した場合には、ひとつだけが取得されます。




Tags:

return:  RCPT TO:に設定するメールアドレスの一覧
access:  public


[ Top ]

method getSubject [line 82]

string getSubject( )

Subjectに設定されるサブジェクトを取得します。



Tags:

return:  Subjectに設定されるサブジェクト
access:  public


[ Top ]

method getTo [line 141]

MailAddress getTo( int $index)

Toに登録されている指定のインデックスのアドレスを取得します。

範囲外のインデックスを指定した場合にはEIlligalParameterException例外が発生します。




Tags:

return:  メールアドレス情報
throws:  EIlligalParameterException インデックスが不正
access:  public


Parameters:

int   $index   インデックス

[ Top ]

method getToCount [line 154]

int getToCount( )

Toに登録されているアドレスの数を取得します。



Tags:

return:  Toに登録されているアドレスの数
access:  public


[ Top ]

method send [line 418]

void send( )

メールを送信します。

メール送信はSMTPクラスののsendメソッドを実行することで実現されます。 利用するMTAの設定などはSMTPクラスで行ってください。




Tags:

throws:  ESendmailException メール送信に失敗
access:  public


[ Top ]

method setFrom [line 282]

void setFrom( string $address, [string $name = false])

Fromにアドレスを設定します。

メールアドレスが不正の場合にはESendmailException例外が発生します。




Tags:

throws:  ESendmailException メールアドレスが不正
access:  public


Parameters:

string   $address   メールアドレス
string   $name   メールアドレスの持ち主の名前

[ Top ]

method setSubject [line 94]

void setSubject( string $subject)

Subjectに設定されるサブジェクトを設定します。

サブジェクトに含まれる半角カタカナは全角カタカナへ変換されます。




Tags:

access:  public


Parameters:

string   $subject   Subjectに設定されるサブジェクト

[ Top ]

method toMailBody [line 328]

string toMailBody( )

メールボディを生成して返します。

メールボディを生成するための情報が足りない場合にはESendmailException例外が発生します。




Tags:

return:  生成されたメールボディ
throws:  ESendmailException メールボディ作成の情報不足
access:  public


[ Top ]

Documentation generated on Sun, 06 Jan 2008 01:33:17 +0900 by phpDocumentor 1.3.2