IPWorks OpenPGP 2020 Node.js Edition

Questions / Feedback?

ExpungeMailbox Method

Removes all messages marked with 'Deleted' flag from the currently selected mailbox.

Syntax

pimap.expungeMailbox([callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information: 

err.code
err.message

Remarks

This method permanently removes all messages that have the 'Deleted' flag set from the current (selected) mailbox. Example (Set "Deleted" flag and Expunge)


IMAPControl.MessageSet = "1"
IMAPControl.AddMessageFlags("\Deleted")
IMAPControl.ExpungeMailbox()
Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks OpenPGP 2020 Node.js Edition - Version 20.0 [Build 8249]