po-condition

The Imap interface defines a set of conditions that are signaled due to events in the interface. Each condition has an identifier which is a keyword which can be used in the handling code to identify the class of error. The accessor is po-condition-identifier. The identifiers are listed below.

All our conditions are po-condition or po-error (which is a subclass of po-condition).

A condition will have a server-string value if it is initiated by something returned by the server. The accessor is po-condition-server-string. It will have a format-control value (with the usual Common Lisp accessors) if there is something to display in response to identifiers used in conditions/errors.

The condition identifiers are:

• :problem: (a condition). The server responded with 'no' followed by an explanation. This means that something unusual happened and doesn't necessarily mean that the command has completely failed (but it might).
• :unknown-ok: (a condition). The server responded with an 'ok' followed by something that was not recognized. It is probably safe to ignore this.
• :unknown-untagged: (a condition). The server responded with some untagged command that was not recognized. It is probably ok to ignore this.
• :error-response: (an error). The command failed.
• :syntax-error: (an error). The data passed to a function in this interface was malformed.
• :unexpected: (an error). The server responded an unexpected way.
• :server-shutdown-connection: (an error). The server has shut down the connection, don't attempt to send any more commands to this connection, or even close it.
• :timeout: (an error). The server failed to respond within the timeout period.
• :response-too-large: (an error). The contents of a response is too large to store in a Lisp array.

See imap.htm for more information.

Copyright (c) 1998-2016, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.1 page.
Created 2010.1.21.