QMailNewEmailHandler Class Reference
[QtMessagingModule]

Detailed Description

The QMailNewEmailHandler class provides a convenient interface for responding to new email arrival notifications emitted by the message server.

When a new email is retrieved by the message server, the NewEmailArrival::arrived(QDSActionRequest) service request is emitted. If a process registers to handle this request and instantiates a QMailNewEmailHandler object, the handler object will process the service request and emit the newCountChanged() signal.

In response to the newCountChanged() signal, the handler process should invoke the setHandled() slot, to communicate whether or not they have handled the event to the message server. If any handler process reports the event as handled, then the count of new email messages will be reset, and those messages will have the QMailMessage::New status flag unset.

Note: if a process instantiates a QMailNewEmailHandler, it will not do anything unless the process is also registered to handle the NewEmailArrival service.

Member Function Documentation

QMailNewEmailHandler::QMailNewEmailHandler ( QObject * parent = 0 )

Constructs a new handler for the NewEmailArrival service, with the specified parent.

QMailMessage::MessageType QMailNewEmailHandler::messageType () const   [virtual]

Returns QMailMessage::Email, the type of messages handled by QMailNewEmailHandler.

Reimplemented from QMailNewMessageHandler.