MailInBoxOpen

function

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

Declaration
define external function MailInBoxOpen
 value MailInBox this-MailInBox
 autodel value switch autodel optional initial {false}

Argument definitions

this-MailInBox
is an OMX component of type MailInBox.
autodel
is an optional switch that, when set to true, will cause all messages in the mailbox to be deleted from the server when the mailbox is closed. When set to false, only those messages marked for deletion will be deleted when the mailbox is closed. The default value of this switch is "false"


Purpose

This function opens the MailInBox for reading.

Example:


  MailInBoxOpen MyBox autodel false