Alertra Script Language 1.9

[next]  [language reference]  [table of contents]

imap4

Interacts with an IMAP4 server to perform the following functions: connect, message count, and clearing messages.

usage: imap4 [operation] [user] [password] [options]

parameters:

req name type description
Y operation keyword One of:
  • connect: Initiates a connection to the IMAP server
  • msgcount: Returns the current number of messages in the mailbox; count is placed in $CONTENT.
  • clear: Tells the IMAP server to delete all the messages in the mailbox
Y user expression Login ID of user's mailbox
Y password expression Password for the user's mailbox
N options list Available options are:
  • ssl Use secure connection (SSL)

examples

imap4 connect "joe" "garage"

Establishes a connection to the server and logs in.

imap4 msgcount $USER $PASS

Assuming $USER contains "jack" and $PASS contains "beanstalk", this command will log into the IMAP4 server, query it for current number of messages in the inbox and place that number in $CONTENT.

imap4 clear "jill" "beanstalk"

Logs into the IMAP4 server and deletes all the messages in the account's inbox.

imap4 connect "joe" "garage" ssl

Establishes a secure connection to the server and logs in.

Alertra Script Language: Language Reference