magic-core

# Class: Encoder Source Location: /core/tool/mail/Encoder.php
### Class Overview
日本語メールのエンコードを提供します. #### Author(s): T.Okumura #### Version: 1.0.0 | ### Methods __construct addAttachment addInlineImage getError send setAltBody setBodyEncoding setCharset setFrom setHeaderEncoding setHtmlBody setInternalEncoding setSubject setTextBody setTo _createBody
### Class Details [line 20] 日本語メールのエンコードを提供します. 通常、日本語メールを送信する場合は、このクラスのコンストラクタに、 Mailerを実装したクラスを渡して、このクラスから送信します。 #### Tags:
author: | T.Okumura
version: | 1.0.0
see: | Mailer
final: |
[ Top ] ### Class Methods ### constructor __construct [line 110]
`Encoder __construct( Mailer $mailer)`
コンストラクタ. #### Tags:
access: | public
#### Parameters:
Mailer | $mailer | Mailerの実装クラス
[ Top ] ### method addAttachment [line 236]
`void addAttachment( string $path, string $name, [string $nameEncoding = NULL], [string $fileEncoding = NULL], [string $type = NULL])`
添付ファイルを設定します. #### Tags:
access: | public
#### Parameters:
string | $path | 添付ファイルのパス
string | $name | 添付する際に使用するファイル名
string | $nameEncoding | [optional] ファイル名の文字コード(オプション)
string | $fileEncoding | [optional] ファイルのエンコード(オプション)
string | $type | [optional] ファイルタイプ(オプション)
[ Top ] ### method addInlineImage [line 258]
`void addInlineImage( string $path, string $cid, string $name, [string $nameEncoding = NULL], [string $fileEncoding = NULL], [string $type = NULL])`
HTMLファイルのインラインイメージを設定します. #### Tags:
access: | public
#### Parameters:
string | $path | ファイルのパス
string | $cid | HTMLのimgタグに指定したcid
string | $name | インラインイメージの名前
string | $nameEncoding | [optional] インラインイメージ名の文字コード(オプション)
string | $fileEncoding | [optional] イメージのエンコード(オプション)
string | $type | [optional] イメージのファイルタイプ(オプション)
[ Top ] ### method getError [line 117]
`string getError( )`
直近のエラーを取得します. #### Tags:
return: | 直近のエラー
access: | public
[ Top ] ### method send [line 281]
`bool send( )`
送信処理. Mailerの実装クラスで送信します。 このファンクションが返す結果は、送信までの結果です。 これは先方に届いたかどうかではない事に注意してください。 #### Tags:
return: | 送信できた場合はTRUE
access: | public
[ Top ] ### method setAltBody [line 223]
`void setAltBody( string $body, [string $bodyEncoding = NULL])`
HTMLメールの場合に併せて送るテキストメール本文を設定します. このファンクションで設定した後に、Encoder::setHtmlBody()の $autoSetをTRUEにしてコールした場合、上書きされてしまいます。 (FALSEでコールした場合は、メールのコンテントタイプが間違えて指定されてしまいます) 必ずこのファンクションを後からコールするようにしてください。 #### Tags:
access: | public
#### Parameters:
string | $body | 本文
string | $bodyEncoding | [optional] 本文の文字コード(オプション)
[ Top ] ### method setBodyEncoding [line 145]
`void setBodyEncoding( string $bodyEncoding)`
ボディのエンコードを設定します. #### Tags:
access: | public
#### Parameters:
string | $bodyEncoding | ボディのエンコード
[ Top ] ### method setCharset [line 124]
`void setCharset( string $charset)`
文字コードを設定します. #### Tags:
access: | public
#### Parameters:
string | $charset | 文字コード
[ Top ] ### method setFrom [line 154]
`void setFrom( string $address, [string $name = NULL], [string $nameEncoding = NULL])`
FROMアドレスを設定します. #### Tags:
access: | public
#### Parameters:
string | $address | メールアドレス
string | $name | [optional] 氏名(オプション)
string | $nameEncoding | [optional] 氏名の文字コード(オプション)
[ Top ] ### method setHeaderEncoding [line 138]
`void setHeaderEncoding( string $headerEncoding)`
ヘッダのエンコードを設定します. #### Tags:
access: | public
#### Parameters:
string | $headerEncoding | ヘッダのエンコード
[ Top ] ### method setHtmlBody [line 201]
`void setHtmlBody( string $body, [bool $autoSet = TRUE], [string $bodyEncoding = NULL])`
HTMLメールの本文を設定します. HTMLメールを送信する際、相手がHTMLメールを受け取れない場合もあるので、 通常はテキストメールも併せて送信します。 ここで$autoSetをTRUEにした場合は、Encoder::setAltBody()で 設定する必要はありませんが、単純にHTMLからタグを除去した程度の精度です。 もう少しマシなメールを送りたい場合は、Encoder::setAltBody()を使用してください。 #### Tags:
access: | public
#### Parameters:
string | $body | 本文
bool | $autoSet | [optional] テキストメールも自動で設定するかどうかのフラグ
string | $bodyEncoding | [optional] 本文の文字コード(オプション)
[ Top ] ### method setInternalEncoding [line 131]
`void setInternalEncoding( string $internalEncoding)`
このクラスに渡される文字列の内部エンコードを設定します. #### Tags:
access: | public
#### Parameters:
string | $internalEncoding | 内部エンコード
[ Top ] ### method setSubject [line 171]
`void setSubject( string $subject, [string $subjectEncoding = NULL])`
メールのSubjectを設定します. #### Tags:
access: | public
#### Parameters:
string | $subject | メールのSubject
string | $subjectEncoding | [optional] Subjectの文字コード(オプション)
[ Top ] ### method setTextBody [line 183]
`void setTextBody( string $body, [string $bodyEncoding = NULL])`
テキストメールの本文を設定します. #### Tags:
access: | public
#### Parameters:
string | $body | 本文
string | $bodyEncoding | [optional] 本文の文字コード(オプション)
[ Top ] ### method setTo [line 163]
`void setTo( string $address, [string $name = NULL], [string $nameEncoding = NULL])`
TOアドレスを設定します. #### Tags:
access: | public
#### Parameters:
string | $address | メールアドレス
string | $name | [optional] 氏名(オプション)
string | $nameEncoding | [optional] 氏名の文字コード(オプション)
[ Top ] ### method _createBody [line 369]
`string _createBody( )`
ボディを作成します. #### Tags:
return: | ボディ
access: | public
[ Top ] Documentation generated on Fri, 16 Dec 2011 11:13:47 +0100 by phpDocumentor 1.4.3