qtmobility/src/messaging/qmessage.cpp
changeset 4 90517678cc4f
parent 1 2b40d63a9c3d
child 8 71781823f776
equal deleted inserted replaced
1:2b40d63a9c3d 4:90517678cc4f
    63     \brief The QMessage class provides a convenient interface for working with messages.
    63     \brief The QMessage class provides a convenient interface for working with messages.
    64     
    64     
    65     \ingroup messaging
    65     \ingroup messaging
    66    
    66    
    67     QMessage supports a number of types. Including internet email messages, 
    67     QMessage supports a number of types. Including internet email messages, 
    68     the telephony types SMS and MMS, and also XMPP messages.
    68     and the telephony types SMS and MMS.
    69      
    69      
    70     The QMessageId identifier for a message is returned by id(). Messages can be constructed by 
    70     The QMessageId identifier for a message is returned by id(). Messages can be constructed by 
    71     retrieval from the messaging store via their identifier using QMessageManager::message(). A 
    71     retrieval from the messaging store via their identifier using QMessageManager::message(). A 
    72     QMessage can also be constructed piece by piece using functions such as 
    72     QMessage can also be constructed piece by piece using functions such as 
    73     setType(), setFrom(), setTo(), setSubject(), setBody() and appendAttachments(). 
    73     setType(), setFrom(), setTo(), setSubject(), setBody() and appendAttachments(). 
    84     Message data that is less commonly accessed or relatively large should be lazily retrieved 
    84     Message data that is less commonly accessed or relatively large should be lazily retrieved 
    85     on demand by the associated getter function.
    85     on demand by the associated getter function.
    86         
    86         
    87     Only phone numbers are valid destination addresses for SMS messages, only email addresses are valid
    87     Only phone numbers are valid destination addresses for SMS messages, only email addresses are valid
    88     destination addresses for Email messages, MMS messages may be addressed to either phone numbers
    88     destination addresses for Email messages, MMS messages may be addressed to either phone numbers
    89     or email addresses. Only XMPP addresses are valid destination addresses for XMPP messages.
    89     or email addresses.
    90     
    90     
    91     \sa QMessageContentContainer, QMessageManager, QMessageId
    91     \sa QMessageContentContainer, QMessageManager, QMessageId
    92 */
    92 */
    93 
    93 
    94 /*!
    94 /*!
    95     \enum QMessage::Type
    95     \enum QMessage::Type
    96 
    96 
    97     This enum type is used to describe the type of a message.
    97     This enum type is used to describe the type of a message.
    98     
    98     
    99     \value NoType   The message type is not defined.
    99     \value NoType             The message type is not defined.
   100     \value Mms      The message is an MMS, Multimedia Messaging Service object.
   100     \value Mms                The message is an MMS, Multimedia Messaging Service object.
   101     \value Sms      The message is an SMS, Short Message Service object.
   101     \value Sms                The message is an SMS, Short Message Service object.
   102     \value Email    The message is an Email, Internet Message Format object.
   102     \value Email              The message is an Email, Internet Message Format object.
   103     \value Xmpp     The message is an XMPP, Extensible Messaging and Presence Protocol object.
   103     \value InstantMessage     The message is an instant message object, such as XMPP.
   104     \value AnyType  Bitflag value that matches any message type defined.
   104     \value AnyType            Bitflag value that matches any message type defined.
   105     
   105     
   106     \sa type(), setType()
   106     \sa type(), setType()
   107 */
   107 */
   108     
   108     
   109 /*!
   109 /*!
   236 /*!
   236 /*!
   237     \fn QMessage::standardFolder() const
   237     \fn QMessage::standardFolder() const
   238   
   238   
   239     Returns the standard folder of the message.
   239     Returns the standard folder of the message.
   240     
   240     
   241     Defaults to InboxFolder.
   241     Defaults to DraftsFolder.
   242 */
   242 */
   243     
   243     
   244 /*!
   244 /*!
   245     \fn QMessage::from() const
   245     \fn QMessage::from() const
   246   
   246