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

MailInBoxGetMessageSize

 
 

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

Returns: The length of the message.


Declaration

define external integer function MailInBoxGetMessageSize
           value MailInBox this-MailInBox
  message value integer message

Argument definitions

this-MailInBox
is an OMX component of type MailInBox.
message
is the identification number of the message you want to know the size of.


Purpose

This function returns the length of the message indicated by number. A negative number will be returned if an error occurs.

Example:


  do when MailInBoxGetMessageSize MyBox message 1 < 1000000
  ...
  done

        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.