|
|
              
QMessage Class ReferenceThe QMessage class provides a convenient interface for working with messages. More... #include <QMessage> Inherits QMessageContentContainer. Public Types
Public Functions
Static Public Members
Detailed DescriptionThe QMessage class provides a convenient interface for working with messages. QMessage supports a number of types. Including internet email messages, and the telephony types SMS and MMS. The QMessageId identifier for a message is returned by id(). Messages can be constructed by retrieval from the messaging store via their identifier using QMessageManager::message(). A QMessage can also be constructed piece by piece using functions such as setType(), setFrom(), setTo(), setSubject(), setBody() and appendAttachments(). If a message has been modified since it was last constructed isModified() returns true. A list of attachments identifiers will be returned by attachmentIds() and an identifier for the message body will be returned by bodyId(). Attachments can be appended to the content of the message using appendAttachments(), the body of the message can be set with setBody(). The folder and account a message is associated with are returned by parentFolderId() and parentAccountId() respectively. Message data that is less commonly accessed or relatively large should be lazily retrieved on demand by the associated getter function. Only phone numbers are valid destination addresses for SMS messages, only email addresses are valid destination addresses for Email messages, MMS messages may be addressed to either phone numbers or email addresses. See also QMessageContentContainer, QMessageManager, and QMessageId. Member Type Documentation
|
| Constant | Value | Description |
|---|---|---|
| QMessage::HighPriority | 1 | The message is high priority. |
| QMessage::NormalPriority | 2 | The message is normal priority. |
| QMessage::LowPriority | 3 | The message is low priority. |
enum QMessage::ResponseType
Defines the type of a response to an existing message.
| Constant | Value | Description |
|---|---|---|
| QMessage::ReplyToSender | 1 | A response to the sender of the existing message. |
| QMessage::ReplyToAll | 2 | A response to the sender of the existing message, and any other recipients of that message. |
| QMessage::Forward | 3 | A response created to copy the content of the existing message to a new recipient. |
enum QMessage::StandardFolder
Defines the standard folders.
| Constant | Value | Description |
|---|---|---|
| QMessage::InboxFolder | 1 | Represents the standard inbox folder. |
| QMessage::DraftsFolder | 3 | Represents the standard drafts folder. |
| QMessage::OutboxFolder | 2 | Represents the standard outbox folder. |
| QMessage::SentFolder | 4 | Represents the standard sent folder. |
| QMessage::TrashFolder | 5 | Represents the standard trash folder. |
enum QMessage::Status
flags QMessage::StatusFlags
flags QMessage::StatusFlags
This enum type is used to describe the status of a message.
| Constant | Value | Description |
|---|---|---|
| QMessage::Read | 0x1 | This flag indicates that the content of this message has been displayed to the user. |
| QMessage::HasAttachments | 0x2 | This flag indicates that the message contains at least one sub-part with 'Attachment' disposition. |
| QMessage::Incoming | 0x4 | This flag indicates that the message has been sent from an external source. |
| QMessage::Removed | 0x8 | This flag indicates that the message has been deleted from or moved on the originating server. |
The StatusFlags type is a typedef for QFlags<Status>. It stores an OR combination of Status values.
See also status() and setStatus().
enum QMessage::Type
flags QMessage::TypeFlags
flags QMessage::TypeFlags
This enum type is used to describe the type of a message.
| Constant | Value | Description |
|---|---|---|
| QMessage::NoType | 0 | The message type is not defined. |
| QMessage::Mms | 0x1 | The message is an MMS, Multimedia Messaging Service object. |
| QMessage::Sms | 0x2 | The message is an SMS, Short Message Service object. |
| QMessage::Email | 0x4 | The message is an Email, Internet Message Format object. |
| QMessage::InstantMessage | 0x8 | The message is an instant message object, such as XMPP. |
| QMessage::AnyType | 0xFFFFFFFF | Bitflag value that matches any message type defined. |
The TypeFlags type is a typedef for QFlags<Type>. It stores an OR combination of Type values.
Member Function Documentation
QMessage::QMessage ()
Constructs an empty message.
QMessage::QMessage ( const QMessageId & id )
Constructs a message from data stored in the messaging store with identifier id.
See also QMessageManager::message().
QMessage::QMessage ( const QMessage & other )
Constructs a copy of other.
QMessage::~QMessage () [virtual]
Destroys the message.
void QMessage::appendAttachments ( const QStringList & fileNames )
Append the contents of the files specified by fileNames to the end of the list of attachments for the message. The internet media (MIME) type of the attachments will be determined by examining the files or file names.
Symbian OS based devices have a limit for MMS message size. The message size limit varies between different devices, but is frequently 600 000 bytes. If the attachment size is greater than the limit then message sending will fail when QMessageService::send() is called.
See also attachmentIds() and clearAttachments().
QMessageContentContainerIdList QMessage::attachmentIds () const
Returns a list of attachment identifiers for the message.
The body of the message will not be included in the list.
See also appendAttachments() and clearAttachments().
QMessageAddressList QMessage::bcc () const
Returns the list of all the bcc (blind carbon copy) recipients specified for the message.
See also to(), cc(), and setBcc().
QMessageContentContainerId QMessage::bodyId () const
Returns the identifier for the body content contained by the Message if a body exists; otherwise returns an invalid identifier.
See also QMessageContentContainer and setBody().
QMessageAddressList QMessage::cc () const
Returns the list of all the cc (carbon copy) recipients specified for the message.
See also to(), bcc(), setCc(), and QMessageFilter::byRecipients().
void QMessage::clearAttachments ()
Clears the list of attachments for the message, leaving only the message body, if any.
See also attachmentIds() and appendAttachments().
QMessage QMessage::createResponseMessage ( ResponseType type ) const
Creates a new message as a response to this message, with properties predetermined according to type.
See also QMessageService::compose().
QDateTime QMessage::date () const
Returns the timestamp contained in the origination date header field of the message, if present; otherwise returns a null timestamp.
See also setDate() and QMessageFilter::byTimeStamp().
QMessageAddress QMessage::from () const
Returns the originating address of the message.
See also setFrom() and QMessageFilter::bySender().
QMessageId QMessage::id () const
Returns the identifier of the message.
See also QMessageFilter::byId().
bool QMessage::isModified () const
Returns true if the message has been modified since it was constructed; otherwise returns false.
QMessageAccountId QMessage::parentAccountId () const
Returns the identifier of the parent account of the message if any; otherwise returns an invalid identifier.
See also setParentAccountId().
QMessageFolderId QMessage::parentFolderId () const
Returns the identifier of the folder that contains the message if any; otherwise returns an invalid identifier.
QByteArray QMessage::preferredCharsetFor ( const QString & text ) [static]
Returns the first charset from the preferred list that is capable of encoding the content of text.
See also preferredCharsets() and setBody().
QList<QByteArray> QMessage::preferredCharsets () [static]
Returns an ordered-by-preference list of charset names to use when encoding unicode QString data to a serialized form.
See also setPreferredCharsets(), preferredCharsetFor(), and setBody().
Priority QMessage::priority () const
Returns the priority of the message.
The default is NormalPriority.
See also setPriority() and QMessageFilter::byPriority().
QDateTime QMessage::receivedDate () const
Returns the timestamp placed in the message during reception by the device, if present; otherwise returns a null timestamp.
See also setReceivedDate() and QMessageFilter::byReceptionTimeStamp().
void QMessage::setBcc ( const QMessageAddressList & bccList )
Set the list of bcc (blind carbon copy) recipients for the message to bccList.
See also bcc(), setTo(), and setCc().
void QMessage::setBody ( const QString & body, const QByteArray & mimeType = QByteArray() )
Sets the body text of the message to be the string body.
The internet media (MIME) content type of the body is set to mimeType, if provided. If the mimeType is not specified, the content type will default to "text/plain", and the encoding charset will be as determined by preferredCharsets().
See also bodyId() and preferredCharsets().
void QMessage::setBody ( QTextStream & in, const QByteArray & mimeType = QByteArray() )
Sets the body text of the message to be the text read from the stream in.
The internet media (MIME) content type of the body is set to mimeType, if provided. If the mimeType is not specified, the content type will default to "text/plain", and the encoding charset will be as determined by preferredCharsets().
See also bodyId() and preferredCharsets().
void QMessage::setCc ( const QMessageAddressList & ccList )
Set the list of cc (carbon copy) recipients for the message to ccList.
See also cc(), setTo(), and setBcc().
void QMessage::setDate ( const QDateTime & d )
Sets the origination date header field specifying the timestamp of the message to d.
See also date().
void QMessage::setFrom ( const QMessageAddress & address )
Sets the from address, that is the originating address of the message to address.
See also from().
void QMessage::setParentAccountId ( const QMessageAccountId & accountId )
Sets the parent account of the message to the account with identifier accountId.
This operation is only permitted on new messages that have not yet been inserted into the message store. Attempting to change the parent account of a message already in the message store will result in an error when attempting to update the message with QMessageStore::update().
See also parentAccountId().
void QMessage::setPreferredCharsets ( const QList<QByteArray> & charsetNames ) [static]
Sets the ordered-by-preference list of names of charsets to use when encoding unicode QString data to a serialized form to charsetNames.
The set of valid charset names is returned by QTextCodec::availableCodecs().
See also preferredCharsets(), preferredCharsetFor(), and setBody().
void QMessage::setPriority ( Priority newPriority )
Sets the priority of the message to newPriority.
See also priority().
void QMessage::setReceivedDate ( const QDateTime & d )
Sets the timestamp indicating the time of message reception by the device to d.
See also receivedDate().
void QMessage::setStatus ( StatusFlags newStatus )
Sets the status flags value for the message to newStatus.
See also status().
void QMessage::setStatus ( Status flag, bool set = true )
Sets the status flag flag for the message to have the value set.
See also status().
void QMessage::setSubject ( const QString & text )
Sets the subject of the message to text.
See also subject().
void QMessage::setTo ( const QMessageAddressList & toList )
Sets the list of primary recipients for the message to toList.
See also to().
void QMessage::setTo ( const QMessageAddress & address )
Sets the primary recipient for the message to address.
See also to().
void QMessage::setType ( Type t )
Sets the Type of the message to t.
The type of a message may be set for non-empty messages.
See also type().
int QMessage::size () const
Returns the complete size of the message as indicated on the originating server.
See also QMessageFilter::bySize().
StandardFolder QMessage::standardFolder () const
Returns the standard folder of the message.
Defaults to DraftsFolder.
StatusFlags QMessage::status () const
Returns the status flags value for the message.
See also setStatus() and QMessageFilter::byStatus().
QString QMessage::subject () const
Returns the subject of the message, if present; otherwise returns a null string.
See also setSubject() and QMessageFilter::bySubject().
QMessageAddressList QMessage::to () const
Returns the list of primary recipients for the message.
See also setTo() and QMessageFilter::byRecipients().
Type QMessage::type () const
Returns the Type of the message.
See also setType() and QMessageFilter::byType().