
    YAM2AmIRC - The interface for YAM and AmIRC
    ===========================================



· Introduction:
===============

I hate it to open YAM and look what kind of EMail arrived while I work
with AmIRC. I could of course set up filters that play certain sounds
on certain EMails, but still, I can't see whose EMail I got.

So I came to the idea of writing a little script that sends useful
information to the AmIRC window, letting me easily see who EMails come
from, without the need to open the YAM window.



· Features:
===========

- Display number of total/new/unread "Incoming" EMails in active AmIRC
    window. 
- Allows to set up patterns to match the "From" header and display the
    resulting emails.
- Plays a soundfile even when AmIRC is not active.
- Displaying of all New and Unread EMails in the Incoming folder.
- AmIRC interface to control YAM2AmIRC from within AmIRC, so you can at
    any time check your Incoming folder and even control YAM.
- Many configuration options, also for the sound player.
- Separate config file, no need to delete your old settings
    anymore when you update.



· Requires at least:
====================

- YAM2.0
- AmIRC2.0 (should work with earlier versions also)
- RexxMast active.
- Optionally a soundplayer or MultiView with a correct sound datatype.
- An Amiga computer, of course.



· Installation:
===============

- Copy YAM2AmIRC.rexx to the Rexx drawer within your YAM directory.

- Go to the YAM Config - New Mail - Notification - Command, and enter
    the following line:

    C:Run >NIL: SYS:Rexxc/Rx YAM:Rexx/YAM2AmIRC.rexx

    (Change the paths of Rx and YAM2AmIRC if neccesary)

- Start AmIRC and save the settings after entering the following line:

    /alias mail /rx YAM:Rexx/YAM2AmIRC.rexx 1 %p

    With that you can access YAM2AmIRC from within AmIRC.



· Configuration:
================

Once you have installed the script, you will have to set up a few basic
settings. Open the included YAM2AmIRC.cfg with your favourite text
editor (Ed, CygnusEd, Editpad, etc.). You can set up several variables
to your own needs:

- display & search

    Set these two variables according to the following:

    display=Y & search=Y   : Show Folder info and use search function.
    display=Y & search=N   : Show Folder info and all New/Unread EMails.
    display=N & search=Y/N : Display Folder info only.


- searchfor (Notify list)
    
    This variable includes the patterns you want the script to notify to
    you. If you use more than one pattern, seperate them with a space
    only.

    Please note that only New EMails in the "Incoming" folder will be
    checked.
    Also, this option is not relevant if the variable search is not set
    to "Y".

    Example:

    If you set the script to look for : ".de @infocanarias.com listserv@"

    You would be visually notified of emails like chatroom@yahoo.de ,
    Pfauder@infocanarias.com , listserv@mermaid.net ...

    Note:

    If you turn "Update Message Status" on (in YAM Config - New Mail)
    then YAM2AmIRC will inform only once about a new EMail you have on
    the notify list. If you turn it off then the EMail will always show
    as New, and therefore pop up every time YAM2AmIRC checks the Incoming
    folder. Review the YAM docs for more information.


- linelength

    Max. length of the line to be displayed in the AmIRC window (useful
    if your window is small, or big...). Default is 60 characters.


- playsound

    Set this to "Y" if you want to use the soundplay function.


- soundplayer & soundfile & playeroptions

    Specify the player you use, the soundfile and any options.

    Example:

    soundplayer = "C:Play16"
    soundfile = "YAM:INCOMING.WAV"
    playeroptions = "OUTPUT=Paula14"

    would do the same as:  "C:Play16 YAM:INCOMING.WAV Paula14"

    (Please let me know if you want this way of setting up being changed)


Please note that the YAM2AmIRC.cfg has to be placed in YAM:rexx/ .
If you placed it in another directory, edit YAM2AmIRC.rexx and change
the cfgfile variable to your needs.



· Usage:
========

Once it is installed, the script will activate every time you receive
new EMail.



· AmIRC Interface:
==================

You can control YAM2AmIRC from within AmIRC, once the script is
installed and the alias is set (see Installation). For that, you use the
/mail command:

    /mail            - Display only folder info.
    /mail new        - Display folder info and new pattern matching EMails.
    /mail all        - Display folder info and all new or unread EMails.
    /mail about      - Display author and support information.
    /mail help       - Display all available commands.
    /mail config     - Display actual pattern configuration.
    /mail open       - Uniconifies YAM or brings its window to front.
    /mail close      - Iconifies YAM.
    /mail check      - Tells YAM to check for new EMail.



· To do:
========

- MUI GUI for easy configuration of the settings (once I find out how
    to do it :)
- Perhaps an info window that outputs for itself (no need for AmIRC then)



· Contact:
==========

If you have suggestions, comments or bug reports, send them to:

Frank Meyer-Pfauder
EMail: Pfauder@infocanarias.com

Support Page: http://fmp-online.net/software/



· Disclaimer:
=============

This script is freeware. Feel free to give it away or copy it, but
please keep the files together, and don't delete my name from the
header ;)



· History:
==========

- v1.0    internal, first version.

- v1.1    internal, added linelength function and some minor bug fixes.

- v1.11   internal, made the script faster, changing some functions.

- v1.12   first public release, some minor optimizations and changes.

- v1.13   deleted an obsolete line. File is a little bit smaller.

- v1.2    made playback of soundfile optional, made pattern search
            optional, script now checks for correct setup, corrected
            line length bug, optimized code (much faster now).

- v1.21   again more optimized. Pattern comparing faster.

- v1.22   added port scan for AmIRC (thanks to Bossman^ for the advice).

- v1.23   changed the output a little bit. Minor changes to the manual.

- v2.0b   internal, rewritten code almost completely.
            Added optional displaying of all new EMails, interface to use
            YAM2AmIRC within AmIRC, sound player now configurable.

- v2.0    removed two bugs (only two, but bad ones...), changed the AmIRC
            display color (now set to 1 (Highlight)). Optimized a few
            lines.

- v2.1b   internal, changed config access to external file. Changed
            output a little bit.

- v2.1b2  fixed bug that would run the whole script even when YAM was not
            running. Added "about", "help" and "config" commands. Some
            minor optimizations.

- v2.1    removed debug lines. No other errors found.

- v2.11   internal, added code for future feature (not implemented yet in
            YAM).

- v2.12   added selection feedback to previously selected mail and some
            new output for AmIRC.

- v2.2    optimized the code (a few commands missing in the YAM previews).
            YAM2AmIRC now creates a temporary file in T: which
            saves much processing time when called within AmIRC.
            Now no case sensitivity anymore with patterns.
            Added german and spanish version to the release.

- v2.3    some mayor optimizations. YAM2AmIRC now doesn't review the whole
            list of EMails anymore when checking the list, it stops
            after all "New"-marked Emails marked are reviewed. Added
            "close" and "check" (by request) commands. Changed the code so
            now it is easy to do translations.  
