MailInBoxIsInError

function

Library: Email support, SMTP and POP3 (OMMAIL)
Include: ommail.xin

Returns: True or false.


Declaration
define external switch function MailInBoxIsInError
                value MailInBox this-MailInBox

Argument definitions

this-MailInBox
is an OMX component of type MailInBox


Purpose

This function returns true if the last operation on the MailInBox resulted in an error, and false otherwise.

Note that any function in the Mail library can result in an error, except the following:

Example:


  halt when MailInBoxIsInError MyBox