Difference between revisions of "COUNTMAIL()"

From Recital Documentation Wiki
Jump to: navigation, search
(Class)
Line 1: Line 1:
 
 
 
==Purpose==
 
==Purpose==
 
Function to return the number of messages on the currently connected mail server
 
Function to return the number of messages on the currently connected mail server
Line 37: Line 35:
  
 
==Products==
 
==Products==
Recital Database Server, Recital Mirage Server, Recital Terminal Developer
+
Recital Server, Recital  
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
[[Category:Mail]]
 
[[Category:Mail]]
 
[[Category:Mail Functions]]
 
[[Category:Mail Functions]]

Revision as of 16:26, 27 November 2009

Purpose

Function to return the number of messages on the currently connected mail server


Syntax

COUNTMAIL([<array>])


See Also

CLOSEMAIL(), DELETEMAIL(), MAILCLOSE(), MAILCOUNT(), MAILDELETE(), MAILERROR(), MAILHEADER(), MAILNODENAME(), MAILOPEN(), MAILREAD(), MAILSEND(), MAILUSERNAME(), OPENMAIL(), READMAIL(), SENDMAIL()


Description

The COUNTMAIL() function returns the number of messages on the connected mail server. If you are not connected to a mail server, it will return an error. You can use the MAILUSERNAME() (POP3 only) or MAILNODENAME() function to check if you are connected.


Parameters Required Default Description
<array> No None The name of an array to contain the size in bytes of each mail message. No pre-declaration is required.


Example

value = countmail(message_size)
? value
         6
? message_size[1]
       365


Products

Recital Server, Recital