超链接变量 @link(key_name)


概览


超链接变量可以动态地控制邮件模板中的超链接。(邮件模板是指你在 SUBMAIL 的 MAIL 应用中,使用 SUBMAIL EDITOR 创建的触发邮件模板,@link(key_name) 允许你通过 mail/sendmail/xsend API 发送邮件时,动态地控制邮件中的超链接。)



适用 API


接口描述
mail/send邮件API
SMTP API邮件 API
mail/xsend邮件 API


格式


@link(自定义的变量名)



创建变量


在 SUBMAIL EDITOR 中创建邮件,在需要动态控制的超链接的位置点击弹出超链接对话框后,将此超链接的协议设为“变量”类型,在右侧 URL 输入框中,输入 @link(key name),点击确定,此超链接变量将被创建。


在文本上添加超链接变量:


在 SUBMAIL EDITOR 中单击要创建此变量的文本框,使其进入文本编辑模式;

选中要创建链接的文本后,点击按钮;

在弹出的超链接对话框中,将协议改为变量;

在 URL 输入框中键入变量 (例 @link(key_name);

此方法同样适用于在文本变量中创建超链接变量。


在图片上添加超链接变量:


在 SUBMAIL EDITOR 中选中要创建超链接变量的栏,此时,此栏中的图片左侧底部将显示超链接按钮;

点击按钮,进入超链接对话框;

在弹出的超链接对话框中,将协议改为变量;

在 URL 输入框中键入变量 (例 @link(key_name);

请注意:

如果你使用 HTML CODE 模式在 SUBMAIL EDITOR 中创建的邮件模板,你需要在使用这些超链接变量的位置之前加上 var:// 来标示此链接的协议。

例:文本

此变量不支持纯文本邮件。



使用变量


在你使用 mail/xsend API 发送时,请以json字符串(key:value)方式连接你的变量 e.g. {"key":"value","key":"value"},并将此字符串放在 links 参数中提交。

注:例中的 key 表示你设定的变量名,value 表示你想替换此变量的超链接(超链接必须包含完整的 http 协议,http:// , https:// 或 ftp://)


使用示例


例:如果你在邮件中创建了超链接变量,变量为 @link(verification)

如下:




在 links 参数中将 links={”verification”:”http://submail.cn/chs/account/verification?code=nX6U81”} 提交至 SUBMAIL,用户收到的邮件如下:




当用户点击立即验证按钮后,将进行验证。

请注意:links 参数要求严格的 JSON 格式,以下是将参数转换为 JSON 格式的注意事项

  1. json 字符串必须以双引号包含
  2. json 字符串必须是 utf8 编码
  3. 不能有多余的逗号 如:[1,2,]
  4. json 字符串首尾必须被大括号{}包含

PS:大多数的语言都有专属的JSON解析器( ENCODING 和 DECODEING 方法)。如 PHP,首先将需要的变量以数组形式(如 $var[‘key’]=value) 创建后,使用 json_encode($var)方法创建 JSON 字符串;