The Messaging API

4.1 SMS specific concerns

Note that there are size limitations for SMSs sent on a network (the actual maximum size depends on language encoding the content). When an SMS exceeds the maximum size the device may divide the SMS into several parts. This means that one SMS object may lead to sending several ones to the network (if the platform supports multi-part SMSs).

5.1 DeviceMessaging

The DeviceMessaging object is exposed on the navigator.device object, as defined in [CORE-DEVICE].

Device implements DeviceMessaging;

[NoInterfaceObject]
interface DeviceMessaging {
    readonly attribute MessagingManager messaging;
};

5.2 MessagingManager

This interface provides the general functionality that relates to messaging as well as the entry point for message creation and sending.

The Working Group plans in reworking this interface to rely more directly on URI schemes rather than having a per messaging protocol method.

interface MessagingManager {
    SMSMessage   createSMS (in SMSProperties smsProperties);
    MMSMessage   createMMS (in MMSProperties mmsProperties);
    EmailMessage createEmail (in EmailProperties emailProperties);
};

5.3 SMSMessage

This interface describes generic functionality of SMS message.

[NoInterfaceObject]
interface SMSMessage : SMSProperties {
    readonly attribute Date sentTime;
    PendingOp send (in MessagingSuccessCB successCB, in optional MessagingErrorCB errorCB);
};

5.4 MMSMessage

This interface describes generic functionality of MMS message.

[NoInterfaceObject]
interface MMSMessage : MMSProperties {
    readonly attribute Date sentTime;
    PendingOp send (in MessagingSuccessCB successCB, in optional MessagingErrorCB errorCB);
};

5.5 EmailMessage

This interface describes generic functionality of e-mail message.

[NoInterfaceObject]
interface EmailMessage : EmailProperties {
    readonly attribute Date sentTime;
    PendingOp send (in MessagingSuccessCB successCB, in optional MessagingErrorCB errorCB);
};

5.6 SMSProperties

This interface captures the data fields in an SMS message. See Supported Messaging Types for the list of attributes that must be supported for SMS type.

[NoInterfaceObject]
interface SMSProperties {
    attribute DOMString[] to;
    attribute DOMString   body;
};

5.7 MMSProperties

This interface captures the data fields in an MMS message. See Supported Messaging Types for the list of attributes that must be supported for MMS type.

[NoInterfaceObject]
interface MMSProperties {
    attribute DOMString[] to;
    attribute DOMString   subject;
    attribute DOMString   body;
    attribute Blob[]      attachments;
};

5.8 EmailProperties

This interface captures the data fields in an e-mail message. See Supported Messaging Types for the list of attributes that must be supported for e-mail type.

[NoInterfaceObject]
interface EmailProperties {
    attribute EmailAddress[] to;
    attribute EmailAddress[] cc;
    attribute EmailAddress[] bcc;
    attribute DOMString      subject;
    attribute DOMString      body;
    attribute DOMString      priority;
    attribute Blob[]         attachments;
};

5.9 EmailAddress

This interface captures the data fields in an e-mail address.

[NoInterfaceObject]
interface EmailAddress {
    attribute DOMString address;
    attribute DOMString name;
};

5.10 MessagingSuccessCB

[Callback=FunctionOnly, NoInterfaceObject]
interface MessagingSuccessCB {
    void onSuccess ();
};

5.11 MessagingErrorCB

[Callback=FunctionOnly, NoInterfaceObject]
interface MessagingErrorCB {
    void onError (in MessagingError error);
};

5.12 MessagingError

Adds Messaging API specific error codes.

The MessagingError interface encapsulates all errors in the manipulation of Messaging objects in the messaging API.

[NoInterfaceObject]
interface MessagingError : GenericError {
    const unsigned short UNKNOWN_ERROR = 0;
    const unsigned short INVALID_ARGUMENT_ERROR = 1;
    const unsigned short TIMEOUT_ERROR = 3;
    const unsigned short PENDING_OPERATION_ERROR = 4;
    const unsigned short IO_ERROR = 5;
    const unsigned short NOT_SUPPORTED_ERROR = 6;
    const unsigned short PERMISSION_DENIED_ERROR = 20;
    const unsigned short MESSAGE_SIZE_EXCEEDED = 30;
    readonly attribute unsigned short code;
};