JS - Message/Email Functions

countemail #

How many emails a user has.

• Arguments: None
• Returns:
  • Integer: The number of emails

enteremail #

Enter an email to a user.

NOTE: this does not check if a_string1 exists as a valid user. Be sure to check that first.

• Arguments:
  • String: The recipient's username
  • String: The subject

getarea #

Gets the name of the currently selected message base.

• Arguments: None
• Returns:
  • String: The name of the currently selected message base

getmsglr #

Returns the user's last read message in the current message base.

• Arguments: None
• Returns:
  • Integer: The last read message id

getmsgtot #

Returns the total number of messages in the current message base.

• Arguments: None
• Returns:
  • Integer: The number of messages in the area.

listemail #

List a user's private email

• Arguments: None
• Returns: None

listmsgs #

Displays a list of messages in the currently selected message base.

• Arguments:
  • Integer: The msgid to start at.
• Returns: None

postsmsg #

Posts a message into the messagebase defined

• Arguments:
  • String: The filename (without extension) of the message base
  • String: The "To" field
  • String: The "From" field
  • String: The "Subject" field
  • String: The message body (note, new lines are denoted with a carriage return only)

readmsg #

Returns an object representing a message, if the requested msgid does not exist (eg. it was deleted) returns the next message, or undefined if there is no next message.

• Arguments:
  • String: filename (without extension) of the message base
  • Integer: The message id
• Returns:
  • Object: An object representing the message or undefined.

Example:

{
  "idx": 1,
  "from": "The Sysop",
  "to": "A User",
  "subject": "Stuff",
  "body": "Blah Blah\rMore Blah"
}

readmsgs #

Displays messages in the currently selected message base.

• Arguments:
  • Integer: The msgid to start at.
• Returns: None

scanbases #

List message bases with unread and message totals.

• Arguments: None
• Returns: None

selectarea #

Allow the user to select (change) the current message base.

• Arguments: None
• Returns: None

selectgroup #

Allow the user to select (change) the current message group.

• Arguments: None
• Returns: None

unreademail #

How many unread emails a user has

• Arguments: None
• Returns:
  • Integer: The number of unread emails

writemsg #

Write a message in the currently selected message base, first asking to, subject and destination then launching the editor.

• Arguments: None
• Returns: None