swirl
Guide to OmniMark 8   OmniMark home
docs home 
IndexConceptsTasksSyntaxLibrariesLegacy LibrariesErrors
 
      Other Library Functions  
function  

MailInBoxGetMessage

 
 

Library: Email support, SMTP and POP3 (OMMAIL)
Include: ommail.xin
Return type: String source

Returns: An external source object.


Declaration

define external string source function MailInBoxGetMessage
          value MailInBox this-MailInBox
 message value integer message

Argument definitions

this-MailInBox
is an OMX component of type MailInBox.
message
is the identification number for the message you wish to retrieve.


Purpose

This function returns an external source for reading a message identified by number.

Note that during the lifetime of the source, it is a fatal error to try to pass the MailInBox object to any library calls other than:

The MailInBoxClose causes the source to be terminated. This does not prohibit you from creating another MailInBox and doing what you wish with it, although many server implementations will not permit multiple connections to the same mailbox.

Example:


  set this-msg to MailInBoxGetMessage MyBox message 1

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

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

OmniMark 8.2.0 Documentation Generated: March 13, 2008 at 3:27:39 pm
If you have any comments about this section of the documentation, please use this form.

Copyright © Stilo International plc, 1988-2008.