一组实现邮件发送功能的C++封装类 — SMailer

作者：

这个程序是笔者近日在实验邮件发送系统时写的，原本只想实现功能了事，可也许是程序员的惯常品性所至，几经完善的结果就成了如今这个样子了。网上也有不少有关于此的源码，但这些程序多半是不完整的，或者属于示例性程序，无法直接拿来使用。一些网络编程的书也有类似介绍，但又过于复杂了。笔者所写的这个程序以上述资源作为参考，并保有自身特点：功能齐全，小巧简洁，取名SMailer也正是出于此意（Simple Mail Sender）。大家可以根据需要加入到自己的系统中去。

程序包括如下功能：

- 支持验证功能，为可选项
- 支持包括html文本、普通文本在内的混排方式
- 支持按特定优先级发送邮件
- 支持一次发送多个附件，为可选项
- 支持多收件人发送，对于某封邮件，可以选择一次只向一个人发送，也可以选择发送给所有人

SMailer的另一个特点是，采用标准c++写就，并具有良好的程序结构，麻雀虽小五脏俱全，诸类各司其职，共同构成了一个完整的小系统。SMailer中多数类都被定义于SMailer名字空间下，以下是程序关键部分的简要讲解：

MimeContent及其子类

针对邮件的正文部分和附件部分，SMailer定义了一个抽象类MimeContent，并声明了几个必要的成员函数：

class MimeContent
{
public:

    MimeContent(const std::string content = "");

    virtual std::string  getType() const = 0;
    virtual std::string  getDisposition() const;
    virtual std::string  getTransEncoding() const = 0;
    virtual std::string& getContent() = 0;

protected:

    std::string _content;
};

随后，SMailer又从MimeContent派生了三个子类：PlainTextContent、TextHtmlContent、AppOctStrmContent，分别代表普通文本的正文、html格式的正文和文件形式的附件。值得注意的是，AppOctStrmContent中记录的是附件所在的路径，只有当调用了getContent函数时，才会根据路径读取文件内容，随后进行Base64编码，这里会用到FileHelper和Base64Helper两个辅助类，后面会讲到：

std::string& AppOctStrmContent::getContent()
{
    // you can add more codes here, such as wrapping lines 
    // or replacing ''\n'' with ''\r\n'', etc.
    MUtils::FileHelper::open(_file_name, _content);
    _content = MUtils::Base64Helper::encode(_content);
    return _content;
}

MailInfo

类MailInfo封装了一封邮件所包含的全部信息，包括：发件人姓名地址、收件人姓名地址、主题、正文、附件等等。

class MailInfo
{
public:

    MailInfo();

    void setSenderName(const std::string name);
    void setSenderAddress(const std::string address);
    std::string getSenderName() const;
    std::string getSenderAddress() const;

    void addReceiver(const std::string name, const std::string address);
    void setReceiver(const std::string name, const std::string address);
    const Receivers& getReceivers() const;

    void setPriority(std::string priority);
    std::string getPriority() const;

    void setSubject(const std::string subject);
    std::string getSubject() const;

    void addMimeContent(MimeContent* content);
    void clearMimeContents();
    const MimeContents& getMimeContents() const;

private:

    std::string  _sender_name;
    std::string  _sender_address;
    Receivers    _receivers;
    std::string  _priority;
    std::string  _subject;
    MimeContents _contents;
};

有两点说明：

- 由于收件人可能不止一个，所以在MailInfo中使用了一个std::multimap容器来记录收件人的姓名和地址，上面的Receivers就是std::multimap，其中以姓名为key，地址为value。因为是multimap，所以也就满足了同名同姓的情况了。
- 正如前面看到的，对于邮件的正文和附件，MailInfo采取了一视同仁的态度，能做到这一点应该要归功于MimeContent的抽象特性。MailInfo中使用了一个std::vector容器，用来保存MimeContent子类对象的指针，上面的MimeContents就是std::vector。另外，函数addMimeContent、clearMimeContents和getMimeContents为外界提供了添加、删除正文或附件的统一接口。

MailWrapper

MailWrapper对MailInfo做了进一步的包装，用于对MailInfo的信息进行加工再处理，以适应真正的邮件发送的需要。它内含了一个指向MailInfo类对象的指针。另外，对收件人和正文/附件信息的遍历，MailWrapper采用了类似Iterator Pattern的方法，但是考虑到仅限于此处用到了遍历机制并且不想使程序变得过于复杂，于是此处直接将遍历接口附着于MailWrapper之上了：

class MailWrapper
{
public:

    MailWrapper(MailInfo* mail_info);

    std::string getSenderAddress();
    std::string getHeader();
    std::string getEnd();

    void traverseReceiver();
    bool hasMoreReceiver();
    std::string nextReceiverAddress();

    void traverseContent();
    bool hasMoreContent();
    std::string& nextContent();

private:

    static const std::string _mailer_name;
    static const std::string _boundary;

    MailInfo* _mail_info;
    Receivers::const_iterator _rcv_itr;

    std::string _content;
    MimeContents::const_iterator _con_itr;

    std::string prepareFrom();
    std::string prepareTo();
    std::string prepareDate();
    std::string prepareName(const std::string raw_name);
};

MailSender

MailSender是真正的邮件发送类，实现了邮件发送的关键功能，其public接口甚是简单，你所要做的就是：
- 构造一个MailSender对象，并传入SMTP服务器地址以及用于认证的账号信息（如有必要）
- 构造一个MailInfo对象，设置好相应的邮件信息，将之传入一个MailWrapper对象
- 调用MailSender的setMail函数，将MailWrapper对象传入其中
- 调用MailSender的sendMail函数，发送邮件

class MailSender
{
public:

    MailSender(const std::string server_name, 
               const std::string user_name = "", 
               const std::string user_pwd = "");

    ~MailSender();

    void setMail(MailWrapper* mail);

    void sendMail();

private:

  //...
};

其他辅助类

SMailer中还有几个辅助类，分别位于SMailer名字空间和MUtils名字空间下，它们包括：

1、Priority：定义了三种级别的邮件优先级，包括：紧急、普通、缓慢。可以在设置MailInfo时使用它：

class Priority
{
public:

    static const std::string important;
    static const std::string normal;
    static const std::string trivial;
};

2、ErrorMessage：用于为操作失败提供统一的错误描述信息，采用了Singleton Pattern：

class ErrorMessage
{
public:

    static ErrorMessage& getInstance();

    std::string& request (MailSender::Operaion request_operation);
    std::string& response(const std::string expected_response);

private:

    std::map _request_errmsg_map;
    std::map _respons_errmsg_map;

    ErrorMessage();
};

3、MailException：一个异常类，派生自std::exception，程序出错时会统一抛出该异常，通过调用what函数可以得到说明信息：

class MailException : public std::exception
{
public:

    MailException(const std::string message = "")
     : _message(message)
    {
    }

    const char *what() const throw ()
    {
        return _message.c_str();
    }

private:

    std::string _message;
};

4、FileHelper：一个简单的提供文件I/O功能的辅助类，在读取附件内容时被用到。该类位于MUtils名字空间下。

5、WinSockHelper和WinSockException：提供针对WinSock编程所必要的支持功能。此二类位于MUtils名字空间下。

6、Base64Helper：提供Base64的编码/解码功能，在对附件和账号信息进行编码时需要用到。该类位于MUtils名字空间下。

另外，还有以下几点说明：

1、关于源文件的组织

实现邮件发送功能的源文件是SMailer.h和SMailer.cpp，位于SMailer目录下；相关的辅助源文件包括FileHelper.h、WinSockHelper.h、Base64Helper.h、Base64Helper.cpp，它们都位于MUtils目录下。另外TestSMailer.cpp演示了如何使用SMailer的功能，这是一个命令行形式的应用程序，位于和SMailer、MUtils同级的目录下。

2、关于GUI

时间的原因，我没有编写GUI，不过由于所有功能均已封装，要将SMailer加入GUI系统中应该是易如反掌的。

3、关于移植性

程序在MSVC6编译器下运行通过，并在Cygwin-b20下编译通过（头文件要做一点小小的改动），由于代码中采用了S(T)L及BSD风格的socket，所以在其余平台上的移植应该也不会很麻烦。