Messaging · Html5+參考

# [messaging]() Messaging模塊管理設備通訊功能，可用于短信、彩信、郵件發送等。通過plus.messaging可獲取設備通訊管理對象。另外也可以直接通過html中的href直接快速發送短信、撥打電話、發送郵件等。 ### 常量： - [TYPE_SMS](http://www.dcloud.io/docs/api/zh_cn/messaging.shtml#plus.messaging.TYPE_SMS): 簡單短信類型常量 - [TYPE_MMS](http://www.dcloud.io/docs/api/zh_cn/messaging.shtml#plus.messaging.TYPE_MMS): 彩信類型常量 - [TYPE_EMAIL](http://www.dcloud.io/docs/api/zh_cn/messaging.shtml#plus.messaging.TYPE_EMAIL): 郵件類型常量 ### 方法： - [createMessage](http://www.dcloud.io/docs/api/zh_cn/messaging.shtml#plus.messaging.createMessage): 創建消息對象 - [sendMessage](http://www.dcloud.io/docs/api/zh_cn/messaging.shtml#plus.messaging.sendMessage): 發送消息 ### 對象： - [Message](http://www.dcloud.io/docs/api/zh_cn/messaging.shtml#plus.messaging.Message): 消息對象 - [BodyType](http://www.dcloud.io/docs/api/zh_cn/messaging.shtml#plus.messaging.BodyType): 消息體內容類型 ### 回調方法： - [MessageSendSuccessCallback](http://www.dcloud.io/docs/api/zh_cn/messaging.shtml#plus.messaging.MessageSendSuccessCallback): 消息發送成功的回調函數 - [MessageErrorCallback](http://www.dcloud.io/docs/api/zh_cn/messaging.shtml#plus.messaging.MessageErrorCallback): 消息發送失敗的回調函數 ### 權限： permissions ~~~ "Messaging": { "description": "訪問設備通訊能力" } ~~~ # [TYPE_SMS]() 簡單短信類型常量 ~~~ plus.messaging.TYPE_SMS; ~~~ ### 說明： Number 類型消息類型常量，Number類型，固定值為1，用于創建并發送短信。 ### 平臺支持 - Android - 2.2+ (支持): 支持 - iOS - 4.3+ (支持): 支持 # [TYPE_MMS]() 彩信類型常量 ~~~ plus.messaging.TYPE_MMS; ~~~ ### 說明： Number 類型消息類型常量，Number類型，固定值為2，用于創建并發送多媒體短信（彩信）。 ### 平臺支持 - Android - 2.2+ (支持): 支持 - iOS - 4.3+ (不支持): 不支持彩信的發送 # [TYPE_EMAIL]() 郵件類型常量 ~~~ plus.messaging.TYPE_EMAIL; ~~~ ### 說明： Number 類型消息類型常量，Number類型，固定值為3，用于創建并發送郵件。 ### 平臺支持 - Android - 2.2+ (支持): 支持 - iOS - 4.3+ (支持): 支持 # [createMessage]() 創建消息對象 ~~~ Message plus.messaging.createMessage( type ); ~~~ ### 說明：創建指定類型的消息，消息類型可取plus.messaging.TYPE_SMS、plus.messaging.TYPE_MMS、plus.messaging.TYPE_EMAIL。 ### 參數： - type : *( Number ) 必選 *消息類型要創建的消息類型常量，可取plus.messaging.TYPE_SMS、plus.messaging.TYPE_MMS、plus.messaging.TYPE_EMAIL。 ### 返回值： [Message](http://www.dcloud.io/docs/api/zh_cn/messaging.shtml#plus.messaging.Message) : Message對象 ### 平臺支持： - Android - 2.2+ (支持): 支持 - iOS - 4.3+ (支持): 支持 ### 示例： ~~~ <!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Messaging Example</title> <script type="text/javascript"> // 擴展API加載完畢后調用onPlusReady回調函數 document.addEventListener( "plusready", onPlusReady, false ); // 擴展API加載完畢，現在可以正常調用擴展API function onPlusReady() { } //短信 function smsTest(){ var msg = plus.messaging.createMessage(plus.messaging.TYPE_SMS); msg.to = ['18611497504', '15811140520']; msg.body = 'This is Pandora example test message'; plus.messaging.sendMessage( msg ); } </script> </head> <body> <input type='button' onclick='smsTest();' value='sms'/> </body> </html> ~~~ # [sendMessage]() 發送消息 ~~~ void plus.messaging.sendMessage( msg, successCB, errorCB ); ~~~ ### 說明：發送消息，發送成功回調successCB函數，發送失敗回調errorCB函數。 ### 參數： - msg: *( [Message](http://www.dcloud.io/docs/api/zh_cn/messaging.shtml#plus.messaging.Message) ) 必選 * 要發送的消息對象 - successCB: *( [MessageSendSuccessCallback](http://www.dcloud.io/docs/api/zh_cn/messaging.shtml#plus.messaging.MessageSendSuccessCallback) ) 可選 * 消息發送成功回調函數 - errorCB: *( [MessageErrorCallback](http://www.dcloud.io/docs/api/zh_cn/messaging.shtml#plus.messaging.MessageErrorCallback) ) 可選 * 消息發送失敗回調函數 ### 返回值： void : 無 ### 平臺支持： - Android - 2.2+ (支持): 支持 - iOS - 4.3+ (支持): 支持 ### 示例： ~~~ <!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Messaging Example</title> <script type="text/javascript"> // 擴展API加載完畢后調用onPlusReady回調函數 document.addEventListener( "plusready", onPlusReady, false ); // 擴展API加載完畢，現在可以正常調用擴展API function onPlusReady() { } //郵件 function mailTest(){ var msg = plus.messaging.createMessage(plus.messaging.TYPE_EMAIL); msg.to = ['test@163.com', 'test@173.com']; msg.cc = ['test@163.com', 'test@173.com']; msg.bcc = ['test@163.com', 'test@173.com']; msg.subject = '測試郵件'; msg.body = 'This is Pandora example test message'; plus.messaging.sendMessage( msg, function () { alert( "Send success!" ); }, function () { alert( "Send failed!" ); } ); } </script> </head> <body> <input type='button' onclick='mailTest();' value='Send Mail'/> </body> </html> ~~~ # [Message]() 消息對象 ### 屬性： - [to](http://www.dcloud.io/docs/api/zh_cn/messaging.shtml#plus.messaging.Message.to): 收件人信息 - [cc](http://www.dcloud.io/docs/api/zh_cn/messaging.shtml#plus.messaging.Message.cc): 抄送人信息 - [bcc](http://www.dcloud.io/docs/api/zh_cn/messaging.shtml#plus.messaging.Message.bcc): 暗送人信息 - [subject](http://www.dcloud.io/docs/api/zh_cn/messaging.shtml#plus.messaging.Message.subject): 發送消息主題 - [body](http://www.dcloud.io/docs/api/zh_cn/messaging.shtml#plus.messaging.Message.body): 發送消息內容 - [bodyType](http://www.dcloud.io/docs/api/zh_cn/messaging.shtml#plus.messaging.Message.bodyType): 發送消息內容類型 - [silent](http://www.dcloud.io/docs/api/zh_cn/messaging.shtml#plus.messaging.Message.silent): 是否采用靜默方式發送消息 ### 方法： - [addAttachment](http://www.dcloud.io/docs/api/zh_cn/messaging.shtml#plus.messaging.Message.addAttachment): 添加附件 # [to]() 收件人信息 ### 說明： DOMString[] 類型可選屬性字符串數組類型，輸入的地址收件人信息必須符合消息類型格式。 # [cc]() 抄送人信息 ### 說明： DOMString[] 類型可選屬性字符串數組類型，僅發送郵件時有效，輸入的地址收件人信息必須符合消息類型格式。 # [bcc]() 暗送人信息 ### 說明： DOMString[] 類型可選屬性字符串數組類型，僅發送郵件時有效，輸入的地址收件人信息必須符合消息類型格式。 # [subject]() 發送消息主題 ### 說明： DOMString 類型可選屬性字符串類型，僅發送郵件時有效。 # [body]() 發送消息內容 ### 說明： DOMString 類型可選屬性字符串類型，要發送的消息體內容，其格式必須與bodyType指定的一致。 # [bodyType]() 發送消息內容類型 ### 說明： [BodyType](http://www.dcloud.io/docs/api/zh_cn/messaging.shtml#plus.messaging.BodyType) 類型可選屬性要發送消息體內容的類型，可取值"text"表示文本內容，"html"表示為html頁面，默認值為"text"。 ### 平臺支持： - iOS - 4.3+ (支持): 支持指定消息體內容類型，可支持html和text模式。 - Android - 2.2+ (不支持): 不支持指定消息體內容類型，僅支持text模式。 ### 示例： ~~~ <!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Messaging Example</title> <script type="text/javascript"> // 擴展API加載完畢后調用onPlusReady回調函數 document.addEventListener( "plusready", onPlusReady, false ); // 擴展API加載完畢，現在可以正常調用擴展API function onPlusReady() { } // send mail function mailTest(){ var msg = plus.messaging.createMessage(plus.messaging.TYPE_SMS); msg.to = ['service@dcloud.io']; msg.bodyType = "text/html"; msg.body = '<html><body>hello world!</body></html>'; plus.messaging.sendMessage( msg ); } </script> </head> <body> <input type='button' onclick='mailTest();' value='Mail'/> </body> </html> ~~~ # [silent]() 是否采用靜默方式發送消息 ### 說明： Boolean 類型可選屬性布爾類型，可取值為true或false，true表示靜默方式發送，不彈出界面；false表示非靜默方式發送。默認采用非靜默方式。 ### 平臺支持： - iOS - 4.3+ (不支持): 不支持靜默方式發送消息，將忽略此屬性值。 - Android - 2.2+ (支持): 支持靜默方式發送短信（彩信和郵件不支持），發送成功后不會保留在系統的已發送信箱中，默認采用非靜默方式發送消息。 ### 示例： ~~~ <!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Messaging Example</title> <script type="text/javascript"> // 擴展API加載完畢后調用onPlusReady回調函數 document.addEventListener( "plusready", onPlusReady, false ); // 擴展API加載完畢，現在可以正常調用擴展API function onPlusReady() { } // send SMS function smsTest(){ var msg = plus.messaging.createMessage(plus.messaging.TYPE_SMS); msg.to = ['10086', '10001']; msg.body = 'CXYE'; msg.silent = true; plus.messaging.sendMessage( msg ); } </script> </head> <body> <input type='button' onclick='smsTest();' value='SMS'/> </body> </html> ~~~ # [addAttachment]() 添加附件 ~~~ msg.addAttachment( url ); ~~~ ### 說明：向消息中添加附件，僅郵件類型消息支持，其它類型消息不支持。 ### 參數： - url: *( DOMString ) 必選 *要添加的附件資源地址附件資源必須是本地文件，支持相對路徑及本地文件相對路徑格式。 ### 返回值： void : 無 ### 示例： ~~~ <!DOCTYPE html> <html> <head> <meta charset="utf-8"/> <meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no"/> <title>Messaging Example</title> <script type="text/javascript"> // 監聽plusready事件 document.addEventListener( "plusready", function(){ // 擴展API加載完畢，現在可以正常調用擴展API },false); // send mail function mailTest(){ var msg = plus.messaging.createMessage(plus.messaging.TYPE_MAIL); msg.to = ['service@dcloud.io']; msg.body = 'This is an example mail'; msg.addAttachment("_www/a.doc"); plus.messaging.sendMessage( msg ); } </script> </head> <body> <input type='button' onclick='mailTest();' value='Mail'/> </body> </html> ~~~ # [BodyType]() 消息體內容類型 ### 說明：用于設定消息的消息體內容。 # [MessageSendSuccessCallback]() 消息發送成功的回調函數 ~~~ void onSuccess() { // Send message success code. } ~~~ ### 參數：無 ### 返回值： void : 無 # [MessageErrorCallback]() 消息發送失敗的回調函數 ~~~ void onError( error ) { // Error code. } ~~~ ### 參數： - error: *( DOMException ) 必選 *失敗信息 ### 返回值： void : 無