pure.sendmail
[ class tree: pure.sendmail ] [ index: pure.sendmail ] [ all elements ]

Class: MailPart

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

Class Overview

PURE_Class
   |
   --MailPart

MIME形式インターネットメールのひとつのパートを保持するクラスです。


Methods


Child classes:

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

Class Details

[line 31]
MIME形式インターネットメールのひとつのパートを保持するクラスです。

通常、MailMessageクラスに保持されますが、複雑なマルチパートメッセージを構成したい場合には更にパートを保持することも出来ます。




[ Top ]


Class Methods


constructor __construct [line 63]

MailPart __construct( )

コンストラクタです。

Content-Typeはtext/plainに初期設定されています。




Tags:

access:  public


Overridden in child classes as:

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

[ Top ]

method addPart [line 170]

void addPart( MailPart $part, [string $contentType = false])

マルチパートメッセージを作成するために、含まれるパートを追加します。

パートには既に生成されているMailPartクラスのインスタンスを指定します。 $contentTypeにはマルチパートに含まれるパートの関係性を表すContent-Typeを指定します。 指定を省略した場合、現在のContent-Typeがマルチパートの関係性を表すものであれば現在の設定が維持され、それ以外であればmultipart/mixedが設定されます。 不正なContent-Typeを指定した場合にはESendmailException例外が発生します。

なお、シングルパートメッセージとマルチパートメッセージは相容れません。 既に設定されているボディは破棄されます。




Tags:

throws:  ESendmailException 不正なContent-Type
access:  public


Parameters:

MailPart   $part   マルチパートのパート
string   $contentType   Content-Type

[ Top ]

method getBody [line 88]

string getBody( )

ボディに設定されている内容を取得します。

マルチパートメッセージの場合には空の文字列が返されます。




Tags:

return:  ボディに設定されている内容
access:  public


[ Top ]

method getContentType [line 76]

string getContentType( )

現在設定されているContent-Typeを取得します。



Tags:

return:  Content-Type
access:  public


[ Top ]

method getName [line 137]

ボディの名前 getName( )

ボディの名前を取得します。



Tags:

access:  public


[ Top ]

method partCount [line 201]

int partCount( )

含まれているパートの個数を取得します。

マルチパートメッセージでない場合には常に0を返します。




Tags:

return:  含まれているパートの個数
access:  public


[ Top ]

method parts [line 219]

MailPart parts( int $index)

指定のインデックスのパートを取得します。

インデックスは0~partCount()-1の範囲で指定します。 範囲外のインデックスを指定した場合にはEIlligalParameterException例外が発生します。




Tags:

return:  パート
access:  public


Parameters:

int   $index  

[ Top ]

method setBody [line 112]

void setBody( string $body, [string $contentType = MIMEMAIL::CONTENT_TYPE_TEXT_PLAIN], [string $name = ""])

ボディを設定します。

ボディに設定するContent-Typeはマルチパートメッセージを表すmultipart/?以外である必要があります。 またtext/plain、text/html以外を指定した場合、全てバイナリであると認識されBASE64エンコードされて送信されます。

ボディの内容がバイナリである場合、ボディの名前を設定します。 これは添付ファイル名などに適用されます。

ボディの内容がテキストである場合、インターネットメールが7bitを前提としていること、ISO-2022-JPで送られることから半角カナは全角カナに変換されます。

なお、シングルパートメッセージとマルチパートメッセージは相容れません。 既に設定されているマルチパートの各パートは破棄されます。




Tags:

throws:  ESendmailException 不正なContent-Type
access:  public


Parameters:

string   $body   ボディ
string   $contentType   Content-Type
string   $name   ボディの名前

[ Top ]

method setName [line 150]

void setName( string $name)

ボディの名前を設定します。

ボディの名前は、マルチパートメッセージではなく且つボディがバイナリの場合に利用されます。 これは添付ファイル名などに適用されます。




Tags:

access:  public


Parameters:

string   $name   ボディの名前

[ Top ]

method toMailPart [line 232]

string toMailPart( )

パートのメールメッセージの整形して返します。



Tags:

return:  整形されたパート
access:  public


[ Top ]


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