發送相關

最新更新:2023-03-14

普通發送

URL

https://email.api.engagelab.cc/v1/mail/send
          https://email.api.engagelab.cc/v1/mail/send

        
此代碼塊在浮窗中顯示

Content-Type:

Content-Type: application/json;charset=utf-8
          Content-Type: application/json;charset=utf-8

        
此代碼塊在浮窗中顯示

HTTP請求方式

POST
          POST

        
此代碼塊在浮窗中顯示

請求Header

Header 類型 必須 説明
Authorization String true Basic base64(api_user:api_key)

請求參數

參數 類型 必須 説明
from string 發件人。舉例:support@mail.engagelab.com,support<support@mail.engagelab.com>
to array[string] 收件人。 最大支持100個地址。如 ["xjm@hotmail.com","xjm2@gmail.com"]
body object 郵件設置
custom_args object 客戶自定義的可選欄位,最大支持1KB。
request_id string 本次發送請求ID; 最大支持128字符。

Body

參數 類型 必須 説明
cc array[string] 抄送地址。 最大支持100個地址。 僅send_ mode = 1時,本參數有效。
bcc array[string] 密送地址。 最大支持100個地址。 僅send_ mode = 1時,本參數有效。
reply_to array[string] 回復地址。 最大支持3個地址; 如果不傳值,則回復郵寄地址為from
subject string 郵件主題。 最大256字符; 支持變數、emoji。
content object 郵件正文
html string * 郵件的內容。 郵件格式為text/html。
text string * 郵件的內容。 郵件格式為text/plain。
preview_text string 郵件摘要
vars object 變數。 最大支持1MB; 當send_ mode=0 or send_mode=1時,本參數有效。
label_id string 本次發送所使用的標籤ID
label_name string 本次發送所使用的標籤名字
headers object 郵件頭部資訊。 最大1KB。
attachments array[object] 郵件附件。 總大小不得超過10MB。
content string 附件內容base64編碼
filename string 附件檔名,舉例:news.pdf
disposition string 值允許attachment、inline。
content_id string 如果disposition的值為inline,檔案類型為image,則需要設定該值。
settings object 發送設定
send_mode int 發送方式。 0表示單獨發送; 1表示廣播發送,所有收件人會同時顯示; 2表示地址清單發送,to的值為地址清單別稱。 默認為0。
return_email_id boolean 是否返回email ID,默認true。
sandbox boolean 是否使用沙箱模式,默認false。 如果為true,郵件不會被投遞,只會驗證請求參數是否合法。
notification boolean 是否使用已讀回執,默認false。 默認回執到from,需要和收信路由配合使用。
open_tracking boolean 是否開啟open追跡,默認系統設置值。 當send_ mode=0 or send_mode=1時,本參數有效。
click_tracking boolean 是否開啟click追跡,默認系統設置值。 當send_ mode=0 or send_mode=1時,本參數有效。
unsbuscribe_tracking boolean 是否開啟取消訂閱,默認系統設置值。 當send_ mode=0 or send_mode=1時,本參數有效。
unsubscribe_page_id array[int] 自定義取消訂閱頁面,默認系統設置值。 當send_ mode=0 or send_mode=1時,本參數有效。

注意:

  1. send_ mode=2時,to的值為地址清單別稱,個數不能超過5個,且此時參數cc、bcc失效。

  2. html和plain不能同時為空。

  3. preview_ text只能和html一起使用,如果不傳html的值,preview_ text的值不會生效。

  4. vars用於郵件內容的變數替換,格式為json對象,格式為{“varname”:[“value1,”value2“]},其中varname為郵件內容變數。

    郵件內容為:親愛的%name%,歡迎使用%sp%郵件服務。 對應vars傳值:{“name”:[“mike”],“sp”:[“engagelab”]} 郵件內容替換:親愛的mike,歡迎使用engagelab郵件服務。
               郵件內容為:親愛的%name%,歡迎使用%sp%郵件服務。
     
     對應vars傳值:{“name”:[“mike”],“sp”:[“engagelab”]}
     
     郵件內容替換:親愛的mike,歡迎使用engagelab郵件服務。
    
            
    此代碼塊在浮窗中顯示
  5. 用戶傳label_id或者label_name,如果label_name不存在則系統自動創建;如果label_id和label name同時傳值,label_name被忽略

  6. headers用於自定義郵件的頭域,格式為json對象,格式為{“User-Define”:“123”,“User-Custom”:“abc”}。 但是key的字串不能包含以下值(不區分大小寫)

    DKIM-Signature ,Received ,Sender ,Date ,From ,To ,Reply-To ,Cc ,Bcc ,Subject ,Content-Type , Content-Transfer-Encoding ,X-SENDCLOUD-UUID ,X-SENDCLOUD-LOG ,X-Remote-Web-IP ,X-SMTPAPI, Return-Path,X-SENDCLOUD-LOG-NEW

7.disposition被設定為inline時,附件內容是圖片,附件會作為內聯圖片直接在郵件正文中渲染顯示。 content_ id必須設定且唯一字串,作為圖片在郵件正文中顯示時的src。

郵件正文: <html> <img src="cid:image_1000"></img> <img src="cid:image_1001"></img> </html> attachments參數: [ {"content":" base 64 image content", "filename": "a23456.jpg","disposition": "inline","content_id": "image_1000"}, {"content":" base 64 image content", "filename": "a23457.jpg","disposition": "inline","content_id": "image_1001"}, ]
              郵件正文:
    <html>
        <img src="cid:image_1000"></img>
        <img src="cid:image_1001"></img>
    </html>
    
    attachments參數:
    [
      {"content":" base 64 image content", "filename": "a23456.jpg","disposition": "inline","content_id": "image_1000"},
      {"content":" base 64 image content", "filename": "a23457.jpg","disposition": "inline","content_id": "image_1001"},
    ]

        
此代碼塊在浮窗中顯示
  1. customer_ args作為客戶自定義內容,會在郵件頭埋點; 後續的WebHook數據中,會回傳給客戶。

  2. request_ id為防止重複提交,有效期1小時。 若1小時內重複提交,將返回上次請求結果。

  3. 郵件總大小不能超過70MB。

請求示例

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ==' --data '{ "from": "EngageLab Newsletter <newsletter@mail.engagelab.com>", "to": ["111@qq.com", "222<222@qq.com>"], "body": { "cc": ["noreply@mail.engagelab.com"], "bcc": ["intern<intern@mail.engagelab.com>"], "reply_to": ["reply@mail.engagelab.com"], "subject": "%date% Newsletter ", "content": { "html": "<a href=\"https://www.engagelab.com\">Newsletter %kkk%</a>", "text": "Today's news is %ttt%", "preview_text": "preview_text is ..." }, "vars": { }, "label_id": 100233, "label_name": "", "headers": {}, "attachments": [{ "content": "The Base64 encoded content of the attachment", "type": "text/html", "filename": "The attachment's filename", "disposition": "inline | attachment", "content_id": "" }], "settings": { "send_mode": 0, "return_email_id": true, "sandbox": false, "notification": false, "open_tracking": true, "click_tracking": false, "unsubscribe_tracking": true, "unsubscribe_page_id": [1,2] } }, "custom_args": {}, "request_id": "" }' 'https://email.api.engagelab.cc/v1/mail/send'
          curl -X POST -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ==' 
     --data '{
  "from": "EngageLab Newsletter <newsletter@mail.engagelab.com>", 
  "to": ["111@qq.com", "222<222@qq.com>"],
  "body": {
      "cc": ["noreply@mail.engagelab.com"],                            
      "bcc": ["intern<intern@mail.engagelab.com>"],                  
      "reply_to": ["reply@mail.engagelab.com"],                         
      "subject": "%date% Newsletter ",                                       
      "content": {                                                     
        "html": "<a href=\"https://www.engagelab.com\">Newsletter %kkk%</a>", 
        "text": "Today's news is %ttt%",                                      
        "preview_text": "preview_text is ..."                          
         },
      "vars": { },
      "label_id": 100233, 
      "label_name": "",
      "headers": {},
      "attachments": [{                                                
        "content": "The Base64 encoded content of the attachment",     
        "type": "text/html",
        "filename": "The attachment's filename",            
        "disposition": "inline | attachment",                           
        "content_id": ""  
      }],
      "settings": {                 
        "send_mode": 0, 
        "return_email_id": true,  
        "sandbox": false,
        "notification": false,
        "open_tracking": true,                                           
        "click_tracking": false,                                         
        "unsubscribe_tracking": true,                              
        "unsubscribe_page_id": [1,2]
      }
  },
  "custom_args": {},           
  "request_id": "" 
}'  'https://email.api.engagelab.cc/v1/mail/send' 

        
此代碼塊在浮窗中顯示

響應示例

  • 非地址清單發送(send_mode=0或send_mode=1)

    Response-success

HTTP Status: 200

{ "email_ids":[ "1447054895514_15555555_32350_1350.sc-10_10_126_221-inbound0$111@qq.com", "1447054895514_15555555_32350_1350.sc-10_10_126_221-inbound1$222@qq.com"], "request_id":"" }
          {
"email_ids":[
      "1447054895514_15555555_32350_1350.sc-10_10_126_221-inbound0$111@qq.com",
      "1447054895514_15555555_32350_1350.sc-10_10_126_221-inbound1$222@qq.com"],
"request_id":""
}

        
此代碼塊在浮窗中顯示

Response-error

HTTP Status :400

{ "code": 30801, "message": "From can not be empty" }
          {
    "code": 30801,
    "message": "From can not be empty"
}

        
此代碼塊在浮窗中顯示
  • 地址清單發送(send_mode=2)

Response-success

HTTP Status: 200

{ "task_id":[102923], "request_id":"" }
          {
"task_id":[102923],
"request_id":""
}

        
此代碼塊在浮窗中顯示

Response-error

HTTP Status :400

{ "code": 30801, "message": "From can not be empty" }
          {
    "code": 30801,
    "message": "From can not be empty"
}

        
此代碼塊在浮窗中顯示

模板發送

URL

https://email.api.engagelab.cc/v1/mail/sendtemplate
          https://email.api.engagelab.cc/v1/mail/sendtemplate

        
此代碼塊在浮窗中顯示

Content-Type:

Content-Type: application/json; charset=utf-8
          Content-Type: application/json; charset=utf-8

        
此代碼塊在浮窗中顯示

HTTP請求方式

POST
          POST

        
此代碼塊在浮窗中顯示

請求Header

Header 類型 必須 説明
Authorization String true Basic base64(api_user:api_key)

請求參數

參數 類型 必須 説明
from string 發件人。 舉例:support@mail.engagelab.com,support<support@mail.engagelab.com>.
to array[string] 收件人。 最大支持100個地址。如 ["xjm@hotmail.com","xjm2@gmail.com"]
body object 郵件設置
custom_args object 客戶自定義的可選欄位,最大支持1KB。
request_id string 本次發送請求ID; 最大支持128字符。

Body

參數 類型 必須 説明
cc array[string] 抄送地址。 最大支持100個地址。 僅send_ mode = 1時,本參數有效。
bcc array[string] 密送地址。 最大支持100個地址。 僅send_ mode = 1時,本參數有效。
reply_to array[string] 回復地址。 最大支持3個地址; 如果不傳值,則回復郵寄地址為from 。
subject string 郵件主題。 最大256字符; 支持變數、emoji。若填寫將覆蓋調用模板的主題。
template_invoke_name string 模板調用名稱。
vars object 變數。 最大支持1MB; 當send_ mode=0 or send_mode=1時,本參數有效。
label_id string 本次發送所使用的標籤ID。
label_name string 本次發送所使用的標籤名字。
headers object 郵件頭部資訊。 最大1KB。
attachments array[object] 附件設定
content string 附件內容base64編碼
filename string 附件檔名,舉例:news.pdf
disposition string 值允許attachment、inline。
content_id string 如果disposition被設定為inline,檔案類型為image,需要設定該值。
settings object 發送設置
send_mode int 發送方式。 0表示單獨發送; 1表示廣播發送,所有收件人會同時顯示; 2表示地址清單發送,to的值為地址清單別稱.默認為0。
return_email_id boolean 是否返回email ID,默認true。
sandbox boolean 是否使用沙箱模式,默認false。 如果為true,郵件不會被投遞,只會驗證請求參數是否合法。
notification boolean 是否使用已讀回執,默認false。 默認回執到from,需要和收信路由配合使用。
open_tracking boolean 是否開啟open追跡,默認系統設置值。 當send_ mode=0 or send_mode=1時,本參數有效。
click_tracking boolean 是否開啟click追跡,默認系統設置值。 當send_ mode=0 or send_mode=1時,本參數有效。
unsbuscribe_tracking boolean 是否開啟取消訂閱。 默認系統設置值。 當send_ mode=0 or send_mode=1時,本參數有效。
unsubscribe_page_id array[int] 自定義取消訂閱頁面,默認系統設置值。 當send_ mode=0 or send_mode=1時,本參數有效。

注意:

  1. send_ mode=2時,to的值為地址清單別稱,個數不能超過5個,且此時參數cc、bcc失效。

  2. vars用於郵件內容的變數替換,格式為json對象,格式為{“varname”:[“value1,”value2“]},其中varname為郵件內容變數。

    郵件內容為:親愛的%name%,歡迎使用%sp%郵件服務。 對應vars傳值:{“name”:[“mike”],“sp”:[“engagelab”]} 郵件內容替換:親愛的mike,歡迎使用engagelab郵件服務。
               郵件內容為:親愛的%name%,歡迎使用%sp%郵件服務。
     
     對應vars傳值:{“name”:[“mike”],“sp”:[“engagelab”]}
     
     郵件內容替換:親愛的mike,歡迎使用engagelab郵件服務。
     
    
            
    此代碼塊在浮窗中顯示
  3. 用戶傳label_id或者label_name,如果label_name不存在則系統自動創建;如果label_id和label name同時傳值,label_name被忽略

  4. headers用於自定義郵件的頭域,格式為json對象,格式為{“User-Define”:“123”,“User-Custom”:“abc”}。 但是key的字串不能包含以下值(不區分大小寫)

    DKIM-Signature ,Received ,Sender ,Date ,From ,To ,Reply-To ,Cc ,Bcc ,Subject ,Content-Type , Content-Transfer-Encoding ,X-SENDCLOUD-UUID ,X-SENDCLOUD-LOG ,X-Remote-Web-IP ,X-SMTPAPI, Return-Path,X-SENDCLOUD-LOG-NEW

  5. disposition被設定為inline時,附件內容是圖片,附件會作為內聯圖片直接在郵件正文中渲染顯示。 content_ id必須設定且唯一字串,作為圖片在郵件正文中顯示時的src。

郵件正文: <html> <img src="cid:image_1000"></img> <img src="cid:image_1001"></img> </html> attachments參數: [ {"content":" base 64 image content", "filename": "a23456.jpg","disposition": "inline","content_id": "image_1000"}, {"content":" base 64 image content", "filename": "a23457.jpg","disposition": "inline","content_id": "image_1001"}, ]
              郵件正文:
    <html>
        <img src="cid:image_1000"></img>
        <img src="cid:image_1001"></img>
    </html>
    
    attachments參數:
    [
      {"content":" base 64 image content", "filename": "a23456.jpg","disposition": "inline","content_id": "image_1000"},
      {"content":" base 64 image content", "filename": "a23457.jpg","disposition": "inline","content_id": "image_1001"},
    ]

        
此代碼塊在浮窗中顯示
  1. customer_ args作為客戶自定義內容,會在郵件頭埋點; 後續的WebHook數據中,會回傳給客戶 。
  2. request_ id為防止重複提交,有效期1小時。 若1小時內重複提交,將返回上次請求結果。
  3. 郵件總大小不能超過70MB。

示例

month_bill 模板内容

親愛的%name%: 您好! 您本月在愛發信的消費金額為:%money%元。
          親愛的%name%:
您好! 您本月在愛發信的消費金額為:%money%元。

        
此代碼塊在浮窗中顯示

範本普通發送示例(調用模板month_bill)

curl -X POST "https://email.api.engagelab.cc/v1/mail/sendtemplate" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "from": "support@mail.engagelab.com", "to": ["xjmfc@126.com", "xjmfcme@gmail.com"], "body": { "subject": "test email", "template_invoke_name": "month_bill", "label_id": 10143, "label_name": "", "vars": { "%name%": ["jack", "jone"], "%money%": ["30", "50"] }, "headers": { "userdefine-tag-location": "us", "userdefine-tag-user": "fashion" }, "attachments": [{ "content": "The Base64 encoded content of the attachment", "filename": "The attachment's filename", "disposition": "inline | attachment", "content_id": "" }], "settings": { "send_mode": 0, "return_email_id": true, "sandbox": false, "notification": false, "open_tracking": true, "click_tracking": false, "unsubscribe_tracking": true, "unsubscribe_page_id": [1, 2] } }, "custom_args": {}, "request_id": "" }' #xjmfc@126.com收到的郵件: 親愛的jack: 您好! 您本月在愛發信的消費金額為:30元。 #--------------------------------------------------- # xjmfcme@gmail.com 收到的郵件: 親愛的Joe: 您好! 您本月在愛發信的消費金額為:50元。
          curl -X POST "https://email.api.engagelab.cc/v1/mail/sendtemplate" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
    "from": "support@mail.engagelab.com",
    "to": ["xjmfc@126.com", "xjmfcme@gmail.com"],
    "body": {
        "subject": "test email",
        "template_invoke_name": "month_bill",
        "label_id": 10143,
        "label_name": "",
        "vars": {
            "%name%": ["jack", "jone"],
            "%money%": ["30", "50"]
        },
        "headers": {
            "userdefine-tag-location": "us",
            "userdefine-tag-user": "fashion"
        },
        "attachments": [{
            "content": "The Base64 encoded content of the attachment",
            "filename": "The attachment's filename",
            "disposition": "inline | attachment",
            "content_id": ""
        }],
        "settings": {
            "send_mode": 0,
            "return_email_id": true,
            "sandbox": false,
            "notification": false,
            "open_tracking": true,
            "click_tracking": false,
            "unsubscribe_tracking": true,
            "unsubscribe_page_id": [1, 2]
        }
    },
    "custom_args": {},
    "request_id": ""
        
}'


#xjmfc@126.com收到的郵件:
親愛的jack:

您好! 您本月在愛發信的消費金額為:30

#---------------------------------------------------
# xjmfcme@gmail.com 收到的郵件:
親愛的Joe:

您好! 您本月在愛發信的消費金額為:50

        
此代碼塊在浮窗中顯示

響應示例

Response-success

HTTP Status: 200

{ "email_ids":[ "1447054895514_15555555_32350_1350.sc-10_10_126_221-inbound0$ben@gmail.com", "1447054895514_15555555_32350_1350.sc-10_10_126_221-inbound1$joe@gmail.com"], "request_id":"" }
          
{
"email_ids":[
      "1447054895514_15555555_32350_1350.sc-10_10_126_221-inbound0$ben@gmail.com",
      "1447054895514_15555555_32350_1350.sc-10_10_126_221-inbound1$joe@gmail.com"],
"request_id":""
}

        
此代碼塊在浮窗中顯示

Response-error

HTTP Status :404

not found
          not found

        
此代碼塊在浮窗中顯示

範本地址清單發送(調用範本month_bill,調用地址清單 users@maillist.email.engagelab.com

curl -X POST "https://email.api.engagelab.cc/v1/mail/sendtemplate" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "from": "admin@engaelab.com", "to": ["users@maillist.email.engagelab.com"], "body": { "subject": "2022年11月帳單", "template_invoke_name": "month_bill", "label": "雙11" } }'
          curl -X POST "https://email.api.engagelab.cc/v1/mail/sendtemplate" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
    "from": "admin@engaelab.com",
    "to": ["users@maillist.email.engagelab.com"],
    "body": {
        "subject": "2022年11月帳單",
        "template_invoke_name": "month_bill",
        "label": "雙11"
    }
}'

        
此代碼塊在浮窗中顯示

Response-success

HTTP Status: 200

{ "task_id":[102923], "request_id":"" }
          {
"task_id":[102923],
"request_id":""
}

        
此代碼塊在浮窗中顯示

Response-error

HTTP Status :404

not found
          not found

        
此代碼塊在浮窗中顯示

發送會議日曆

URL

https://email.api.engagelab.cc/v1/mail/sendcalendar
          https://email.api.engagelab.cc/v1/mail/sendcalendar

        
此代碼塊在浮窗中顯示

Content-Type:

Content-Type: application/json; charset=utf-8
          Content-Type: application/json; charset=utf-8

        
此代碼塊在浮窗中顯示

HTTP請求方式

POST
          POST

        
此代碼塊在浮窗中顯示

請求Header

Header 類型 必須 說明
Authorization String true Basic base64(api_user:api_key)

請求參數

參數 類型 必須 説明
from string 發件人。 舉例:support@mail.engagelab.com,support<support@mail.engagelab.com>.
to array[string] 收件人。 最大支持100個地址。如 ["xjm@hotmail.com","xjm2@gmail.com"]
body object 郵件設置
custom_args object 客戶自定義的可選欄位。
request_id string 請求ID

Body

參數 類型 必須 説明
cc array[string] 抄送地址。 最大支持100個地址。 僅send_ mode = 1時,本參數有效。
bcc array[string] 抄送地址。 最大支持100個地址。 僅send_ mode = 1時,本參數有效。
reply_to array[string] 回復地址。 最大支持3個地址; 如果不傳值,則回復郵寄地址為from。
subject string 郵件主題。 最大256字符; 支持變數、emoji。
content object 郵件內容設定
html string * 郵件的內容。 郵件格式為text/html。
text string * 邮件的内容。邮件格式为 text/plain。
preview_text string 郵件摘要
vars object 變數。 最大支持1MB; 當send_ mode=0 or send_mode=1時,本參數有效。
label_id string 本次發送所使用的標籤ID
label_name string 本次發送所使用的標籤名字
headers object 郵件頭部信息。最大1KB。
attachments array[object] 郵件附件。總大小不得超過10MB。
content string 附件內容base64編碼
filename string 附件檔名,舉例:news.pdf
disposition string 允許值為:inline、attachment
content_id string 如果disposition被設定為inline,檔案類型為image,需要設定該值。
settings object 發送設置
send_mode int 發送方式。0表示單獨發送; 1表示廣播發送,所有收件人會同時顯示;默認為0。
return_email_id boolean 返回email ID,默認true。
sandbox boolean 是否使用沙箱模式,默認false。 如果為true,郵件不會被投遞,只會驗證請求參數是否合法。
notification boolean 是否使用回執,默認false。 默認回執到from,需要和收信路由配合使用。
open_tracking boolean 是否開啟open追跡,默認系統配寘值。 當send_ mode=0 or send_mode=1時,本參數有效。
click_tracking boolean 是否開啟click追跡,默認系統配寘值。 當send_ mode=0 or send_mode=1時,本參數有效。
unsbuscribe_tracking boolean 是否開啟取消訂閱,默認系統配寘值。 當send_ mode=0 or send_mode=1時,本參數有效。
unsubscribe_page_id array[int] 自定義取消訂閱頁面,默認系統設置值。 當send_ mode=0 or send_mode=1時,本參數有效。
calendar object 日曆設置
time_zone_id string 示例參見日曆時區字典
start_time string 日程開始時間。 形如:yyyy-MM-dd HH:mm:ss
end_time string 日程結束時間。 形如:yyyy-MM-dd HH:mm:ss
title string 會議標題。最大256字符。
organizer object 組織者
name string 名稱。最大64字符。
email string 郵箱地址
location string 會議地點。最大128字符。
description string 會議描述。最大1024字符。
participators array[object] 參與者
name string 名字。最大64字符
email string 郵箱地址
alarm_min_before integer 提前多少分鐘進行會議提醒。 範圍1 ~ 60。
action object 日曆操作
name string 操作名稱。 允許值:create,update,cancel。 預設值為create。
uid string update和cancel時候需要傳遞此參數。 uid值會在create行事曆郵件時介面返回。

注意:

  1. html和plain不能同時為空。

  2. preview_ text只能和html一起使用,如果不傳html的值,preview_ text的值不會生效。

  3. vars用於郵件內容的變數替換,格式為json對象,格式為{“varname”:[“value1,”value2“]},其中varname為郵件內容變數。

    郵件內容為:親愛的%name%,歡迎使用%sp%郵件服務。 對應vars傳值:{“name”:[“mike”],“sp”:[“engagelab”]} 郵件內容替換:親愛的mike,歡迎使用engagelab郵件服務。
              郵件內容為:親愛的%name%,歡迎使用%sp%郵件服務。
    
    對應vars傳值:{“name”:[“mike”],“sp”:[“engagelab”]}
    
    郵件內容替換:親愛的mike,歡迎使用engagelab郵件服務。
    
            
    此代碼塊在浮窗中顯示
  4. 用戶傳label_id或者label_name,如果label_name不存在則系統自動創建;如果label_id和label name同時傳值,label_name被忽略

  5. headers用於自定義郵件的頭域,格式為json對象,格式為{“User-Define”:“123”,“User-Custom”:“abc”}。 但是key的字串不能包含以下值(不區分大小寫)

    DKIM-Signature ,Received ,Sender ,Date ,From ,To ,Reply-To ,Cc ,Bcc ,Subject ,Content-Type , Content-Transfer-Encoding ,X-SENDCLOUD-UUID ,X-SENDCLOUD-LOG ,X-Remote-Web-IP ,X-SMTPAPI, Return-Path,X-SENDCLOUD-LOG-NEW

7.disposition被設定為inline時,附件內容是圖片,附件會作為內聯圖片直接在郵件正文中渲染顯示。 content_ id必須設定且唯一字串,作為圖片在郵件正文中顯示時的src。

郵件正文: <html> <img src="cid:image_1000"></img> <img src="cid:image_1001"></img> </html> attachments參數: [ {"content":" base 64 image content", "filename": "a23456.jpg","disposition": "inline","content_id": "image_1000"}, {"content":" base 64 image content", "filename": "a23457.jpg","disposition": "inline","content_id": "image_1001"}, ]
              郵件正文:
    <html>
        <img src="cid:image_1000"></img>
        <img src="cid:image_1001"></img>
    </html>
    
    attachments參數:
    [
      {"content":" base 64 image content", "filename": "a23456.jpg","disposition": "inline","content_id": "image_1000"},
      {"content":" base 64 image content", "filename": "a23457.jpg","disposition": "inline","content_id": "image_1001"},
    ]

        
此代碼塊在浮窗中顯示
  1. customer_ args作為客戶自定義內容,會在郵件頭埋點; 後續的WebHook數據中,會回傳給客戶。

  2. request_ id為防止重複提交,有效期1小時。 若1小時內重複提交,將返回上次請求結果。

  3. 郵件總大小不能超過70MB。

示例

curl -X POST 'https://email.api.engagelab.cc/v1/mail/sendcalendar' \ --header 'Authorization: Basic MTIyNF94am06MTJkOGIwODVlNjZhZGUyMmNlNGIwOWI5NjQ2YWQ1ODE=' \ --header 'Content-Type: application/json' \ --data '{ "from": "EngageLab Newsletter <newsletter@mail.engagelab.com>", "to": ["111@qq.com", "222<222@qq.com>"], "body": { "cc": ["noreply@mail.engagelab.com"], "bcc": ["intern<intern@mail.engagelab.com>"], "reply_to": ["reply@mail.engagelab.com"], "subject": "%date% Newsletter ", "content": { "html": "<a href=\"https://www.engagelabe.com\">Newsletter %kkk%</a>", "text": "Newsletter %ttt%", "preview_text": "preview_text is ..." }, "label_id": "1233", "label_name": "", "headers": { "userdefine-tag-location": "us", "userdefine-tag-user": "fashion" }, "settings": { "send_mode": 0, "return_email_id": true, "sandbox": true, "notification": false, "open_tracking": true, "click_tracking": false, "unsubscribe_tracking": true, "unsubscribe_page_id": [1,2] }, "calendar": { "time_zone_id":"America/New_York", "start_time": "2020-12-10 10:00:00", "end_time": "2020-12-10 12:00:00", "title": "meeting titel", "organizer": { "name": "David", "email": "david@mail.engagelab.com" }, "location": "room208", "description": "hello", "alarm_min_before": 5, "participators": [ { "name": "p1", "email": "p1@engagelab.org" }, { "email": "p2@engagelab.org", "name": "p2"}, { "email": "p3@engagelab.org"} ], "action": { "name": "create", "uid": "329r239h239888" } } }, "custom_args": {}, "request_id": "" }'
          curl -X POST 'https://email.api.engagelab.cc/v1/mail/sendcalendar' \
--header 'Authorization: Basic MTIyNF94am06MTJkOGIwODVlNjZhZGUyMmNlNGIwOWI5NjQ2YWQ1ODE=' \
--header 'Content-Type: application/json' \
--data '{
"from": "EngageLab Newsletter <newsletter@mail.engagelab.com>",       
"to": ["111@qq.com", "222<222@qq.com>"],    
"body": {
    "cc": ["noreply@mail.engagelab.com"],       
    "bcc": ["intern<intern@mail.engagelab.com>"],         
    "reply_to": ["reply@mail.engagelab.com"], 
    "subject": "%date% Newsletter ", 
    "content": { 
      "html": "<a href=\"https://www.engagelabe.com\">Newsletter %kkk%</a>", 
      "text": "Newsletter %ttt%",   
      "preview_text": "preview_text is ..." 
    },
    "label_id": "1233",  
    "label_name": "",
    "headers": {                   
      "userdefine-tag-location": "us",  
      "userdefine-tag-user": "fashion"
    },
   
    "settings": {                                                    
      "send_mode": 0,        
      "return_email_id": true,     
      "sandbox": true,        
      "notification": false, 
      "open_tracking": true,                          
      "click_tracking": false,                       
      "unsubscribe_tracking": true,  
      "unsubscribe_page_id": [1,2]
    },
    "calendar": {
      "time_zone_id":"America/New_York",
      "start_time": "2020-12-10 10:00:00",  
      "end_time": "2020-12-10 12:00:00",  
      "title": "meeting titel",                                              
      "organizer": {      
        "name": "David",        
        "email": "david@mail.engagelab.com"                    
      },
      "location": "room208",                                         
      "description": "hello",                                        
      "alarm_min_before": 5,                                         
      "participators": [  
        { 
          "name": "p1",                                                
          "email": "p1@engagelab.org"
        },                      
        { "email": "p2@engagelab.org", "name": "p2"},
        { "email": "p3@engagelab.org"}
      ],
      "action": {                                                      
        "name": "create",   
        "uid": "329r239h239888"                                    
      }
    }
},
"custom_args": {},           
"request_id": "" 
}'

        
此代碼塊在浮窗中顯示

響應示例

Response-success

HTTP Status: 200

{ "uid": "20230103T065922Z-uidGen@PC201503200437", "email_ids": [ "1672729159224_15_2942_8497.sc-10_2_226_96-test0$111@qq.com", "1672729159224_15_2942_8497.sc-10_2_226_96-test1$222@qq.com" ], "request_id": "" }
          {
    "uid": "20230103T065922Z-uidGen@PC201503200437",
    "email_ids": [
        "1672729159224_15_2942_8497.sc-10_2_226_96-test0$111@qq.com",
        "1672729159224_15_2942_8497.sc-10_2_226_96-test1$222@qq.com"
    ],
    "request_id": ""
}

        
此代碼塊在浮窗中顯示

Response-error

HTTP Status :400

{ "code": 30801, "message": "From can not be empty" }
          {
    "code": 30801,
    "message": "From can not be empty"
}

        
此代碼塊在浮窗中顯示
在文档中心打开