org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-1A98E402-3609-4E83-A86C-98AB37025A47.html
changeset 229 716254ccbcc0
equal deleted inserted replaced
228:913c9751c067 229:716254ccbcc0
       
     1 
       
     2 <!DOCTYPE html
       
     3   PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
       
     4 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><meta name="copyright" content="(C) Copyright 2009"/><meta name="DC.rights.owner" content="(C) Copyright 2009"/><meta name="DC.Type" content="mobileconcept"/><meta name="DC.Title" content="Criteria for sending a message"/><meta name="DC.Relation" scheme="URI" content="GUID-7C69DDA4-16F1-4A8F-BDB2-4CB0015B4E81"/><meta name="DC.Relation" scheme="URI" content="GUID-65AAF569-D347-462B-B59A-9D7CA184AB9C"/><meta name="DC.Relation" scheme="URI" content="GUID-91579EE5-A608-401C-82B4-DCF1723EC7B5"/><meta name="DC.Relation" scheme="URI" content="GUID-5295F092-004B-43F4-85DB-7C54ED14D6DB"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-1A98E402-3609-4E83-A86C-98AB37025A47"/><title>Criteria for
       
     5 sending a message </title><script type="text/javascript">
       
     6       function initPage() {}
       
     7     </script><link href="../PRODUCT_PLUGIN/book.css" rel="stylesheet" type="text/css"/><link href="css/s60/style.css" rel="stylesheet" type="text/css" media="all"/></head><body onload="initPage();"><div class="body"><div class="contentLeft prTxt"><h1 class="pageHeading" id="GUID-1A98E402-3609-4E83-A86C-98AB37025A47"><span>Criteria</span> for
       
     8 sending a message</h1><div>
       
     9 <p>The <code>criteria</code> object specifies what type
       
    10 of message to send and what the message details are.</p>
       
    11 <p>The properties for this object are described in the following table.
       
    12 Properties enclosed in brackets are optional.</p>
       
    13 <div class="tablenoborder"><a name="GUID-3DB08BE5-994A-451C-8934-B290D3E704BF"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-3DB08BE5-994A-451C-8934-B290D3E704BF" frame="border" border="1" rules="all"><caption><strong>Table: </strong><span>Criteria</span> object properties</caption>
       
    14 
       
    15 <thead align="left">
       
    16 <tr class="title "><th class="cellrowborder" valign="top" width="25%" id="d0e59760">
       
    17 <p>Property</p>
       
    18 </th><th class="cellrowborder" valign="top" width="25%" id="d0e59765">
       
    19 <p>Description</p>
       
    20 </th><th class="cellrowborder" valign="top" width="25%" id="d0e59770">
       
    21 <p>Type</p>
       
    22 </th><th class="cellrowborder" valign="top" width="25%" id="d0e59775">
       
    23 <p>Value</p>
       
    24 </th></tr>
       
    25 </thead>
       
    26 <tbody>
       
    27 <tr class="">
       
    28 <td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
       
    29 <p><code>criteria.MessageType</code></p>
       
    30 </td>
       
    31 <td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
       
    32 <p>Specifies the type of message to send.</p>
       
    33 </td>
       
    34 <td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
       
    35 <p>string</p>
       
    36 </td>
       
    37 <td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">
       
    38 <p>Possible values:</p>
       
    39 <ul>
       
    40 <li><p><code>"SMS"</code></p></li>
       
    41 <li><p><code>"MMS"</code></p></li>
       
    42 </ul>
       
    43 </td>
       
    44 </tr>
       
    45 <tr class="bg ">
       
    46 <td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
       
    47 <p><code>criteria.To</code></p>
       
    48 </td>
       
    49 <td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
       
    50 <p>Specifies the recipient of the message.</p>
       
    51 <p>If you want to send the message to multiple recipients, use the <code>MessageParam.To</code> property.
       
    52 You can also specify Cc and Bcc recipients with <code>MessageParam</code>.</p>
       
    53 </td>
       
    54 <td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
       
    55 <p>string</p>
       
    56 </td>
       
    57 <td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">&nbsp;</td>
       
    58 </tr>
       
    59 <tr class="">
       
    60 <td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
       
    61 <p><code>[criteria.BodyText]</code></p>
       
    62 </td>
       
    63 <td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
       
    64 <p>Specifies the body text of the message.</p>
       
    65 </td>
       
    66 <td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
       
    67 <p>string</p>
       
    68 </td>
       
    69 <td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">&nbsp;</td>
       
    70 </tr>
       
    71 <tr class="bg ">
       
    72 <td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
       
    73 <p><code>[criteria.Subject]</code></p>
       
    74 </td>
       
    75 <td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
       
    76 <p>Specifies the subject of the message.</p>
       
    77 <div class="note"><p><strong class="note_title">Note: </strong>This property is only valid for MMS. SMS does not support subject.</p>
       
    78 </div>
       
    79 </td>
       
    80 <td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
       
    81 <p>string</p>
       
    82 </td>
       
    83 <td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">&nbsp;</td>
       
    84 </tr>
       
    85 <tr class="">
       
    86 <td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
       
    87 <p><code>[criteria.Attachment]</code></p>
       
    88 </td>
       
    89 <td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
       
    90 <p>Specifies the full path and file name of the attachment.</p>
       
    91 <p>If you want to include multiple attachments to the message, use the <code>MessageParam.AttachmentList</code> property.</p>
       
    92 <div class="note"><p><strong class="note_title">Note: </strong>This property is only valid for MMS. SMS does not support attachments.</p>
       
    93 </div>
       
    94 </td>
       
    95 <td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
       
    96 <p>string</p>
       
    97 </td>
       
    98 <td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">&nbsp;</td>
       
    99 </tr>
       
   100 <tr class="bg ">
       
   101 <td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
       
   102 <p><code>[criteria.MimeType]</code></p>
       
   103 </td>
       
   104 <td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
       
   105 <p>Specifies the MIME type of the attachment.</p>
       
   106 </td>
       
   107 <td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
       
   108 <p>string</p>
       
   109 </td>
       
   110 <td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">&nbsp;</td>
       
   111 </tr>
       
   112 <tr class="">
       
   113 <td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
       
   114 <p><code>[criteria.MessageParam]</code></p>
       
   115 </td>
       
   116 <td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
       
   117 <p>Specifies the full details of the message depending on its type. If
       
   118 this is an MMS message, the body text is added as a text attachment.</p>
       
   119 </td>
       
   120 <td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
       
   121 <p>object</p>
       
   122 </td>
       
   123 <td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">
       
   124 <p>Object with the properties specified below</p>
       
   125 </td>
       
   126 </tr>
       
   127 <tr class="bg ">
       
   128 <td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
       
   129 <p><code>[criteria.MessageParam.To]</code></p>
       
   130 </td>
       
   131 <td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
       
   132 <p>Specifies the recipients of the message.</p>
       
   133 <p><code>MessageParam.To[0]</code> specifies the first recipient.</p>
       
   134 </td>
       
   135 <td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
       
   136 <p>array of strings</p>
       
   137 </td>
       
   138 <td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">&nbsp;</td>
       
   139 </tr>
       
   140 <tr class="">
       
   141 <td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
       
   142 <p><code>[criteria.MessageParam.Cc]</code></p>
       
   143 </td>
       
   144 <td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
       
   145 <p>Specifies the Cc recipients of the message.</p>
       
   146 <p><code>MessageParam.Cc[0]</code> specifies the first Cc recipient.</p>
       
   147 </td>
       
   148 <td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
       
   149 <p>array of strings</p>
       
   150 </td>
       
   151 <td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">&nbsp;</td>
       
   152 </tr>
       
   153 <tr class="bg ">
       
   154 <td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
       
   155 <p><code>[criteria.MessageParam.Bcc]</code></p>
       
   156 </td>
       
   157 <td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
       
   158 <p>Specifies the Bcc recipients of the message.</p>
       
   159 <p><code>MessageParam.Bcc[0]</code> specifies the first Bcc recipient.</p>
       
   160 <p>This property is only valid for email messages.</p>
       
   161 <div class="note"><p><strong class="note_title">Note: </strong>The Messaging Service does not currently support emails.</p>
       
   162 </div>
       
   163 </td>
       
   164 <td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
       
   165 <p>array of strings</p>
       
   166 </td>
       
   167 <td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">&nbsp;</td>
       
   168 </tr>
       
   169 <tr class="">
       
   170 <td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
       
   171 <p><code>[criteria.MessageParam.TemplateId]</code></p>
       
   172 </td>
       
   173 <td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
       
   174 <p>Specifies the ID of the message that is used as a template for the message
       
   175 to be sent.</p>
       
   176 <p>If both <code>BodyText</code> and <code>MessageParam.TemplateId</code> are
       
   177 specified, and if the template message already contains its own body text,
       
   178 then both body text strings are included in the message when it is sent, with <code>BodyText</code> appended
       
   179 to the template body text.</p>
       
   180 <p/>
       
   181 </td>
       
   182 <td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
       
   183 <p>number</p>
       
   184 </td>
       
   185 <td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">&nbsp;</td>
       
   186 </tr>
       
   187 <tr class="bg ">
       
   188 <td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
       
   189 <p><code>[criteria.MessageParam.LaunchEditor]</code></p>
       
   190 </td>
       
   191 <td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
       
   192 <p>If this property is set to <code>"ETrue"</code>, the Message
       
   193 Editor is opened over the Messaging Service application. This allows the user
       
   194 to edit the message before sending it.</p>
       
   195 <p>The default value is <code>"EFalse"</code>.</p>
       
   196 </td>
       
   197 <td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
       
   198 <p>boolean</p>
       
   199 </td>
       
   200 <td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">
       
   201 <p>Possible values:</p>
       
   202 <ul>
       
   203 <li><p><code>"ETrue"</code></p></li>
       
   204 <li><p><code>"EFalse"</code></p></li>
       
   205 </ul>
       
   206 </td>
       
   207 </tr>
       
   208 <tr class="">
       
   209 <td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
       
   210 <p><code>[criteria.MessageParam.AttachmentList]</code></p>
       
   211 </td>
       
   212 <td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
       
   213 <p>Specifies the attachments to include in the message. For each attachment,
       
   214 its full path and file name and optionally its MIME type are specified.</p>
       
   215 <p><code>MessageParam.AttachmentList[0]</code> specifies the first
       
   216 attachment.</p>
       
   217 <div class="note"><p><strong class="note_title">Note: </strong>This property is only valid for MMS. SMS does not support attachments.</p>
       
   218 </div>
       
   219 </td>
       
   220 <td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
       
   221 <p>array of objects</p>
       
   222 </td>
       
   223 <td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">
       
   224 <p>Each object in the array contains the properties specified below.</p>
       
   225 </td>
       
   226 </tr>
       
   227 <tr class="bg ">
       
   228 <td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
       
   229 <p><code>[criteria.MessageParam.AttachmentList[].FileName]</code></p>
       
   230 </td>
       
   231 <td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
       
   232 <p>Specifies the full path and file name of an attachment.</p>
       
   233 <p>This property is mandatory if the attachment is specified.</p>
       
   234 </td>
       
   235 <td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
       
   236 <p>string</p>
       
   237 </td>
       
   238 <td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">&nbsp;</td>
       
   239 </tr>
       
   240 <tr class="">
       
   241 <td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
       
   242 <p><code>[criteria.MessageParam.AttachmentList[].MimeType]</code></p>
       
   243 </td>
       
   244 <td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
       
   245 <p>Specifies the MIME type of an attachment.</p>
       
   246 </td>
       
   247 <td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
       
   248 <p>string</p>
       
   249 </td>
       
   250 <td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">&nbsp;</td>
       
   251 </tr>
       
   252 </tbody>
       
   253 </table></div></div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html>