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.

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:

• MailInBoxLibraryVersion
• MailInBoxIsInError
• MailInBoxGetStatusReport
• MailInBoxClose

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

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