Skip to main content

Get-Mail-List

Command Description​

Get the email list of the inbox. The list is an array, and each element in it is an email

Command Prototype​

arrayRet = Mail.GetMailList(objMail, iCount)

Parameter Description​

ParameterRequiredTypeDefaultDescription
objMailTrueexpressionobjMailMailbox object, the mailbox object returned by the command Connect Mailbox (Mail.Connect)
iCountTruenumber0Set the number of emails to be retrieved. Set 0 to retrieve all emails in the inbox

return​

arrayRet，The variable used to save the output of the command.

Demo​

TracePrint("----------------------------Get mailing list------------------- ---------") 
//------------------------------------------------------------------------------- 
//[Remarks] Get the mail list in the inbox, the list is an array, and each item in the array is a mail object. 
//Input parameter 1: 
//      objMail--mailbox object. Note: Mailbox object, the mailbox object returned by the Mail.Connect command 
//      iCount--mail object. Note: Use the Get Mail List (Mail.GetMailList) command to return the mail object in the mail array 
//out parameters: 
//      arrayRet--The variable to which the output of the function call is saved. 
//Command prototype: arrayRet = Mail.GetMailList(objMail, iCount) 
arrayRet = Mail.GetMailList(objMail, 0) 
TracePrint(arrayRet)