Home | Packages | Files | Procedures | Classes | Keywords | External packages
dele (mbox msgList) | ||
| Abstract method, deletes the specified messages from the mailbox. | ||
| Argument: mbox | Handle of the mailbox to modify. | |
| Argument: msgList | List of message ids. | |
lock (mbox) | ||
| Abstract method, locks the specified mailbox for exclusive access by a single connection. | ||
| Argument: mbox | Handle of the mailbox to lock. | |
| Returns: 1 if the mailbox was locked sucessfully, 0 else. | ||
size (mbox msgId) | ||
| Abstract method, determines the size of the given mail in the specified mailbox, in bytes. | ||
| Argument: mbox | Handle of the mailbox to | |
| Argument: msgId | Numerical index of the message to look at. | |
| Returns: size of the message in bytes. | ||
stat (mbox) | ||
| Abstract method, determines the number of mails in the specified mailbox. | ||
| Argument: mbox | Handle of the mailbox to look at. | |
| Returns: The number of messages in the mailbox | ||
transfer (args) | ||
| Abstract method, starts a (partial) transfer of the given message. Configured via a list of option/value-pairs, followed by the mailbox to look at, the numerical id of the message to transfer and the channel to sent the mail to, in this order. | ||
| Argument: args | List of option/value-pairs, followed by 3 arguments (explained in the method description). Recognized options are '-done' and '-lines'.&p The value of -done is interpreted as a script to call after completion of the transfer. Its specification is required. &p On the other hand, specification of -lines is optional. It is interpreted as the number of lines to transfer, beyond the usual message header. The complete message is transfered if it is not specified. | |
unlock (mbox) | ||
| Abstract method, revokes the lock on the specified mailbox. | ||
| Argument: mbox | Handle of the mailbox to unlock | |
Generated by AutoDoc 2.1 at 02/20/1999, invoked by Andreas Kupries