IPWorks OpenPGP 2020 Kotlin Edition

Questions / Feedback?

IdleInfo Event

Fires whenever responses from the server are received while idling.

Syntax

public open class DefaultPimapEventListener : PimapEventListener {
  ...
  public override fun idleInfo(e: PimapIdleInfoEvent) {}
  ...
}

public class PimapIdleInfoEvent {
  val message: String?
  var cancel: Boolean
}

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

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks OpenPGP 2020 Kotlin Edition - Version 20.0 [Build 7941]