Please clarify docs

[ile]

This seems unclear:

If idle() is called manually then it does not return until IDLE is finished which means you would have to call some other command out of scope.

What does this mean: "you would have to call some other command out of scope"? When does the idle() return exactly?

Maybe clarify the docs?

Thanks.

[andris9]

It's an async issue.

await connection.idle()
// this line is never reached because the idle never completes

vs

setTimeout(()=>{
  connection.noop();
}, 10*1000);
await connection.idle()
// this line is reached after 10 seconds because executing another IMAP operation will terminate the pending IDLE

ImapFlow only exists for EmailEngine, so I haven't paid too much attention to docs or examples.

[ile]

Ok, thanks! "Out of scope" was a bit confusing - it seems it's just when another IMAP operation is called during IDLE.