Mercurial Mercurial > oss > FCL > sftools > dev > eclipseenv > wrttools / file revision
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-1A98E402-3609-4E83-A86C-98AB37025A47.html
author Eugene Ostroukhov <eugeneo@symbian.org>
Mon, 15 Mar 2010 17:36:40 -0700
changeset 267 a0f8d02facf1
parent 229 716254ccbcc0
permissions -rw-r--r--
Bug 2073 - On restart of WRT tools - its hard to know which project the open file is in


<!DOCTYPE html
  PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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
sending a message </title><script type="text/javascript">
      function initPage() {}
    </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
sending a message</h1><div>
<p>The <code>criteria</code> object specifies what type
of message to send and what the message details are.</p>
<p>The properties for this object are described in the following table.
Properties enclosed in brackets are optional.</p>
<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>

<thead align="left">
<tr class="title "><th class="cellrowborder" valign="top" width="25%" id="d0e59760">
<p>Property</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e59765">
<p>Description</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e59770">
<p>Type</p>
</th><th class="cellrowborder" valign="top" width="25%" id="d0e59775">
<p>Value</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
<p><code>criteria.MessageType</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
<p>Specifies the type of message to send.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">
<p>Possible values:</p>
<ul>
<li><p><code>"SMS"</code></p></li>
<li><p><code>"MMS"</code></p></li>
</ul>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
<p><code>criteria.To</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
<p>Specifies the recipient of the message.</p>
<p>If you want to send the message to multiple recipients, use the <code>MessageParam.To</code> property.
You can also specify Cc and Bcc recipients with <code>MessageParam</code>.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">&nbsp;</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
<p><code>[criteria.BodyText]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
<p>Specifies the body text of the message.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">&nbsp;</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
<p><code>[criteria.Subject]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
<p>Specifies the subject of the message.</p>
<div class="note"><p><strong class="note_title">Note: </strong>This property is only valid for MMS. SMS does not support subject.</p>
</div>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">&nbsp;</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
<p><code>[criteria.Attachment]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
<p>Specifies the full path and file name of the attachment.</p>
<p>If you want to include multiple attachments to the message, use the <code>MessageParam.AttachmentList</code> property.</p>
<div class="note"><p><strong class="note_title">Note: </strong>This property is only valid for MMS. SMS does not support attachments.</p>
</div>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">&nbsp;</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
<p><code>[criteria.MimeType]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
<p>Specifies the MIME type of the attachment.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">&nbsp;</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
<p><code>[criteria.MessageParam]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
<p>Specifies the full details of the message depending on its type. If
this is an MMS message, the body text is added as a text attachment.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
<p>object</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">
<p>Object with the properties specified below</p>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
<p><code>[criteria.MessageParam.To]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
<p>Specifies the recipients of the message.</p>
<p><code>MessageParam.To[0]</code> specifies the first recipient.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
<p>array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">&nbsp;</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
<p><code>[criteria.MessageParam.Cc]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
<p>Specifies the Cc recipients of the message.</p>
<p><code>MessageParam.Cc[0]</code> specifies the first Cc recipient.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
<p>array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">&nbsp;</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
<p><code>[criteria.MessageParam.Bcc]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
<p>Specifies the Bcc recipients of the message.</p>
<p><code>MessageParam.Bcc[0]</code> specifies the first Bcc recipient.</p>
<p>This property is only valid for email messages.</p>
<div class="note"><p><strong class="note_title">Note: </strong>The Messaging Service does not currently support emails.</p>
</div>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
<p>array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">&nbsp;</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
<p><code>[criteria.MessageParam.TemplateId]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
<p>Specifies the ID of the message that is used as a template for the message
to be sent.</p>
<p>If both <code>BodyText</code> and <code>MessageParam.TemplateId</code> are
specified, and if the template message already contains its own body text,
then both body text strings are included in the message when it is sent, with <code>BodyText</code> appended
to the template body text.</p>
<p/>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
<p>number</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">&nbsp;</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
<p><code>[criteria.MessageParam.LaunchEditor]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
<p>If this property is set to <code>"ETrue"</code>, the Message
Editor is opened over the Messaging Service application. This allows the user
to edit the message before sending it.</p>
<p>The default value is <code>"EFalse"</code>.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
<p>boolean</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">
<p>Possible values:</p>
<ul>
<li><p><code>"ETrue"</code></p></li>
<li><p><code>"EFalse"</code></p></li>
</ul>
</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
<p><code>[criteria.MessageParam.AttachmentList]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
<p>Specifies the attachments to include in the message. For each attachment,
its full path and file name and optionally its MIME type are specified.</p>
<p><code>MessageParam.AttachmentList[0]</code> specifies the first
attachment.</p>
<div class="note"><p><strong class="note_title">Note: </strong>This property is only valid for MMS. SMS does not support attachments.</p>
</div>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
<p>array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">
<p>Each object in the array contains the properties specified below.</p>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
<p><code>[criteria.MessageParam.AttachmentList[].FileName]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
<p>Specifies the full path and file name of an attachment.</p>
<p>This property is mandatory if the attachment is specified.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">&nbsp;</td>
</tr>
<tr class="">
<td class="cellrowborder" valign="top" width="25%" headers="d0e59760 ">
<p><code>[criteria.MessageParam.AttachmentList[].MimeType]</code></p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59765 ">
<p>Specifies the MIME type of an attachment.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59770 ">
<p>string</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="d0e59775 ">&nbsp;</td>
</tr>
</tbody>
</table></div></div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html>
FCL/sftools/dev/eclipseenv/wrttools