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

Return type: Switch 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

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:

• MailInBoxGetStatusReport
• MailInBoxIsInError
• MailOutBoxGetStatusReport
• MailOutBoxIsInError
• MailLibraryVersion
• MailIsVersionCompatible

Example:

  halt when MailInBoxIsInError MyBox

Other Library Functions MailInBox MailInBoxClose MailInBoxCreate MailInBoxGetMessage MailInBoxGetMessageSize MailInBoxGetNumberOfMessages MailInBoxGetStatusReport MailInBoxIsInError MailInBoxIsOpen MailInBoxMarkAllMessagesForDeletion MailInBoxMarkMessageForDeletion MailInBoxOpen MailInBoxResetDeletionFlags MailIsVersionCompatible MailLibraryVersion MailOutBox MailOutBoxCreate MailOutBoxGetStatusReport MailOutBoxIsInError MailOutBoxSendMail

[ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACY LIBRARIES ] [ ERRORS ]