swirl Guide to OmniMark 5   OmniMark home
docs home 
IndexConceptsTasksSyntaxLibrariesOMX VariablesErrors
 
      Other Library Functions  
function   MailInBoxGetStatusReport    

Library: ommail - email support (SMTP and POP3)
Include: ommail.xin

Declaration

  define external function MailInBoxGetStatusReport
                  value MailInBox this-MailInBox
            into modifiable stream report


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.

Arguments:

Example:

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

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

Top [ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ OMX ] [ OMX ] [ ERRORS ]

Generated: August 11, 2000 at 3:07:31 pm
If you have any comments about this section of the documentation, send email to docerrors@omnimark.com

Copyright © OmniMark Technologies Corporation, 1988-2000.