magic-core

# Class: SmtpMailer Source Location: /core/tool/mail/impl/SmtpMailer.php
### Class Overview
SMTPを利用したメール送信クラスです. #### Author(s): T.Okumura #### Version: 1.0.0 Implements interfaces: Mailer | ### Constants CRAM_MD5 DIGEST_MD5 LOGIN PLAIN | ### Methods getError __construct __destruct send setFrom setHeloHost setPersist setPopParameters setSmtpParameters setTo
### Class Details [line 25] SMTPを利用したメール送信クラスです. 外部のSMTPサーバーを指定して、メールを送信する機能を提供します。 単体で使用することもできますが、日本語のメールは処理が複雑です。 通常はEncoderのコンストラクタに渡してそちらから送信します。 #### Tags:
author: | T.Okumura
version: | 1.0.0
see: | Encoder
final: |
[ Top ] ### Class Methods ### method getError [line 171]
`void getError( )`
直近のエラーを取得します #### Tags:
see: | Mailer::getError()
access: | public
Implementation of: Mailer::getError() 直近のエラーを取得します. [ Top ] ### constructor __construct [line 165]
`SmtpMailer __construct( )`
コンストラクタ. #### Tags:
access: | public
[ Top ] ### destructor __destruct [line 246]
`void __destruct( )`
デストラクタ. #### Tags:
access: | public
[ Top ] ### method send [line 253]
`void send( $header, $body)`
送信処理. #### Tags:
see: | Mailer::send()
access: | public
Implementation of: Mailer::send() 送信処理. #### Parameters:
| $header |
| $body |
[ Top ] ### method setFrom [line 233]
`void setFrom( $from)`
FROMを設定します. #### Tags:
see: | Mailer::setFrom()
access: | public
Implementation of: Mailer::setFrom() FROMを設定します. #### Parameters:
| $from |
[ Top ] ### method setHeloHost [line 178]
`void setHeloHost( string $heloHost)`
EHLOに使用するホスト名を設定します. #### Tags:
access: | public
#### Parameters:
string | $heloHost | EHLOに使用するホスト名
[ Top ] ### method setPersist [line 188]
`void setPersist( bool $isPersist)`
永続的な接続を保持するかどうかを設定します. 複数のメールを送信する場合は、TRUEを推奨します。 #### Tags:
access: | public
#### Parameters:
bool | $isPersist | TRUEの場合は永続接続
[ Top ] ### method setPopParameters [line 221]
`void setPopParameters( string $popHost, int $popPort, string $popUser, string $popPass, [int $popTimeout = 1800])`
POP接続に必要な情報を設定します. #### Tags:
access: | public
#### Parameters:
string | $popHost | POPのホスト名
int | $popPort | POPのポート番号
string | $popUser | 接続ユーザー名
string | $popPass | 接続パスワード
int | $popTimeout | [optional] POPのタイムアウト値を秒で指定(オプション)
[ Top ] ### method setSmtpParameters [line 204]
`void setSmtpParameters( string $smtpHost, int $smtpPort, string $smtpUser, string $smtpPass, [string $smtpAuth = NULL], [bool $useStartTls = FALSE])`
SMTP接続に必要な情報を設定します. $smtpAuthが省略された場合は、暗号化しません。 $useStartTlsが省略された場合は、使用しないになります。 #### Tags:
access: | public
#### Parameters:
string | $smtpHost | SMTPのホスト名
int | $smtpPort | SMTPのポート番号
string | $smtpUser | 接続ユーザー名
string | $smtpPass | 接続パスワード
string | $smtpAuth | [optional] SMTP認証方式(オプション)
bool | $useStartTls | [optional] STARTTLSを使用するかどうかのフラグ(オプション)
[ Top ] ### method setTo [line 240]
`void setTo( $to)`
TOを設定します. #### Tags:
see: | Mailer::setTo()
access: | public
Implementation of: Mailer::setTo() TOを設定します. #### Parameters:
| $to |
[ Top ] ### Class Constants #### CRAM_MD5 = 'CRAM_MD5' [line 35] 認証モード(CRAM_MD5). #### Tags:
staticvar: | string 0:
[ Top ] #### DIGEST_MD5 = 'DIGEST_MD5' [line 30] 認証モード(DIGEST_MD5). #### Tags:
staticvar: | string 0:
[ Top ] #### LOGIN = 'LOGIN' [line 40] 認証モード(LOGIN). #### Tags:
staticvar: | string 0:
[ Top ] #### PLAIN = 'PLAIN' [line 45] 認証モード(PLAIN). #### Tags:
staticvar: | string 0:
[ Top ] Documentation generated on Fri, 16 Dec 2011 11:13:58 +0100 by phpDocumentor 1.4.3