Dacons LLP Mailit for C/C++ Version 1.0.8

Emai::ImapResponseHandler Class Reference

This class contains the (virtual) functionality, which is supposed to process the responses returned by the server. More...

#include <EmaiIMAP.hpp>

List of all members.

Public Member Functions

virtual ~ImapResponseHandler ()

Protected Member Functions

virtual void ProcessResponse (const EmaiImapCommandData *inCommandData, const EmaiResponse &inResponse)
virtual void ProcessStatus (const EmaiImapCommandData *inCommandData, const EmaiStatusResponse &inResponse)=0
 Virtual function; Will be triggered when server returns a STATUS command response.
virtual void ProcessCapability (const EmaiCapabilityResponse &inResponse)=0
 Virtual function; Will be triggered when server returns a CAPABILITY command response.
virtual void ProcessList (const EmaiListResponse &inResponse)=0
 Virtual function; Will be triggered when server returns a LIST command response.
virtual void ProcessLsub (const EmaiLsubResponse &inResponse)=0
 Virtual function; Will be triggered when server returns a LSUB command response.
virtual void ProcessMailboxStatus (const EmaiMailboxStatusResponse &inResponse)=0
 Virtual function; Will be triggered when server returns a mailbox STATUS command response.
virtual void ProcessSearch (EmaiConstUniCharPtr inMailboxName, const EmaiSearchResponse &inResponse)=0
 Virtual function; Will be triggered when server returns a SEARCH command response.
virtual void ProcessFlags (EmaiConstUniCharPtr inMailboxName, const EmaiFlagsResponse &inResponse)=0
 Virtual function; Will be triggered when server returns a SELECT or EXAMINE commands response.
virtual void ProcessExists (EmaiConstUniCharPtr inMailboxName, const EmaiExistsResponse &inResponse)=0
 Virtual function; Will be triggered when server returns a EXISTS command response.
virtual void ProcessRecent (EmaiConstUniCharPtr inMailboxName, const EmaiRecentResponse &inResponse)=0
 Virtual function; Will be triggered when server returns a RECENT command response.
virtual void ProcessExpunge (EmaiConstUniCharPtr inMailboxName, const EmaiExpungeResponse &inResponse)=0
 Virtual function; Will be triggered when server returns a EXPUNGE command response.
virtual void ProcessFetch (EmaiConstUniCharPtr inMailboxName, const EmaiFetchResponse &inResponse)=0
 Virtual function; Will be triggered when server returns a FETCH command response.

Static Protected Member Functions

static void ProcessResponses (EmaiImapSession inSession, const EmaiImapCommandData *inCommandData, const EmaiResponse *inResponse, void *inUserData)

Friends

class ImapSession


Detailed Description

This class contains the (virtual) functionality, which is supposed to process the responses returned by the server.

See also:
EmaiEnumImapStatusResponseFlags

EmaiEnumImapStatusResponseTypes

EmaiStatusResponse

EmaiCapabilityResponse

EmaiMailboxStatusResponse

Definition at line 182 of file EmaiIMAP.hpp.


Member Function Documentation

virtual void Emai::ImapResponseHandler::ProcessStatus ( const EmaiImapCommandData inCommandData,
const EmaiStatusResponse inResponse 
) [protected, pure virtual]

Virtual function; Will be triggered when server returns a STATUS command response.

Parameters:
EmaiStatusResponse& inResponse - server response

Referenced by ProcessResponse().

virtual void Emai::ImapResponseHandler::ProcessCapability ( const EmaiCapabilityResponse inResponse  )  [protected, pure virtual]

Virtual function; Will be triggered when server returns a CAPABILITY command response.

Parameters:
EmaiCapabilityResponse& inResponse - server response

Referenced by ProcessResponse().

virtual void Emai::ImapResponseHandler::ProcessList ( const EmaiListResponse inResponse  )  [protected, pure virtual]

Virtual function; Will be triggered when server returns a LIST command response.

Parameters:
EmaiListResponse& inResponse - server response

Referenced by ProcessResponse().

virtual void Emai::ImapResponseHandler::ProcessLsub ( const EmaiLsubResponse inResponse  )  [protected, pure virtual]

Virtual function; Will be triggered when server returns a LSUB command response.

Parameters:
EmaiLsubResponse& inResponse - server response

Referenced by ProcessResponse().

virtual void Emai::ImapResponseHandler::ProcessMailboxStatus ( const EmaiMailboxStatusResponse inResponse  )  [protected, pure virtual]

Virtual function; Will be triggered when server returns a mailbox STATUS command response.

Parameters:
EmaiMailboxStatusResponse& inResponse - server response

Referenced by ProcessResponse().

virtual void Emai::ImapResponseHandler::ProcessSearch ( EmaiConstUniCharPtr  inMailboxName,
const EmaiSearchResponse inResponse 
) [protected, pure virtual]

Virtual function; Will be triggered when server returns a SEARCH command response.

Parameters:
EmaiSearchResponse& inResponse - server response

Referenced by ProcessResponse().

virtual void Emai::ImapResponseHandler::ProcessFlags ( EmaiConstUniCharPtr  inMailboxName,
const EmaiFlagsResponse inResponse 
) [protected, pure virtual]

Virtual function; Will be triggered when server returns a SELECT or EXAMINE commands response.

Parameters:
EmaiFlagsResponse& inResponse - server response

Referenced by ProcessResponse().

virtual void Emai::ImapResponseHandler::ProcessExists ( EmaiConstUniCharPtr  inMailboxName,
const EmaiExistsResponse inResponse 
) [protected, pure virtual]

Virtual function; Will be triggered when server returns a EXISTS command response.

Parameters:
EmaiSearchResponse& inResponse - server response

Referenced by ProcessResponse().

virtual void Emai::ImapResponseHandler::ProcessRecent ( EmaiConstUniCharPtr  inMailboxName,
const EmaiRecentResponse inResponse 
) [protected, pure virtual]

Virtual function; Will be triggered when server returns a RECENT command response.

Parameters:
EmaiRecentResponse& inResponse - server response

Referenced by ProcessResponse().

virtual void Emai::ImapResponseHandler::ProcessExpunge ( EmaiConstUniCharPtr  inMailboxName,
const EmaiExpungeResponse inResponse 
) [protected, pure virtual]

Virtual function; Will be triggered when server returns a EXPUNGE command response.

Parameters:
EmaiExpungeResponse& inResponse - server response

Referenced by ProcessResponse().

virtual void Emai::ImapResponseHandler::ProcessFetch ( EmaiConstUniCharPtr  inMailboxName,
const EmaiFetchResponse inResponse 
) [protected, pure virtual]

Virtual function; Will be triggered when server returns a FETCH command response.

Parameters:
EmaiFetchResponse& inResponse - server response

Referenced by ProcessResponse().


The documentation for this class was generated from the following file: