ginkgo\Smtp

SMTP 邮件发送类

类摘要

namespace ginkgo;

class Smtp {
  // 属性
  public $config = array();
  public $error;
  public $rcpt;
  public $reply;
  public $subject;
  public $content;
  public $contentAlt;

  protected static $instance;

  private $configThis = array(
    'method'        => 'smtp',
    'host'          => '',
    'secure'        => 'off',
    'port'          => 25,
    'auth'          => 'true',
    'user'          => '',
    'pass'          => '',
    'from_addr'     => 'root@localhost',
    'from_name'     => 'root',
    'reply_addr'    => 'root@localhost',
    'reply_name'    => 'root',
  );

  private $serverCaps = array();
  private $crlf = "\r\n";
  private $le = "\n";
  private $res_conn;
  private $init;

  // 方法
  public static instance( [ array $config ] ) : object
  public config( array $config )
  public connect() : bool
  public addRcpt( string $addr [, string $name ] )
  public addReply( string $addr [, string $name ] )
  public setSubject( string $subject )
  public setFrom( string $addr [, string $name ] )
  public setContent( string $content )
  public setContentAlt( string $content )
  public getError( [ string $name ] ) : mixed
  public send() : bool

  protected __construct( [ array $config ] ) : object
  protected __clone()

  private createHello( string $host ) : bool
  private createBody( string $boundary, string $message_id ) : bool
  private sendCmd( string $cmd, string $cmd_str, $expect = 250 ) : bool
  private sendHello( string $hello, string $host ) : bool
  private sendDo( string $data ) : mixed
  private headerProcess( string $boundary, string $message_id ) : string
  private bodyProcess( string $boundary ) : string
  private addrProcess( string $type, array $addr ) : string
  private serverCapsProcess( string $type )
  private contentProcess( string $boundary, string $content [, string $type = 'text/plain' ] ) : string
  private getAuthtype() : string
  private headerLine( string $name, string $value ) : string
  private contentLine( string $value ) : string
  private contentEncode( string $string ) : string
  private getResult() : string
  private errRecord( string $msg ) // since 0.2.4
}

成员目录

$config 配置，$configThis 默认配置

public $config;
private $configThis;

结构

$rcpt 收件人，$reply 回复地址

public $rcpt = array(
  array(
    'addr' => 'root@localhost',
    'name' => 'root', // 可选
  ),
  array(
    'addr' => 'test@localhost',
    'name' => 'test', // 可选
  ),
);

public $reply  = array(
  array(
    'addr' => 'root@localhost',
    'name' => 'root', // 可选
  ),
  array(
    'addr' => 'test@localhost',
    'name' => 'test', // 可选
  ),
);

config() 配置

public function config( array $config )

参数

• config 配置参数

返回

• 无

connect() 连接服务器

public function connect() : bool

参数

• 无

返回

• 连接是否成功

addRcpt() 添加收件人

public function addRcpt( string $addr [, string $name ] )

参数

• addr 邮箱地址
• name 名字

返回

• 无

addReply() 添加回复地址

public function addReply( string $addr [, string $name ] )

参数

• addr 邮箱地址
• name 名字

返回

• 无

setSubject() 设置主题

public function setSubject( string $subject )

参数

• subject 主题

返回

• 无

setFrom() 设置来源地址

public function setFrom( string $addr [, string $name ] )

参数

• addr 邮箱地址
• name 名字

返回

• 无

setContent() 设置内容

public function setContent( string $content )

参数

• content 内容

返回

• 无

setContentAlt() 设置纯文本内容

本方法会自动过滤 html 标签

public function setContentAlt( string $content )

参数

• content 内容

返回

• 无

getError() 获取错误

public function getError( [ string $name ] ) : mixed

参数

• name 错误名称，本参数为空时返回所有错误

返回

• 错误

send() 发送邮件

public function send() : bool

参数

• 无

返回

• 发送是否成功

createHello() 创建 HELLO 命令

private function createHello( string $host ) : bool

参数

• host 主机

返回

• 发送是否成功

createBody() 创建邮件主体

private function createBody( string $boundary, string $message_id ) : bool

参数

• boundary 边界
• message_id 消息 ID

返回

• 发送是否成功

sendCmd() 发送命令

private function sendCmd( string $cmd, string $cmd_str, $expect = 250 ) : bool

参数

• cmd 命令标记
• cmd_str 命令内容
• expect 期待服务器返回值

返回

• 发送是否成功

sendHello() 发送 HELLO

private function sendHello( string $hello, string $host ) : bool

参数

• hello hello 消息
• host 主机

返回

• 发送是否成功

sendDo() 真实发送命令

private function sendDo( string $data ) : mixed

参数

• data 命令数据

返回

• 发送是否成功

headerProcess() 头处理

private function headerProcess( string $boundary, string $message_id ) : string

参数

• boundary 边界
• message_id 消息 ID

返回

• 头

bodyProcess() 主体处理

private function bodyProcess( string $boundary ) : string

参数

• boundary 边界

返回

• 主体

addrProcess() 地址处理

private function addrProcess( string $type, array $addr ) : string

参数

• type 类型
• addr 地址内容

返回

• 地址

serverCapsProcess() 服务器说明处理

private function serverCapsProcess( string $type )

参数

• type 类型

返回

• 无

contentProcess() 内容处理

private function contentProcess( string $boundary, string $content [, string $type = 'text/plain' ] ) : string

参数

• boundary 边界
• content 内容
• type 类型

返回

• 内容

getAuthtype() 获取认证类型

private function getAuthtype() : string

参数

• 无

返回

• 认证类型

headerLine() 处理一行头

private function headerLine( string $name, string $value ) : string

参数

• name 名称
• value 值

返回

• 头

contentLine() 处理一行内容

private function contentLine( string $value ) : string

参数

• value 值

返回

• 内容

contentEncode() 内容编码

private function contentEncode( string $string ) : string

参数

• string 内容

返回

• 编码后的内容

getResult() 获取服务器反馈

private function getResult() : string

参数

• 无

返回

• 服务器反馈

errRecord() 记录错误

0.2.4 新增

private function errRecord( string $msg )

参数

• #msg 错误信息