Chapter 3 DynaScript Predefined Objects

mailList object

Object

Represents a list of mail pieces on a POP3 server.

Syntax

To use a mailList property:

mailList.propertyName

To use a mailList method:

mailList.MethodName( parameter ) 

Description

The mailList object is used to retrieve a list of the mail pieces on a POP3 server. The list, once returned, contains enough information for the user to sort through and select particular mail pieces for full retrieval.

To create a preview list of incoming mail piece objects, use the mailList constructor. The syntax to create a new mailList object is:

mailListObj = new MailList( popServer, popUser, popPassword, fullUserName [, useAPOP] );

The parameters are:

• popServer The name of the POP3 server.
• popUser The user ID for the POP3 server.
• popPassword The password for the POP3 server.
• fullUserName The full mail address.
• useAPOP If true, specifies that the POP3 APOP command should be used to log on to the POP3 server. If false, the POP3 commands USER and PASS are used--this causes your password to be sent as clear text. The default is true.

Example

This example returns a list of the mail pieces that are waiting for the user elmo. The list indicates where the message was sent from and the subject line of the message:

<!--SCRIPT 
mlist = new MailList ("mail.sybase.com", "elmo", "secret", "elmo@mail.sybase.com");
for ( i in mlist) {
    inPiece=mlist[i]
     document.writeln(inPiece.from);
    document.writeln(inPiece.subject);
}
-->

See also

"mailPiece object (incoming)"

"mailPiece object (outgoing)"

"attachment object"

count property

Syntax

mailList.count 

Attributes

This property is read-only.

Description

The number of messages in the mail list.

Return

Integer.

Example

This example displays the number of messages in the mail list.

<!--SCRIPT
mlist = new MailList ("mail.sybase.com", "elmo", "secret", "elmo@mail.sybase.com");
document.WriteLn(mlist);
document.WriteLn("There are " + mlist.count + " messages in the mail list");
-->

See also

"mailPiece object (incoming)".

"mailPiece object (outgoing)".

Copyright © 2001 Sybase, Inc. All rights reserved.