About

This module was made from scratch to replace LsMail. I got frustrated that I still had modules that didn't use xPaintClass. So I decided to make a replacement for one of the last ones I had running: LsMail. Since I didn't even use the graphics part of the module I decided to make the module only use evars and events so it can display info on a label or something similar.

Currently AcidMail only support Pop3 and IMAP mailboxes, but in the future it will hopefully support secure connections aswell.

If you find anything that doesn't work please e-mail me (see Author). This read-me was made using Andymon's xDocs If there is anything wrong on this page please change it here.

Installation

Simply load it by putting *NetLoadModule AcidMail-<version> in your theme.rc or another .rc file.

*NetLoadModule AcidMail-1.0

You can also load it the old way by extracting the module manually to you $ModuleDir$ and then putting LoadModule "$ModulesDir$Acidmail.dll" in your step.rc.

LoadModule "$ModulesDir$Acidmail.dll"

Usage

Set-up a mailbox using *AcidMailbox then use AcidMailMailCmd and AcidMailNoMailCmd to show and hide a label which shows $AcidMailNumMail$. Check out the example for a complete working set-up. Ofcourse there are more advanced ways for showing info. See the events and evars below.

RC Settings

*AcidMailbox name type server(:port) username (password)
- name can be any name you like, for example "home" (you don't need quotes).
- type must be pop3 or imap (can be simap or spop3 in a later release hopefully).
- server is the address of your mail server, for example mail.server.com. You can also specify the port here behind a ":" for example mail.server.com:110. For Pop3 it defaults to 110 and for IMAP it defaults to 143.
- username is your user name, for example acidfire.
- password is your password. This setting is optional, if no password is found a dialog will pop up the first time asking for it. It's stored encrypted on your system.

AcidMailTimer 5
How often AcidMail should check for mail (in minutes). If this is 0 no timer will be set and all checking will have to be done manually.

Events

AcidMailMailCmd !none
Bang to be executed when there is mail and there was 0 mail before.

AcidMailNewMailCmd !none
Bang to be executed when there is new mail.

AcidMailNoMailCmd !none
Bang to be executed when you don't have any mail and there was mail before.

AcidMailFoundMailCmd !none
Bang fired if it finds mail, regardless of the value before.

AcidMailZeroMailCmd !none
Bang fired if it finds 0 mail even if there was 0 before checking.

AcidMailCheckMailCmd !none
Bang to be executed when AcidMail checks for new mail.

AcidMailDoneCheckCmd !none
Bang to be executed when AcidMail is done checking.

AcidMailErrorCmd !none
Bang to be executed if an error has occured.

!Bang Commands

!AcidMailCheckMail
Checks mail on all servers.

!AcidMailClearNew
Resets number of mails to 0 and runs NoMailCmd.

Exported Variables (evars)

$AcidMailNumMail$
Exports the number of mails found on last mailcheck.

$AcidMail<name>$
Exports the number of mails found for the defined mailbox.

Example Configuration

*AcidMailbox home pop3 mail.server.com acidfire
*AcidMailbox school imap studentweb.student.nl student1337357

AcidMailTimer 5

AcidMailMailCmd !LabelShow maillab
AcidMailNoMailCmd !LabelHide maillab

*Label Maillab
MaillabPaintingMode .singlecolor
MaillabColor 255 255 255
MaillabFontColor 0 0 0
MaillabFontHeight 21
MaillabX -31
MaillabY 20
MaillabWidth 30
MaillabHeight 21
MaillabStartHidden
MaillabOnLeftClick "$Email$"
MaillabOnRightClick !AcidMailClearNew
MaillabText "[exportedevar('AcidMailNumMail')]"
MaillabTooltip "home: [exportedevar('AcidMailHome')] school: [exportedevar('AcidMailSchool')]"

Still to be done:

- Support secure POP3 and IMAP.
- Real notifications instead of logging.

Version History

0.5: First version with IMAP support
- IMAP support.
- Huge code rewrite/reorganisation -> lots of small bugs fixed and more efficient and secure code.

0.3: First public beta
- Encrypted password storage: passwords no longer need to be in .rc files, a dialog will ask for them the first time.
- Added support for connecting to ports other than 110.
- Added support for connecting to an ip address.
- Removed AcidMailNoMessageBoxes, since there aren't any message boxes (yet).
- Made AcidMailErrorCmd work.
- Made ErrorHandler which posts errors in the logfile.
- Added AcidMailFoundMailCmd: fired if it finds mail, regardless of the value before.
- Added AcidMailZeroMailCmd: fired if it finds 0 mail even if there was 0 before checking.
- Misconfiguring *lines shouldn't crash AcidMail as easily as before.

0.2: Beta release
- Fixed !AcidMailClearNew not working.
- Disabled checking mail when timer is set to 0.

0.1: First beta release

Author

Author: Acidfire
Email: acidfire AT litestep DOT com

↑

ReadMe: AcidMail

Contents