当前位置:Linux教程 - Php - 用PHP发送MIME邮件(二)

用PHP发送MIME邮件(二)



        
    Kartic Krishnamurthy



    MIME 类
     在有了这些基础之后,让我们用PHP创建和实现一个MIME邮件类。在我们的PHP库函数中,已经有了编码所必须的工具。

      MIME类必须能够:

    增加附件
    对每一个独立的请求,对所附的数据进行编码 创建MIME段/头生成一个包含MIME段/头的完整的邮件将整个邮件作为字符串返回
    用本地的邮件处理程序进行发送(或选择调用一个SMTP邮件处理程序)
      这个类叫做MIME_mail。我们将讨论类的方法,在理论与实际的差距中建立起桥梁。(阅读建议:Luis Argerich的PHP的面向对象编程:开发大型PHP项目
    的方法)。为了便于阅读大部分的注释已经被去掉了。一些方法与类的成员变量只是用于内部处理,并且已经在下面的注释中被指出来了(同时在初始的类文件中也指出了)。

    <?php

    class MIME_mail {
    //公有:
    var $to;
    var $from;
    var $subject;
    var $body;
    var $headers = "";
    var $errstr="";

    var $base64_func= \; // 如果未指定使用PHP的base64函数
    var $qp_func = \; // 此时为空

    var $mailer = ""; // 将其设为有效的邮件对象的名字

    ?>

      这里有一些公共处理的变量(也就是,可以在脚本中直接操纵的变量)。这些变量中的大部分都是自说明的。$headers包含了可选的想要发送给邮件处理程序的头信息。$errstr 是一个包含可读错误字符串的变量,它可以用在调用脚本中。

      $base64_func和$qp_func是"函数处理器",用户可以进行定制。缺省地,它们被设为空串。对于$base64_func,一个空串意味着我们将使用PHP内置的base64_encode()函数...(是的!优美,不是吗!)。
    Quoted Printable可以通过$qp_func被处理。在PHP中没有内置的quoted-
    printable 编码函数(然而,安装了imap则可以使用imap_qprint())。在这篇文章中我们将不再讨论quoted_printable方法。

    <?php

    //私有:
    var $mimeparts = array();

    ?>

      $mimeparts是一个内部数组,包含了邮件信息中各自独立的符合MIME段。请
    不要在这个类(或派生类)之外操纵它和其它的私有方法/变量。

    <?php

    // 构造函数
    function MIME_mail($from="", $to="", $subject="", $body="", $headers = "") {
    $this->to = $to;
    $this->from = $from;
    $this->subject = $subject;
    $this->body = $body;
    if (is_array($headers)) {
    if (sizeof($headers)>1)
    $headers=join(CRLF, $headers);
    else
    $headers=$headers[0];
    }
    if ($from) {
    $headers = preg_replace("!(from: ?.+?[ ]?)!i", \, $headers);
    }
    $this->headers = chop($headers);
    $this->mimeparts[] = "" ; //增加位置0
    return;
    }

    ?>

      我们拥有对象的构造函数,它使用"from"和"to"邮件地址,主题和邮件体和头作为参数。对于邮件体部分,可以给出你将可能输入的正常邮件。最后一个参数是可选的(用户自定义)头。例如,X-Mailer: MyMailer_1.0。请注意$headers可以是一个数组,包含了将要发给邮件发送程序的不同的头,或者只是某个特别头的容器。你不能在$headers参数中发送From: 头,如果它被找到,这部分将自动被去掉。你可以象下面使用多个头:array("X-Mailer:
    MYMailer_1.0", "X-Organization: PHPBuilder.com")。

      $mimeparts用一个空项(索引0)创建,在后面我们将看到这样用的道理。

    核心:方法
      我们将MIME信息头的生成,MIME段头的生成和最终的邮件消息的生成分成几
    个模块。方法的实现是直接从我们前面遇到的MIME基础而来的。

    <?php

    function attach($data, $description = "", $contenttype = OCTET,
    $encoding = BASE64, $disp = \) {
    if (empty($data))
    return 0;
    if (trim($contenttype) == \)
    $contenttype = OCTET ;
    if (trim($encoding) == \)
    $encoding = BASE64;
    if ($encoding == BIT7)
    $emsg = $data;
    elseif ($encoding == QP)
    $emsg = $$this->qp_func($data);
    elseif ($encoding == BASE64) {
    if (!$this->base64_func) # 检查是否有用户自动定函数
    $emsg = base64_encode($data);
    else
    $emsg = $$this->base64_func($data);
    }
    $emsg = chunk_split($emsg);
    //检查是否content-type是text/plain并且如果没有指定charset,追加缺省的CHARSET
    if (preg_match("!^".TEXT."!i", $contenttype) && !preg_match("!;charset=!i", $contenttype))
    $contenttype .= "; charset=".CHARSET ;
    $msg = sprintf("Content-Type: %sContent-Transfer-Encoding: %s%s%s%s",
    $contenttype.CRLF,
    $encoding.CRLF,
    ((($description) && (BODY != $description))?"Content-Description: $description".CRLF:""),
    ($disp?"Content-Disposition: $disp".CRLF:""),
    CRLF.$emsg.CRLF);
    BODY==$description? $this->mimeparts[0] = $msg: $this->mimeparts[] = $msg ;
    return sizeof($this->mimeparts);
    }

    ?>

      让我们仔细地看一下这个方法(对于其它的大部分方法也将如此):

    这个方法使用的参数有:
    所附的实际数据($data)
    与Content-Description头相应的数据描述($description)
    将用在Content-Type头中的数据content-type值($contentype)
    用在Content-Transfer-Encoding中的编码值($encoding)
    用在Content-Disposition头$disp中的布局值,可以是INLINE或ATTACH,两个都
    是常量如BASE64,TEXT这样的值等等,作为常量被定义在附加的.def文件中。
    使用$encoding值来决定需要用哪种编码方式对数据进行编码。有效的值是BIT7
    (或7bit),QP或BASE64。 这个函数同时也检查了是否用户要使用他/她自已的
    BASE64或QP函数。在写这篇文章时,在我们的类中只有BIT7和BASE64被实现了,
    然而,你可以传递你自已的quoted-printable 函数来使用,通过在前面
    讨论的$qp_func类变量。
    在编码处理之后,你会注意到对编码的信息使用了chunk_split()。这个函数根
    据可选长度将字符串分割成小段。因为我们没有指出长度,缺省长度使用76。这
    个非常附合邮件处理的习惯。
    接着,如果$contenttype参数包含text/plain,则必须给出"charset=" 参数的
    值。它的缺省值被定义在常量CHARSET中,值为us-ascii。注意当头使用参数值
    传递时,在头与参数之间必须有一个分号(;)。
    例如,Content-Type: text/plain; charset=us-ascii
    如果其它MIME段头各自的值被传递给这个方法,这些段头被创建。毕竟我们不想
    拥有一个没有描述的Content-Description头。在创建这些头之后,我们追加上
    经过编码的数据部分信息。(检查一下方法中的sprintf()语句)。
    同样,注意我们使用了一个叫BODY(又是一个常量)的特别描述字段。这就是我
    们用在类实现中的东西。如果描述字段与BODY一样,我们将其赋给$mimeheaders
    数组中的第一个元素。对于这个请多读几遍。

    attach() 返回$mimeparts数组的当前大小,用在调用脚本的引用中。通过这种
    方法就可以知道一个附件"X"存在哪一个索引中(实际返回的值要比在数组中的
    索引小1)注意所有的头必须用一个CRLF()序列结束。
      接着,我们看一下fattach()方法,fattach()与attach()相似,但是它使用
    一个文件名作为它的第一个参数(作为attach()中$data的替换)。这个方法只
    是一个封装,以便调用者可以用一个文件来调用fattach。
    fattach()然后将文件读出,接着调用attach()来追加数据。这个方法在失败时
    返回0,可以在$errstr 变量中找到解释或者当成功时,返回文件附件在
    $mimeparts数组中的索引号。

      我们现在已经开发了附加数据的功能,对它们进行编码并且将单独的MIME段
    放在私有数组中。还需要完成的工作是:

    完成MIME的各个段
    创建包含MIME信息头的邮件信息头,邮件原始的信息头(如To:, From:等等)并
    且包括任何用户定义的头。 后面追加完整的MIME段,这样一个完整的邮件包就
    生成了。
    我们将考查的下一个方法是,build_message(),它占据了整个工作的大部分,
    但它是通过一个gen_email()的方法来调用的。请注意build_message()是一个私
    有方法。

    <?php

    function build_message() {

    $msg = "";
    $boundary = PM.chr(rand(65, 91)).------.md5(uniqid(rand())); # 边界标识
    $nparts = sizeof($this->mimeparts);

    //情况1:存在附件列表,所以MIME信息头必须是multipart/mixed
    if (is_array($this->mimeparts) && ($nparts > 1)) {
    $c_ver = "MIME-Version: 1.0".CRLF;
    $c_type = Content-Type: multipart/mixed;.CRLF." boundary="$boundary"".CRLF;
    $c_enc = "Content-Transfer-Encoding: ".BIT7.CRLF;
    $c_desc = $c_desc?"Content-Description: $c_desc".CRLF:"";
    $warning = CRLF.WARNING.CRLF.CRLF ;

    // 如果存在MIMIE段,则邮件体也要变成附件
    if (!empty($this->body)) {
    $this->attach($this->body, BODY, TEXT, BIT7);
    }

    // 现在创建邮件的各个MIME段
    for ($i=0 ; $i < $nparts; $i++) {
    if (!empty($this->mimeparts[$i]))
    $msg .= CRLF.--.$boundary.CRLF.$this->mimeparts[$i].CRLF;
    }
    $msg .= --.$boundary.--.CRLF;
    $msg = $c_ver.$c_type.$c_enc.$c_desc.$warning.$msg;
    } else {
    if (!empty($this->body)) $msg .= $this->body.CRLF.CRLF;
    }
    return $msg;
    }

    ?>

      这个方法有点自相予盾,简单而又复杂。要看你自已怎么看了。

    我们在前面读到(在MIME基础中),每一个MIME段都有一个边界标记,这个标记
    有一个唯一的id。边界标记被用在:
    MIME信息头中,用来指示附件必须从哪进行划分
    MIME段中;实际用在每一段的前面和后面来划分附件的边界。(回想一下
    Alexander的有着图片和图谱的邮件!)
    (记住:最后一个边界标记要以两个连接符(--)结束,用于指示范围结束)。
    $boundary包含了边界标记,并且它是通过一个随机数进行了唯一化再做MD5哈希
    生成的。另外,我们给$boundary冠以一个"PM?"的前缀,这里"?"是一个随机字
    母。举一个$boundary的例子就是
    "PMK------2345ee5de0052eba4daf47287953d37e"(PM表示PHP MIME,所以你可
    以将其改为你的可能的初始值!)

    在生成MIME头的处理中我们必须考虑两种情况。这些情况影响了邮件的原始邮件
    体($body在构造函数中)以哪种方式被看待和MIME信息头的特别表示。情况1就
    是写这篇文章的原因,并且你会看到:可以有许多的附件被包含!在这种情况
    下,请注意作为信息的部分被放上了警告字符串"This is a MIME encoding
    message"。因此,真正的消息体本身也必须以附件形式加到信息中!邮件的文本
    通常是附件列表中的第一个附件,在我们的例子中就是$mimeparts。这个正好就
    是为什么我们要占用一个$mimeparts索引的原因,以便让第一个索引(是0)可
    以用于邮件文本部分。邮件体必须以7bit编码进行附加。
    <?php

    if (!empty($this->body)) {
    $this->attach($this->body, BODY, TEXT, BIT7);
    }

    ?>

    上面的一小段代码完成附加邮件文本部分作为一个MIME附件的工作。注意,我们
    使用了BODY常量来指示attach()要将附件加到何处。

    第二种情况就是当不存在附件时,在这种情况下,如果提供了邮件文本,它将是
    包含在局部变量$msg中的唯一信息;在这种情况下不需要MIME头。(然而,在这
    种情况下我们还应该只把MIME-Version头

    指定出来----回过头到再看一下前面的演示的最简单的MIME信息。)

    MIME信息头(MIME-Version,Content-Type, 等等。)在有附件的时候被创建。
    为了用MIME消息头来创建消息体,首先MIME信息头要被创建。然后各个有效的
    MIME段通过$mimeheaders数组被反复处理。

    这就是边界标识被实际使用的地点。根据规则的一致性,对一个MIME段被前缀上
    两个连接符(-- .$BOUNDARY.crlf)并且在最后一个MIME段的后面,在边界标
    识后追加两个连接符表示邮件范围结束。
    在变量$msg中的完整的信息作为这个方法的值被返回。
      下一个方法,get_email()通过build_message()方法完成MIME消息的生成。
    因为build_message()是一个内部方法,get_email()在调用完build_message()
    之后,创建RFC 822的信息头并且追加上MIME信息。

    <?php

    function gen_email($force=false) {

    if (!empty($this->email) && !$force) return $this->email ; // saves processing
    $email = "";
    if (empty($this->subject)) $this->subject = NOSUBJECT;
    if (!empty($this->from)) $email .= From: .$this->from.CRLF;
    if (!empty($this->headers)) $email .= $this->headers.CRLF;
    $email .= $this->build_message();
    $this->email = $email;
    return $this->email;
    }

    ?>

      对于我们的类的一个实例来说,类的成员$email拥有生成的整个邮件信息。
    为了避免信息被无必要的重新生成,这个方法继续创建邮件头,并且只有当
    $mail为空时才调用build_message()。然而,你可以通过调用gen_email()来强
    制重新处理。(如果"To"信息被改变或加入了一个新的附件,调用者显示想这么
    做)。

      gen_email()创建了更熟悉的From头。另外,如果没有指定主题,它将主题
    设为缺省值(No Subject)。我们直到后面才将To和Subject 的内含保存起来。
    这个方法返回完整的邮件信息,这样就结束了创建MIME信息的任务。




    发布人:netbull 来自:LinuxAid