文本变量 @var(key_name)
概览
文本变量可以动态的控制邮件或邮件模板中的文本内容,文本变量同样可以动态的控制短信中的内容。(邮件模板是指你在 SUBMAIL 的 MAIL 应用中,使用 SUBMAIL EDITOR 创建的触发邮件模板)
适用 API
接口 | 描述 |
---|---|
mail/send | 邮件 API |
mail/xsend | 邮件 API |
SMTP API | 邮件 API |
sms/xsend | 短信 API |
格式
@var(自定义的变量名)
创建变量
在 SUBMAIL EDITOR 中创建邮件,在需要动态控制的文本位置键入 @var(key_name),
你可以使用文本编辑器的样式来编辑此变量的显示位置、样式、颜色、字体或字体大小等。SUBMAIL API 在输出此变量时,将完整的继承这些显示属性。
使用变量
在你使用 API 发送时,请以 json 字符串(key:value)
方式连接你的变量 e.g. {”key”:”value”,”key”:”value”}
,并将此字符串放在 vars
参数中提交。
注:例中的 key 表示你设定的变量名,value 表示你想替换此变量的文本
例:如果你在邮件中创建了 3 个变量,分别为 @var(title)
, @var(username)
, @var(number)
,如下:
在 vars
参数中将 vars={"username":"Leo","title":"6月份邮件订阅报告","number":"300"}
提交至 SUBMAIL,用户收到的邮件如下:
请注意:vars 参数要求严格的 JSON 格式,以下是将参数转换为 JSON 格式的注意事项
- json 字符串必须以双引号包含
- json 字符串必须是 utf8 编码
- 不能有多余的逗号 如:[1,2,]
- json 字符串首尾必须被大括号{}包含
PS:大多数的语言都有专属的JSON解析器( ENCODING 和 DECODEING 方法)。如 PHP,首先将需要的变量以数组形式(如 $var\[‘key’\]=value)创建后,使用 json_encode($var)方法创建 JSON 字符串;