acl::mail_attach类 参考

#include <mail_attach.hpp>

acl::mail_attach 的协作图:

Public 成员函数
	mail_attach (const char *filepath, const char *content_type, const char *charset)
	~mail_attach ()
mail_attach &	set_filename (const char *name, const char *charset=NULL)
mail_attach &	set_content_id (const char *id)
const char *	get_filepath () const
const char *	get_filename () const
const char *	get_content_type () const
const char *	get_content_id () const
bool	save_to (mime_code *coder, string &out)
bool	save_to (mime_code *coder, ostream &out)
void	build_header (const char *transfer_encoding, string &out)

详细描述

撰写邮件时，此类用于创建与邮件附件相关的功能

在文件 mail_attach.hpp 第 15 行定义.

构造及析构函数说明

mail_attach()

acl::mail_attach::mail_attach	(	const char *	filepath,
		const char *	content_type,
		const char *	charset
	)

将一个普通文件打包进邮件时的构造函数

参数

filepath	{const char*} 附件文件存储路径（含文件名）
content_type	{const char*} 附件文件类型
charset	{const char*} 若为纯文件，此参数表明纯文本的字符集

~mail_attach()

acl::mail_attach::~mail_attach

(

)

成员函数说明

build_header()

void acl::mail_attach::build_header	(	const char *	transfer_encoding,
		string &	out
	)

创建该附件在 MIME 邮件中的文件头信息

参数

transfer_encoding	{const char*} 编码方式
out	{string&} 存储结果，采用 append 方式

get_content_id()

const char* acl::mail_attach::get_content_id ( ) const

inline

获得由 set_content_id 设置的该附件的 cid 标识符

返回

{const char*}

在文件 mail_attach.hpp 第 76 行定义.

        {
                return cid_.c_str();
        }

get_content_type()

const char* acl::mail_attach::get_content_type ( ) const

inline

获得构造函数传入的文件类型

返回

{const char*}

在文件 mail_attach.hpp 第 67 行定义.

        {
                return ctype_.c_str();
        }

get_filename()

const char* acl::mail_attach::get_filename ( ) const

inline

获得附件的文件名部分经 rfc2047 编码后名称

返回

{const char*}

在文件 mail_attach.hpp 第 58 行定义.

        {
                return filename_.c_str();
        }

get_filepath()

const char* acl::mail_attach::get_filepath ( ) const

inline

获得构造函数传入的附件文件路径

返回

{const char*}

在文件 mail_attach.hpp 第 49 行定义.

        {
                return filepath_.c_str();
        }

save_to() [1/2]

bool acl::mail_attach::save_to	(	mime_code *	coder,
		string &	out
	)

将附件内容采用传入的编码器进行编码后存入内存缓冲区

参数

coder	{mime_code*} 编码器（base64/qp等）
out	{string&} 存储结果，采用 append 方式

返回

{bool} 编码过程是否成功

save_to() [2/2]

bool acl::mail_attach::save_to	(	mime_code *	coder,
		ostream &	out
	)

将附件内容采用传入的编码器进行编码后存入输出流中

参数

coder	{mime_code*} 编码器（base64/qp等）
out	{out&} 存储结果

返回

{bool} 编码过程是否成功

set_content_id()

mail_attach& acl::mail_attach::set_content_id

(

const char *

id

)

当邮件中的数据体为 multipart/relative 类型时，调用此函数设置其中的 html 正文中 cid 标识符

参数

id	{const char*} cid 标识符

返回

{mail_attach&}

set_filename()

mail_attach& acl::mail_attach::set_filename	(	const char *	name,
		const char *	charset = NULL
	)

设置附件的文件名，内部会自动对文件名用 rfc2047 格式进行编码

参数

name	{const char*} 非空字符串
charset	{const char*} 该参数指定字符集，当非 NULL 时，则内 部自动使用 rfc2047 格式对文件名进行编码，否则内部直接存储输入名称

返回

{mail_attach&}

---

该类的文档由以下文件生成:

• include/acl_cpp/smtp/mail_attach.hpp