MailOutBoxIsInError

function

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

Returns: Returns true if the last operation on the MailOutBox resulted in an error, and false otherwise.


Declaration
define external switch function MailOutBoxIsInError
    value MailOutBox this-MailOutBox

Argument definitions

this-MailOutBox
is an OMX component of type MailOutBox


Purpose

This function returns true if the last operation on the MailOutBox 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 MailOutBoxIsInError MyBox