diff -r 913c9751c067 -r 716254ccbcc0 org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-1A98E402-3609-4E83-A86C-98AB37025A47.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-1A98E402-3609-4E83-A86C-98AB37025A47.html Fri Mar 05 19:11:15 2010 -0800 @@ -0,0 +1,253 @@ + + +Criteria for +sending a message

Criteria for +sending a message

+

The criteria object specifies what type +of message to send and what the message details are.

+

The properties for this object are described in the following table. +Properties enclosed in brackets are optional.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table: Criteria object properties
+

Property

+
+

Description

+
+

Type

+
+

Value

+
+

criteria.MessageType

+
+

Specifies the type of message to send.

+
+

string

+
+

Possible values:

+
    +
  • "SMS"

  • +
  • "MMS"

  • +
+
+

criteria.To

+
+

Specifies the recipient of the message.

+

If you want to send the message to multiple recipients, use the MessageParam.To property. +You can also specify Cc and Bcc recipients with MessageParam.

+
+

string

+
 
+

[criteria.BodyText]

+
+

Specifies the body text of the message.

+
+

string

+
 
+

[criteria.Subject]

+
+

Specifies the subject of the message.

+

Note: This property is only valid for MMS. SMS does not support subject.

+
+
+

string

+
 
+

[criteria.Attachment]

+
+

Specifies the full path and file name of the attachment.

+

If you want to include multiple attachments to the message, use the MessageParam.AttachmentList property.

+

Note: This property is only valid for MMS. SMS does not support attachments.

+
+
+

string

+
 
+

[criteria.MimeType]

+
+

Specifies the MIME type of the attachment.

+
+

string

+
 
+

[criteria.MessageParam]

+
+

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.

+
+

object

+
+

Object with the properties specified below

+
+

[criteria.MessageParam.To]

+
+

Specifies the recipients of the message.

+

MessageParam.To[0] specifies the first recipient.

+
+

array of strings

+
 
+

[criteria.MessageParam.Cc]

+
+

Specifies the Cc recipients of the message.

+

MessageParam.Cc[0] specifies the first Cc recipient.

+
+

array of strings

+
 
+

[criteria.MessageParam.Bcc]

+
+

Specifies the Bcc recipients of the message.

+

MessageParam.Bcc[0] specifies the first Bcc recipient.

+

This property is only valid for email messages.

+

Note: The Messaging Service does not currently support emails.

+
+
+

array of strings

+
 
+

[criteria.MessageParam.TemplateId]

+
+

Specifies the ID of the message that is used as a template for the message +to be sent.

+

If both BodyText and MessageParam.TemplateId 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 BodyText appended +to the template body text.

+

+

+

number

+
 
+

[criteria.MessageParam.LaunchEditor]

+
+

If this property is set to "ETrue", the Message +Editor is opened over the Messaging Service application. This allows the user +to edit the message before sending it.

+

The default value is "EFalse".

+
+

boolean

+
+

Possible values:

+
    +
  • "ETrue"

  • +
  • "EFalse"

  • +
+
+

[criteria.MessageParam.AttachmentList]

+
+

Specifies the attachments to include in the message. For each attachment, +its full path and file name and optionally its MIME type are specified.

+

MessageParam.AttachmentList[0] specifies the first +attachment.

+

Note: This property is only valid for MMS. SMS does not support attachments.

+
+
+

array of objects

+
+

Each object in the array contains the properties specified below.

+
+

[criteria.MessageParam.AttachmentList[].FileName]

+
+

Specifies the full path and file name of an attachment.

+

This property is mandatory if the attachment is specified.

+
+

string

+
 
+

[criteria.MessageParam.AttachmentList[].MimeType]

+
+

Specifies the MIME type of an attachment.

+
+

string

+
 
\ No newline at end of file