info.mailtraq.com > Management > Script Functions A-Z > GetMailboxProp() GetMailboxProp()Returns properties of mailslot objects in the Console. Certain properties apply only to certain types of mailslot.
result := GetMailboxProp( mailslot , property )
- mailslot
- A string consisting of the mailslot name for which a property is required
- property
- A string referencing the required property. See below for available values.
- result
- A string consisting of the property or nul if mailslot
- doesn't exist or if the specified property is not relevant
Property
| Property Description |
Type
| Returns the object class of the mailslot as a string; one of "MAILBOX", "LIST", "ARCHIVE", "GROUP" |
Description
| Returns the contents of the Name/Description field of the mailslot as a string |
Mailgroup
| Returns the name of the Mail Group to which the mailslot belongs as a string |
Secure
| Returns "TRUE" if Subscriber Passwords are required for a Mailing List, otherwise "FALSE". |
Maintainer
| Returns the address in the Maintainer field of a Mailing List as a string. |
Example usage: If the specified mailslot is a mailing list and requires subscriber passwords, store the maintainer address in a variable mbox := "program-announce";
If(GetMailboxProp(mbox, "Type") = "LIST",
If(GetMailboxProp(mbox, "Secure"),
var := GetMailboxProp(mbox, "Maintainer")
)
)
See also the example provided in GetFieldOfDirectory() |