邮件合并允许你从单一模板和结构化数据源生成文档(可能会是大量文档),这可以用于生成业务报表、采购订单、收据、目录、存货清单和发票等。
Aspose.Words for Cloud Mail Merge 让你能够从模板和任何语言(包括.NET、Java、PHP、Ruby、Rails、Python、jQuery等等)的XML中生成文档。你可以通过支持REST的任意语言或平台来使用它(几乎所有平台和语言都支持REST并提供原生REST客户端来处理REST APIs)。
本文主要讲述PHP中的邮件合并。要想执行邮件合并,你需要上传一个模板到Aspose for Cloud或任意第三方存储,然后发送一封邮件申请(在主体上传送XML数据)以生产基于模板和数据的文档。如下步骤描述了具体过程。
决定执行什么类型的邮件合并
Aspose.Words for Cloud 支持简单邮件合并和带区域的邮件合并。如果你想要插入简单或无重复数据,比如名称、地址和代码字段在信封上,或到信中的字段,则可以使用简单邮件合并(也叫做不带区域的邮件合并)。
准备一个模板
为了准备模板来执行简单邮件合并(不带区域,类似于MS Word上可用的经典邮件合并),插入一个或更多合并字段到你想要填充来自数据源的数据的地方。
对于动态增长部分的文档,使用带区域合并。指定一个文档中的邮件合并区域,插入两个邮件合并字段来标记邮件合并区域的开始和结束)。邮件合并区域中的所有文档内容都自动重复(为数据源中的每个记录)。
格式XML
如果你想要执行简单邮件合并,而且在Word文档中没有?TableStart:TableName??TableEnd:TableName?类合并字段,就在请求主体中用如下XML结构来发送:
<?xml version="1.0" encoding="utf-8" ?> <CollectionName> <field1>Value1</field1> <field2>Value2</field2> </CollectionName>
注意:你可以在XML中为CollectionName选择任意文本,但字段名称必须匹配Word文档中合并字段的名称。
当合并邮件是在?TableStart:TableName??TableEnd:TableName? 区域内时执行带区域的邮件合并,就在请求主体中用如下XML结构来发送:
<?xml version="1.0" encoding="utf-8"?> <CollectionName xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ItemName> <field1>Value1</field1> <field2>Value2</field2> </ItemName> <ItemName> <field1>Value1</field1> <field2>Value2</field2> </ItemName> </CollectionName>
注意:你可以在XML中为CollectionName选择任意文本,但ItemName 必须匹配TableStart 和TableEnd区域名称。比如本例中的,?TableStart:ItemName??TableEnd:ItemName?)并且字段名称必须匹配Word文档中的合并字段名称。
使用PHP REST邮件合并
在你执行邮件合并之前,你需要上传你的模板Word文件和XML数据到Aspose for Cloud或任意第三方存储。
一旦你上传模板和XML,你就可以用如下URI来执行邮件合并:
http://api.aspose.com/v1.1/words/Sample.docx/executeMailMerge
在上述URI中有几个可选参数供你使用。依据你的需求,可以用到所有的或特定的参数。以下是这些可选参数的细节:
- withRegions:如果你想要执行带区域邮件合并,这个参数可以被设置为ture。请看Section 1的完整代码。
- mailMergeDataFile:这个参数可以设置来指定XML数据文件。请看Section 1的完整代码。
- cleanup:这个参数可以设置来指定不同的cleanp选项,比如,移除空的段落、未使用的字段和控的表格等等。请看Section 1的完整代码。
- filename:这个参数可以用来指定作为邮件合并最终结果而生成的文件名称。
- storage:这个参数可以用来设置存储名称,如果你用的是第三方存储的话。
- folder:这个参数用来设置模板文件上传的名称/路径。
在构建URI之后,完成如下步骤:
- 设置App SID 和App Key并签署URI。请看Section 2的完整代码。
- 发送一封邮件到Aspose for Cloud Service。请看Section 3的完整代码。
- 从响应流中获得输出文件名称。请看Section 4的完整代码。
完整代码如下:
/**** Section 1 ****/ // Build URI to execute mail merge $strURI = 'http://api.aspose.com/v1.1/words/Sample.docx/executeMailMerge?withRegions=true&mailMergeDataFile=Data.xml'; // Use the following URI if you want to remove EmptyParagraphs,UnusedRegions,UnusedFields and ContainingFields during mail merge // $strURI = 'http://api.aspose.com/v1.1/words/Sample.docx/executeMailMerge?mailMergeDataFile=Data.xml&cleanup=EmptyParagraphs,UnusedRegions,UnusedFields,ContainingFields'; /**** End Section 1 ****/ /**** Section 2 ****/ $appSID = "77****-****-****-****-80*********"; $appKey = "****************"; // Sign URI $signedURI = Sign($strURI, $appSID, $appKey); /**** End Section 2 ****/ /**** Section 3 ****/ $responseStream = ProcessCommand($signedURI, "POST", "", ""); /**** End Section 3 ****/ /**** Section 4 ****/ $json = json_decode($responseStream); //build URI to download output DOC $outputFileName = $json->Document->FileName; /**** End Section 4 ****/
在执行邮件合并之后,你可以通过跟随如下下载文件实例下载输出文件。
用PHP SDK进行邮件合并
如果你想要使用PHP SDK来执行邮件合并,你可以下载Aspose for Cloud SDK for PHP。
为了使用PHP SDK,你需要执行如下步骤:
- 设置基本产品URI、App SID和App Key。请看Section 1的完整代码。
- 设置输出地点、输出文件名称和输出XML。请看Section 2的完整代码。
- 上传输入文件。请看Section 3的完整代码。
- 创建MailMessage类的对象并为简单邮件合并和executeMailMergeWithRegions方式调用executeMailMessage方式。请看Section 4的完整代码。
完整代码如下:
/**** Section 1 ****/ // Specify product URI Product::$baseProductUri = "http://api.aspose.com/v1.1"; //sepcify App SID AsposeApp::$appSID = "xxxxxxxxxxxxxxxxxxxxxxxx"; //sepcify App Key AsposeApp::$appKey = "xxxxxxxxxxxxxxxxxxxxxxxx"; /**** End Section 1 ****/ try{ /**** Section 2 ****/ AsposeApp::$outPutLocation = getcwd() . "/Output/"; $mainDocumentFile = getcwd() . "/Input/SimpleMerge.doc"; $mainDocument = basename($mainDocumentFile); $xml = simplexml_load_file(getcwd() . "/Input/SimpleMerge.xml"); /**** End Section 2 ****/ /**** Section 3 ****/ //upload main document echo "Uploading main document...
"; $folder = new Folder(); $folder->uploadFile($mainDocumentFile, ""); echo "Main document uploaded
"; /**** End Section 3 ****/ /**** Section 4 ****/ echo "Executing mail merge...
"; //create MailMerge object $doc = new MailMerge(); $result = $doc->executeMailMerge($mainDocument, $xml->asXML()); /**** End Section 4 ****/ } catch (Exception $e) { throw new Exception($e->getMessage()); }