Other Library Functions

MailInBoxGetStatusReport

function

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

Declaration 
define external function MailInBoxGetStatusReport
                value MailInBox this-MailInBox
          into write-only string report

Argument definitions

this-MailInBox
is an OMX component of type MailInBox.
report
is the string shelf in which the error messages are stored.


Purpose

If the MailInBox is not in error, this function clears the report shelf; if the MailInBox is in error, the function populates the report shelf with one or more error messages (each as an item on the shelf).

MailInBoxGetStatusReport can be called at any time, but will return an empty report shelf if there is no error.

Example:


  MailInBoxGetStatusReport MyBox into report
  repeat over report
     put #error report
  again

Other Library Functions