SMTP通過配置項郵件標頭控制指定功能 - Direct Mail

警告

如果配置項的值設定不正確，發信會報錯，請務必經過測試後再發布到生產環境。

Direct Mail目前允許使用者通過郵件標頭X-AliDM-Settings來控制特定功能。

重要

X-AliDM-Settings 大小寫敏感，建議複製使用。

樣本：本次發信採用預設策略（對批量類型的發信地址發給特定網域名稱時）會產生退訂連結，退訂過濾層級是發信網域名稱層級。

先按照如下格式組一個json字串

{"Version": "1.0", "Unsubscribe": {"LinkType": "default", "FilterLevel": "mailfrom_domain"}}

對json字串做base64編碼

eyJWZXJzaW9uIjogIjEuMCIsICJVbnN1YnNjcmliZSI6IHsiTGlua1R5cGUiOiAiZGVmYXVsdCIsICJGaWx0ZXJMZXZlbCI6ICJtYWlsZnJvbV9kb21haW4ifX0=

編碼值寫入為郵件標頭X-AliDM-Settings的值。發送出郵件後，可以查看郵件標頭X-AliDM-Settings是否設定成功。

X-AliDM-Settings: eyJWZXJzaW9uIjogIjEuMCIsICJVbnN1YnNjcmliZSI6IHsiTGlua1R5cGUiOiAiZGVmYXVsdCIsICJGaWx0ZXJMZXZlbCI6ICJtYWlsZnJvbV9kb21haW4ifX0=

用Java代碼來表示如下：

import com.alibaba.fastjson.JSON;
import org.apache.commons.codec.binary.Base64;
import javax.mail.MessagingException;
import javax.mail.internet.MimeMessage;
import java.util.HashMap;


public class AliDMSetting {
    static public enum UnsubFilterLevel {
        DISABLED("disabled"),
        DEFAULT("default"),
        MAILFROM("mailfrom"),
        MAILFROM_DOMAIN("mailfrom_domain"),
        EDM_ID("edm_id");

        private final String value;

        UnsubFilterLevel(String value) {
            this.value = value;
        }

        public String getValue() {
            return value;
        }
    }
    static public enum UnsubLinkType {
        DISABLED("disabled"), // 不填寫退訂link
        DEFAULT("default"),   // 預設策略，對於到Google和yahoo的營銷地址，啟用en_US類型退訂連結埋點
        ZH_CN("zh-cn"),       // 中文（簡體）
        EN_US("en-us");       // 英語（美國），預設

        private final String value;

        UnsubLinkType(String value) {
            this.value = value;
        }

        public String getValue() {
            return value;
        }
    }

    public static String X_ALIDM_SETTING_HEADER_KEY = "X-AliDM-Settings";
    public static String X_ALIDM_SETTING_VERSION = "1.0";
    private UnsubLinkType unsubLinkType;
    private UnsubFilterLevel unsubFilterLevel;
    public AliDMSetting(UnsubLinkType unsubLinkType, UnsubFilterLevel unsubFilterLevel) {
        this.unsubLinkType = unsubLinkType;
        this.unsubFilterLevel = unsubFilterLevel;
    }

    private String generateHeaderValue() {
        HashMap<String,String> unsubSetting = new HashMap<String,String>();
        unsubSetting.put("LinkType", unsubLinkType.getValue());
        unsubSetting.put("FilterLevel", unsubFilterLevel.getValue());

        HashMap<String,Object> setting = new HashMap<>();
        setting.put("Version", X_ALIDM_SETTING_VERSION);
        setting.put("Unsubscribe", unsubSetting);

        return new String( Base64.encodeBase64(JSON.toJSONString(setting).getBytes()) );
    }

    public void generateHeader(MimeMessage message) throws MessagingException {
        message.addHeader(X_ALIDM_SETTING_HEADER_KEY, generateHeaderValue());
    }
}

python樣本：

import json
import base64

#退訂邏輯
Unsubscribe_json ={
    "Version":"1.0",
    "Unsubscribe":{
    #請根據具體需求選擇參數
        # "LinkType": "disabled",
        "LinkType": "default",
        # "LinkType": "zh-cn",
        # "LinkType": "en-us",

        # "FilterLevel": "disabled",
        # "FilterLevel": "default",
        # "FilterLevel": "mailfrom",
        "FilterLevel": "mailfrom_domain"# ,
        # "FilterLevel": "edm_id"
    }
}
Unsubscribe_jsonTrace = json.dumps(Unsubscribe_json)
Unsubscribe_base64Trace = str(base64.b64encode(Unsubscribe_jsonTrace.encode('utf-8')), 'utf-8')
# print(base64Trace)
msg.add_header("X-AliDM-Settings", Unsubscribe_base64Trace)
#退訂邏輯

目前已經支援的功能項如下表

功能點

配置項一級key

配置項二級key

配置項描述

退訂功能

Unsubscribe

LinkType

產生的退訂連結類型。參照退訂功能產生連結和過濾機制文檔

disabled 不產生

default 採用預設策略：對批量類型的發信地址發給特定網域名稱時會產生退訂連結，如帶有關鍵字"gmail", "yahoo",

"google", "aol.com", "hotmail",

"outlook", "ymail.com"等

zh-cn 產生，給將來埋點到內容準備

en-us 產生，給將來埋點到內容準備

FilterLevel

過濾層級。參照退訂功能產生連結和過濾機制文檔

disabled 不過濾

default 採用預設策略，批量地址採用發信地址層級過濾

mailfrom 發信地址層級過濾

mailfrom_domain 發信網域名稱層級過濾

edm_id 帳號層級過濾

收件者收到的郵件標頭樣本：

以下樣本做了脫敏處理，請前往收件匣下載或查看測試郵件eml檔案，擷取郵件標頭中的退訂連結。

List-Unsubscribe-Post: List-Unsubscribe=One-Click
List-Unsubscribe: <http://dm-cn.aliyuncs.com/trace/v1/unsubscribe?lang=zh-cn&sign=cd03d4d252bxxxxxxxx0d99c&token=eyJjYW1wYWlnbl90aW1lIjoxNzA2MjU3NjxxxxxxxxxxxxxxxxjAzNTUxNDMiLCJtYWlsX2Zyb20iOiJ6azFAdDEuemtkbS54eXoiLCJtYWlsX3RvIjoiemsxQHprZG0ueHl6In0%3D&version=1.0>

說明

是否顯示退訂按鈕由收信方的策略決定，部分服務商只有發信地址或網域名稱信譽達到要求才會顯示退訂按鈕，建議登入收信方郵箱進行效果測試。

若還未正常顯示，也可以使用下面命令對產生的連結進行測試。

linux測試命令：

以下樣本做了脫敏處理，請前往收件匣下載或查看測試郵件eml檔案，擷取郵件標頭中的退訂連結。

curl -X POST "http://dm-cn.aliyuncs.com/trace/v1/unsubscribe?lang=zh-cn&sign=cd03d4d252bxxxxxxxx0d99c&token=eyJjYW1wYWlnbl90aW1lIjoxNzA2MjU3NjxxxxxxxxxxxxxxxxjAzNTUxNDMiLCJtYWlsX2Zyb20iOiJ6azFAdDEuemtkbS54eXoiLCJtYWlsX3RvIjoiemsxQHprZG0ueHl6In0%3D&version=1.0"
或
curl -X POST -d "lang=zh-cn&sign=cd03d4d252bxxxxxxxx0d99c&token=eyJjYW1wYWlnbl90aW1lIjoxNzA2MjU3NjxxxxxxxxxxxxxxxxjAzNTUxNDMiLCJtYWlsX2Zyb20iOiJ6azFAdDEuemtkbS54eXoiLCJtYWlsX3RvIjoiemsxQHprZG0ueHl6In0%3D&version=1.0" "http://dm-cn.aliyuncs.com/trace/v1/unsubscribe"

效果展示：

退訂測試.png