QMailMessageServer Class Reference
[QtMessagingModule, QtPimModule]

Server Status

As the MessageServer application performs the operations requested of it, it indicates the tasks it is performing by emitting the statusChanged() signal. If it encounters an error that prevents an operation from being performed, the errorOccurred() signal is emitted.

See also QMailServiceAction, QMailMessage, and QtopiaIpcAdaptor.

Member Type Documentation

enum QMailMessageServer::ErrorCode

This enum type defines error codes emitted by the MessageServer application.

enum QMailMessageServer::Operation

This enum type is used to indicate the type of server operation to which a status notification relates.

Member Function Documentation

QMailMessageServer::QMailMessageServer ( QObject * parent = 0 )

Constructs a QMailMessageServer object with parent parent, and initiates communication with the MessageServer application.

QMailMessageServer::~QMailMessageServer ()

Destroys the QMailMessageServer object.

void QMailMessageServer::acknowledgeNewMessages ( const QMailMessageTypeList & types )   [slot]

Requests that the MessageServer reset the counts of 'new' messages to zero, for each message type listed in types.

See also newCountChanged().

void QMailMessageServer::cancelSearch ()   [slot]

Requests that the MessageServer cancel any pending search operations.

void QMailMessageServer::cancelTransfer ()   [slot]

Requests that the MessageServer cancel any pending transfer operations.

See also send(), retrieve(), and completeRetrieval().

void QMailMessageServer::completeRetrieval ( const QMailMessageIdList & mailList )   [slot]

Requests that the MessageServer complete the retrieval process for the messages in mailList. If the list contains messages from multiple accounts, only those from the account associated with the first message in the list will be retrieved.

See also partialRetrievalCompleted() and retrievalCompleted().

void QMailMessageServer::deleteMessages ( const QMailMessageIdList & mailList )   [slot]

Requests that the MessageServer delete the messages in mailList from the external server, if necessary for the relevant message type.

Deleting messages using this slot does not initiate communication with any external server; instead the information needed to delete the messages is recorded. Deletion from the external server will occur when messages are next retrieved from that server. Invoking this slot does not remove a message from the mail store.

See also QMailStore::removeMessage().

void QMailMessageServer::errorOccurred ( const QMailAccountId & accountId, const QString & text, int errorCode )   [signal]

Emitted when the MessageServer encounters an error while performing an action relating to the account with id accountId. The error is described by text and errorCode.

See also statusChanged().

void QMailMessageServer::matchingMessageIds ( const QMailMessageIdList & ids )   [signal]

Emitted after the successful completion of a search operation; ids contains the list of message identifiers located by the search.

See also searchMessages().

void QMailMessageServer::messageRetrieved ( const QMailMessageMetaData & message )   [signal]

Emitted when message has been retrieved from the external server. message is delivered in meta-data-only form, since the size of the entire message may be prohibitive.

See also retrieve().

void QMailMessageServer::messageSent ( const QMailMessageId & id )   [signal]

Emitted when the message identified by id has been transmitted to the external server.

See also send().

void QMailMessageServer::newCountChanged ( const QMailMessageCountMap & counts )   [signal]

Emitted when the count of 'new' messages changes; the new count is described by counts.

See also acknowledgeNewMessages().

void QMailMessageServer::partialMessageRetrieved ( const QMailMessageMetaData & message )   [signal]

Emitted when message has been partially retrieved from the external server. message is delivered in meta-data-only form, since the remainder of the message has not yet been retrieved from the server.

See also retrieve() and completeRetrieval().

void QMailMessageServer::partialRetrievalCompleted ()   [signal]

Emitted when all new messages have been partially retrieved.

See also retrieve().

void QMailMessageServer::retrievalCompleted ()   [signal]

Emitted when a retrieval operation is completed.

See also retrieve().

void QMailMessageServer::retrievalProgress ( uint value )   [signal]

Emitted during a retrieval operation; value reports the progress of the current retrieval operation.

See also retrievalTotal() and retrieve().

void QMailMessageServer::retrievalTotal ( uint total )   [signal]

Emitted when a retrieval operation is initiated; total indicates the extent of the retrieval operation to be performed.

See also retrievalProgress() and retrieve().

void QMailMessageServer::retrieve ( const QMailAccountId & id, bool foldersOnly )   [slot]

Requests that the MessageServer retrieve any new messages from the account with id id. If foldersOnly is true, only the folder structure of the account will be retrieved from the external service.

See also retrievalCompleted().

void QMailMessageServer::searchCompleted ()   [signal]

Emitted when a search operation is completed.

See also send().

void QMailMessageServer::searchMessages ( const QMailMessageKey & filter, const QString & bodyText )   [slot]

Requests that the MessageServer search for messages that meet the criteria encoded in filter. If bodyText is non-empty, messages must also contain the specified text in their content to be considered matching. If the content of a message is not stored locally, the MessageServer may connect to the originating server to request a content search, if necessary.

The identifiers of all matching messages are returned via matchingMessageIds() after the search is completed.

See also matchingMessageIds().

void QMailMessageServer::searchProgress ( uint value )   [signal]

Emitted during a search operation; value reports the progress of the current search operation.

See also searchTotal() and searchMessages().

void QMailMessageServer::searchTotal ( uint total )   [signal]

Emitted when a search operation is initiated; total indicates the extent of the search operation to be performed.

See also searchProgress() and searchMessages().

void QMailMessageServer::send ( const QMailMessageIdList & mailList )   [slot]

Sends the messages in mailList to the MessageServer application for transmission.

See also sendCompleted().

void QMailMessageServer::sendCompleted ()   [signal]

Emitted when a send operation is completed.

See also send().

void QMailMessageServer::sendProgress ( uint value )   [signal]

Emitted during a send operation; value reports the progress of the current send operation.

See also sendTotal() and send().

void QMailMessageServer::sendTotal ( uint total )   [signal]

Emitted when a send operation is initiated; total indicates the extent of the send operation to be performed.

See also sendProgress() and send().

void QMailMessageServer::statusChanged ( QMailMessageServer::Operation operation, const QString & accountName, const QString & text )   [signal]

Emitted whenever the MessageServer performs an action that may be of interest to the client. The server status is described by text, and relates to operation performed on the account named accountName.

See also errorOccurred().