IdleInfo Event

Fires whenever responses from the server are received while idling.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
virtual int FireIdleInfo(PIMAPIdleInfoEventParams *e);

typedef struct {
  const char *Message;
  int Cancel;
  int reserved;
} PIMAPIdleInfoEventParams;

Unicode (Windows)
virtual INT FireIdleInfo(PIMAPIdleInfoEventParams *e);

typedef struct {
  LPCWSTR Message;
  BOOL Cancel;
  INT reserved;
} PIMAPIdleInfoEventParams;

- (void)onIdleInfo:(NSString*)message :(int*)cancel;

#define EID_PIMAP_IDLEINFO 5

virtual INT IPWORKSOPENPGP_CALL FireIdleInfo(LPSTR &lpszMessage, BOOL &bCancel);

Remarks

This event fires each time a response is received from the server after calling StartIdle. This will fire with information from the server intended to update the client. The type of data sent by the server may vary.

Message holds the response received from the server.

Cancel may be set to stop idling from within the event. This is equivalent to calling StopIdle.

Some possible values returned by the server are:

+ idling
* 43 EXISTS
* 1 RECENT