examineMailbox method

Future<Mailbox> examineMailbox(
  1. Mailbox box, {
  2. bool enableCondStore = false,
  3. QResyncParameters? qresync,
})

Examines the box without selecting it.

Set enableCondStore to true if you want to force-enable CONDSTORE. This is only possible when the CONDSTORE or QRESYNC capability is supported. Specify qresync parameter in case the server supports the QRESYNC capability and you have known values from the last session. Note that you need to ENABLE QRESYNC first. Also compare: statusMailbox(Mailbox, StatusFlags) The EXAMINE command is identical to SELECT and returns the same output; however, the selected mailbox is identified as read-only. No changes to the permanent state of the mailbox, including per-user state, are permitted; in particular, EXAMINE MUST NOT cause messages to lose the \Recent flag.

Implementation

Future<Mailbox> examineMailbox(Mailbox box,
    {bool enableCondStore = false, QResyncParameters? qresync}) {
  return _selectOrExamine('EXAMINE', box,
      enableCondStore: enableCondStore, qresync: qresync);
}