@database YGM.guide @$VER: YGM.guide 2.23 (30.4.2002) @wordwrap on @(C) Copyright © 1999-2002 Stefan Falke @author Stefan Falke @node "main" "YGM User Guide" @{b} YGM 2.7 (2.5.2002) Copyright © 1999-2002 by Stefan Falke. All Rights Reserved. ================================== User Guide ================================== @{ub} @{" LEGALESE " LINK legl} Important things first! @{" Introduction " LINK intr} What's it for? @{" Requirements " LINK reqr} What you need. @{" Installation " LINK inst} Where do I put things? @{" Usage " LINK usag} How do I do it? @{" Examples " LINK xmpl} For those who never RTFMs. @{" Security Notes " LINK note} Didn't your mama tell you not to trust old men? @{" Author " LINK auth} Who wrote this? @{" Feedback " LINK feed} It's your turn now. @{" Acknowledgements " LINK crdt} Thank you, thank you so much. @{" Version History " LINK hist} As time goes by... @endnode @node "legl" "LEGALALESE" @{u}@{fg highlight}LEGALALESE@{fg text}@{uu} Before using this software please read the @{" COPYRIGHT " LINK copy}, the @{" DISCLAIMER " LINK disc} and any other documentation that can be found here before taking any further steps. @endnode @node "copy" "COPYRIGHT" @{u}@{fg highlight}COPYRIGHT@{fg text}@{uu} The software YGM, all enclosed binary files and this documentation unless otherwise quoted are Copyright © 1999-2002 by Stefan Falke, denoted as author hereafter. All Rights Reserved. This program is Freeware. This means that it is freely distributable provided that the following conditions are met: You may use and distribute it unless told not to do so by the author. You may distribute unmodified copies of the YGM archive on disk provided that no money is charged beyond the cost of the storage media. You may distribute unmodified copies of the YGM archive electronically over computer networks or bulletin board systems provided that no money is charged beyond the costs for downloading the archive. Computer magazines may not distribute the archive on cover disks without prior permission by the author. Distribution on Aminet CDs is permitted. You are not allowed to modify the YGM archive or to distribute copies of the YGM archive by other means than those stated herein without explicit permission by the author. You are not allowed to modify or translate neither the program nor the included files. You are not allowed to decode the program or allow it to be decoded into its constituent source code. @endnode @node "disc" "DISCLAIMER" @{u}@{fg highlight}DISCLAIMER@{fg text}@{uu} THE AUTHOR OF THIS SOFTWARE MAKES NO WARRANTIES, EITHER EXPRESSED OR IMPLIED, WITH RESPECT TO RELIABILITY, QUALITY, PERFORMANCE, OR OPERATION OF THE SOFTWARE DESCRIBED HEREIN FOR ANY PARTICULAR PURPOSE. THIS SOFTWARE IS PROVIDED "AS IS". THE ENTIRE RISK AS TO ITS QUALITY AND PERFORMANCE IS WITH THE USER. IN NO EVENT WILL THE AUTHOR BE LIABLE FOR DIRECT, INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES, OR DAMAGES RESULTING FROM LOSS OF USE OR LOSS OF ANTICIPATED PROFITS RESULTING FROM ANY DEFECT IN THE PROGRAM EVEN IF IT HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE OR LOSS. @endnode @node "intr" "Introduction" @{u}@{fg highlight}Introduction@{fg text}@{uu} YGM stands for 'You've Got Mail'. It checks your POP3 mailboxes for new mails so that you do not have to start your favourite yet sometimes bulky mail client just for this. YGM shows you how many mails are waiting in your mailboxes for download and their approximate size. YGM is also useful for email providers who require a POP3 authentication before you are allowed to send emails over their SMTP servers, a security feature also known as 'SMTP-after-POP'. @endnode @node "reqr" "Requirements" @{u}@{fg highlight}Requirements@{fg text}@{uu} @{lindent 2} ° AmigaOS 2.04 or higher, AmigaOS 3.5 or higher recommended. ° AmiTCP 4 compatible TCP/IP stack. ° ReAction classes or fgui.library V1.29 or newer. ° An Internet connection and at least one mail account with POP3 access. @{lindent 0} @endnode @node "inst" "Installation" @{u}@{fg highlight}Installation@{fg text}@{uu} There is no special installation process necessary to run YGM. Just unpack the archive to a place you like and run the program. However, if you want a more convenient method of installing the program there is an Installer script provided with this release, called Install-YGM. If you double-click its icon only those files will be installed you really need. @endnode @node "usag" "Usage" @{u}@{fg highlight}Usage@{fg text}@{uu} YGM can either be run from the @{" CLI " LINK rcli} or from the @{" Workbench " LINK rwbn}. To be able to access the mailbox status from other applications YGM gives back @{" result codes " LINK rslt} and creates an @{" Environment variable " LINK enva}. If you run the program from the CLI without displaying its GUI by specifying the NOREQ argument it will try to access all specified mailboxes once and then quit. If you run it with a GUI you are able to query the POP3 mail servers multiple times. @{fg highlight}The GUI@{fg text} The GUI requester consists of a text gadget which shows the status of the current mailbox being accessed and the three button gadgets @{b}Connect@{ub}, @{b}Skip@{ub} and @{b}Quit@{ub}. With @{b}Connect@{ub} you start the query process. With @{b}Quit@{ub} you can either stop a running query process or quit the program when no query process is running. With @{b}Skip@{ub} you can stop querying the current mailbox and go over to the next one. If you run the program with a GUI you can also start the query sequence by sending a @{b}CTRL-F@{ub} signal to the program. You can quit the program or stop a query process from outside by sending a @{b}CTRL-C@{ub} signal or from the Commodity Exchange program. The GUI can be hidden by choosing the menu item 'Project/Hide' or by selecting the window's close gadget. It can be reopened by double clicking the YGM icon or through Commodity Exchange. By default the GUI is opened at the best position relativ to the mouse pointer. If you prefer to have the GUI opened at a fixed position you can select the menu items 'Window/Snapshot' and 'Window/UnSnapshot'. If the query sequence was not successful for a mailbox, the reason for the failure may be given in the text gadget of the GUI requester and/or in the YGM @{" log file " LINK wbtt_logname}. @{fg highlight}YGM as a commodity@{fg text} YGM runs as a Commodity and the behaviour of it can be controlled with the 'Commodities Exchange' program. Via Commodity Exchange you can hide and reopen the YGM GUI, you can activate and deactivate it and you can quit the program. @endnode @node "rcli" "Running from the CLI" @{u}@{fg highlight}Running from the CLI@{fg text}@{uu} Format: YGM [@{" USER|USERID " LINK wbtt_ups}] [@{" PASS|PASSWORD " LINK wbtt_ups}] [@{" SERVER " LINK wbtt_ups}] [@{" USER2 " LINK wbtt_ups} ] [@{" PASS2 " LINK wbtt_ups} ] [@{" SERVER2 " LINK wbtt_ups} ] [@{" USER3 " LINK wbtt_ups} ] [@{" PASS3 " LINK wbtt_ups} ] [@{" SERVER3 " LINK wbtt_ups} ] [@{" ACCESSFILE " LINK wbtt_accessfile} ] [@{" NOMAILICON " LINK wbtt_mailicons} ] [@{" NEWMAILICON " LINK wbtt_mailicons} ] [@{" OLDMAILICON " LINK wbtt_mailicons} ] [@{" BUSYICON " LINK wbtt_mailicons} ] [@{" NODEFICON " LINK wbtt_nodeficon}] [@{" ICONX " LINK wbtt_iconxy} ] [@{" ICONY " LINK wbtt_iconxy} ] [@{" TIMEOUT " LINK wbtt_timeout} ] [@{" DISPLAYBEEP " LINK wbtt_displaybeep}] [@{" PLAYSOUND " LINK wbtt_playsound} ] [@{" RUNCOMMAND " LINK wbtt_runcommand} ] [@{" AUTOSTART " LINK wbtt_autostart}] [@{" AUTOQUIT " LINK wbtt_autoquit}] [@{" DELAY " LINK wbtt_delay} ] [@{" REPEAT " LINK wbtt_repeat} ] [@{" NOQUIT " LINK wbtt_noquit}] [@{" QUIT " LINK wbtt_quit}] [@{" NOREQ " LINK wbtt_noreq}] [@{" QUIET " LINK wbtt_quiet}] [@{" LOGLEVEL " LINK wbtt_loglevel} ] [@{" LOGNAME " LINK wbtt_logname} ] [@{" NOLOG " LINK wbtt_nolog}] [@{" CX_PRIORITY " LINK wbtt_cx_priority} ] [@{" CX_POPUP " LINK wbtt_cx_popup} no] [@{" CX_POPKEY " LINK wbtt_cx_popkey} ] [@{" GUIENGINE " LINK wbtt_guiengine} fgui] Template: USER=USERID/K,PASS=PASSWORD/K,SERVER/K, USER2/K,PASS2/K,SERVER2/K,USER3/K,PASS3/K,SERVER3/K,ACCESSFILE/K, NOMAILICON/K,NEWMAILICON/K,OLDMAILICON/K, BUSYICON/K,NODEFICON/S,ICONX/K/N,ICONY/K/N, TIMEOUT/K/N,DISPLAYBEEP/S,PLAYSOUND/K,RUNCOMMAND/K, AUTOSTART/S,AUTOQUIT/S,DELAY/K/N,REPEAT/K/N, NOQUIT/S,QUIT/S,NOREQ/S,QUIET/S, LOGLEVEL/K/N,LOGNAME/K,NOLOG/S, CX_PRIORITY/K/N,CX_POPUP/K,CX_POPKEY/K, GUIENGINE/K @endnode @node "wbtt_ups" "Running from the CLI" @{u}@{fg highlight}Running from the CLI@{fg text}@{uu} @{b}USER, PASS, SERVER USER2, PASS2, SERVER2 USER3, PASS3, SERVER3 @{ub} YGM allows an unlimited number of mailboxes to be queried in a single run. With USER, USER2 and USER3 you can specify the username of each of the first 3 mail accounts, with PASS, PASS2 and PASS3 you specify the passwords and with SERVER, SERVER2 and SERVER3 the names or IP adresses of the POP3 mail servers. If you have to use a different port number than the default you can specify it directly after the SERVER argument, using a ':' to separate server name and port number. If you want to access more than one mailbox please use the ACCESSFILE argument as USER2/USER3, PASS2/PASS3 and SERVER2/SERVER3 may disappear in future versions. @endnode @node "wbtt_accessfile" "Running from the CLI" @{u}@{fg highlight}Running from the CLI@{fg text}@{uu} @{b}ACCESSFILE@{ub} offers a different way to specify all necessary information to access your mailboxes and it allows to query an unlimited number of boxes in a single run. With this argument you have to specify the path and name of a file which contains usernames, passwords and server names. In addition to that three more fields, 'alias', 'disable' and 'apop' may be entered: With 'alias' a different name for 'username' can be specified whenever it is displayed or written to the logfile. Specifying 'disable' tells YGM to skip checking the box of the very line. When 'apop' is set username and password will be transmitted more safely using the APOP command. Without APOP both username and password will be transitted in the clear over the net. Note that not all mail servers support APOP. For 'disable' and 'apop' the values 'Y' for yes and 'N' for no are allowed. Each line of the file should have the following format: @{i}username@{ui},@{i}password@{ui},@{i}server@{ui}[:@{i}port@{ui}][,@{i}alias@{ui}[,@{i}disable@{ui}[,@{i}apop@{ui}]]] Comments in the access file are identified by a '#' character, blank lines, blanks and tabs are ignored. @{b}Example:@{ub} JohnDoe, mysecret, my.server.com # John's-Account JaneDoe, hersecret, her.server.com:147, JD, Y # Jane's-Account JoanneDoe, hersecret, her.server.com, JoJo, Y, Y # Joanne's-Account An example version of an access file called YGM.dat can also be found in the 's' drawer of this release. If you specify mailbox information by direct arguments (USER, PASS, SERVER, etc.) @{b}and@{ub} ACCESSFILE, the mailboxes specified with ACCESSFILE will be queried @{b}after@{ub} those given with direct arguments. @endnode @node "wbtt_mailicons" "Running from the CLI" @{u}@{fg highlight}Running from the CLI@{fg text}@{uu} @{b}NOMAILICON NEWMAILICON OLDMAILICON BUSYICON @{ub} By default YGM displays an application icon on the Workbench to visualize the current mailbox status using the standard YGM.info file. With NOMAILICON, NEWMAILICON, OLDMAILICON and BUSYICON you can specify different icons for cases when there is no, new or old mail in your mailboxes and when YGM is busy to query the mail server. You have to specify the complete path of the icon to use, without the '.info' extension. @endnode @node "wbtt_nodeficon" "Running from the CLI" @{u}@{fg highlight}Running from the CLI@{fg text}@{uu} @{b}NODEFICON@{ub} tells YGM not to display a default application icon. Only application icons specified via NOMAILICON, NEWMAILICON, OLDMAILICON and BUSYICON will be created. @endnode @node "wbtt_iconxy" "Running from the CLI" @{u}@{fg highlight}Running from the CLI@{fg text}@{uu} @{b}ICONX ICONY @{ub} By default YGM displays its application icon at no specific position on the Workbench. If you want it to appear at a fixed position you can specify the desired horizontal and vertical position via ICONX and ICONY. When YGM is running under OS3.5 you can use a more convenient method having the icon displayed at a specific position by selecting the Workbench menu items 'Icons/Snapshot' and 'Icons/UnSnapshot'. @endnode @node "wbtt_timeout" "Running from the CLI" @{u}@{fg highlight}Running from the CLI@{fg text}@{uu} @{b}TIMEOUT@{ub} With TIMEOUT you can specify the maximum length of the period in seconds YGM tries to connect to each mail server before it will fail. The default for TIMEOUT is 30. @endnode @node "wbtt_displaybeep" "Running from the CLI" @{u}@{fg highlight}Running from the CLI@{fg text}@{uu} @{b}DISPLAYBEEP@{ub} If this argument is specified, YGM flashes all screens if at least one mailbox being queried has new mail. @endnode @node "wbtt_playsound" "Running from the CLI" @{u}@{fg highlight}Running from the CLI@{fg text}@{uu} @{b}PLAYSOUND@{ub} With this argument you have to specify the path and name of a soundfile which will be played if at least one mailbox being queried has new mail. The soundfile can be an 8svx file for example. Please note that YGM needs the datatypes.library to use this feature so you must have at least OS 3.0 installed to use it successfully. @endnode @node "wbtt_runcommand" "Running from the CLI" @{u}@{fg highlight}Running from the CLI@{fg text}@{uu} @{b}RUNCOMMAND@{ub} With this argument you have to specify the path and name of a program or script which will be run automatically if at least one mailbox being queried has new mail. This program can be your favourite mailer for example. The program or script will be startet asynchronously so you don't have to use the 'run' command. To run a program you could specify RUNCOMMAND="YAM:YAM" to run YAM when you've got new mail. To execute an ARexx script you could use RUNCOMMAND="sys:rexxc/rx rexx/havemail.rexx" If you want to have access to the current mail status from the program or script being started you can examine the environment variable @{" YGMBOXSTAT " LINK enva}. If you specified RUNCOMMAND and you have at least one mail box with mail waiting, either new or old mail, the menu item 'Mailbox/Execute RUNCOMMAND' becomes selectable. This allows to execute the RUNCOMMAND when YGM already checked the mails before. @endnode @node "wbtt_autostart" "Running from the CLI" @{u}@{fg highlight}Running from the CLI@{fg text}@{uu} @{b}AUTOSTART@{ub} With AUTOSTART the connect procedure begins shortly after the YGM requester shows up. @endnode @node "wbtt_autoquit" "Running from the CLI" @{u}@{fg highlight}Running from the CLI@{fg text}@{uu} @{b}AUTOQUIT@{ub} With AUTOQUIT the program quits after all mailboxes have been processed. Note that AUTOQUIT will only be effective if AUTOSTART is also set. @endnode @node "wbtt_delay" "Running from the CLI" @{u}@{fg highlight}Running from the CLI@{fg text}@{uu} @{b}DELAY@{ub} expects a ticks-per-second value (with 50 ticks per second) which will be used as a delay after updating the information display of the YGM requester. If you have an ISP with a large bandwidth it might be necessary to wait some time so that you can read all messages. If it's a slow connection, you should specify 0. The default for DELAY is 0. AUTOSTART, AUTOQUIT and DELAY are only significant if you run YGM with a GUI, which means, you do not specify NOREQ. @endnode @node "wbtt_repeat" "Running from the CLI" @{u}@{fg highlight}Running from the CLI@{fg text}@{uu} @{b}REPEAT@{ub} With REPEAT you can tell YGM to check your mail accounts every time the specified interval has elapsed. Values above 0 are interpreted as minutes, values below 0 as seconds. The default for REPEAT is 0. When YGM is set to 'Inactive' through Commodity Exchange the repeat function will be suspended until it is set to 'Active' again. @endnode @node "wbtt_noquit" "Running from the CLI" @{u}@{fg highlight}Running from the CLI@{fg text}@{uu} @{b}NOQUIT@{ub} The default behaviour of YGM is to quit if it's already running and beeing started again. By specifying NOQUIT you tell YGM not to quit in this case. This way you can call YGM repeatedly from a script without the need to check first if it is already running or not. @endnode @node "wbtt_quit" "Running from the CLI" @{u}@{fg highlight}Running from the CLI@{fg text}@{uu} @{b}QUIT@{ub} By specifying QUIT you tell an already running instance of YGM to quit. @endnode @node "wbtt_noreq" "Running from the CLI" @{u}@{fg highlight}Running from the CLI@{fg text}@{uu} @{b}NOREQ@{ub} Specifying NOREQ prevents YGM from showing a GUI. The program will check all specified mailboxes once and then exits. @endnode @node "wbtt_quiet" "Running from the CLI" @{u}@{fg highlight}Running from the CLI@{fg text}@{uu} @{b}QUIET@{ub} With QUIET you prevent YGM from printing informative and diagnostic messages to the console if it was started from the CLI. @endnode @node "wbtt_loglevel" "Running from the CLI" @{u}@{fg highlight}Running from the CLI@{fg text}@{uu} @{b}LOGLEVEL@{ub} With this argument you can adjust the amount of information which will be written to the YGM logfile. The following values may be given: 0 - Do not write any messages 1 - Only write error messages 2 - Write any available messages The default for LOGLEVEL is 2. @endnode @node "wbtt_logname" "Running from the CLI" @{u}@{fg highlight}Running from the CLI@{fg text}@{uu} @{b}LOGNAME@{ub} By default YGM writes informative and diagnostic messages to the file @{b}T:YGM.log@{ub}. With this argument you can determine a different path and file name for the log messages. @endnode @node "wbtt_nolog" "Running from the CLI" @{u}@{fg highlight}Running from the CLI@{fg text}@{uu} @{b}NOLOG@{ub} This argument prevents YGM from writing any log messages. It has the same effect as LOGLEVEL=0. Please use LOGLEVEL=0 as this argument may disappear in future versions. @endnode @node "wbtt_cx_priority" "Running from the CLI" @{u}@{fg highlight}Running from the CLI@{fg text}@{uu} @{b}CX_PRIORITY@{ub} allows to set the priority of YGM in relation to all other running Commodities. It accepts values from -128 to 127, the higher the number, the higher the priority of the YGM commodity. By default a priority of 0 is used. @endnode @node "wbtt_cx_popup" "Running from the CLI" @{u}@{fg highlight}Running from the CLI@{fg text}@{uu} @{b}CX_POPUP@{ub} By default YGM opens a GUI (unless NOREQ is specified). With CX_POPUP=NO YGM will start in hidden state allowing to open the GUI later by double clicking its icon or through the Commodity program Exchange. @endnode @node "wbtt_cx_popkey" "Running from the CLI" @{u}@{fg highlight}Running from the CLI@{fg text}@{uu} @{b}CX_POPKEY@{ub} Another way to reopen a hidden GUI is by specifying a hot key for YGM via CX_POPKEY and pressing this key. @endnode @node "wbtt_guiengine" "Running from the CLI" @{u}@{fg highlight}Running from the CLI@{fg text}@{uu} @{b}GUIENGINE@{ub} By default YGM tries to create its GUI by using the ReAction layout engine. If the ReAction engine can not be opened for some reason the proprietary GUI engine fgui.library will be used. However, if you prefer to use fgui.library even if ReAction is available you can do so by specifying GUIENGINE=FGUI. @endnode @node "rslt" "Result codes" @{u}@{fg highlight}Result codes@{fg text}@{uu} If you run the program from the CLI you can examine the result codes RC and RESULT2 to see which mailbox has mail waiting after the program has been quit. If all mailboxes were queried successfully and there is no mail in any one of them the program gives back a return code (RC) of 0. A return code of 1 indicates that no error occurred and at least one mailbox has got mail. In this case RESULT2 will contain the mail status of each mailbox as a bit mask where bit 1 represents the first, bit 2 represents the second and bit 3 represents the third mailbox. If a bit is set it means this mailbox has got new mail, so a RESULT2 of 5 means mailbox 1 and 3 have mail. This scheme works for the first 16 mailboxes being specified. To access the current mailbox status while YGM is running the environment variable @{" YGMBOXSTAT " LINK enva} can be examined. All other return codes mean that there was an error while accessing one or all mailboxes. A return code of 10 ususally means that a DOS error occurred. In this case the DOS error code will be returned in RESULT2 and the error text will be printed to the console. A return code of 20 means that something serious prevented the program from running, e.g. a library couldn't be opened. This return code will also be given back if a TCP/IP error occurred or the mail server didn't like a username or password. In case of a TCP/IP error a TCP/IP error code will be returned in RESULT2. @endnode @node "enva" "Environment variable" @{u}@{fg highlight}Environment variable@{fg text}@{uu} After each query sequence YGM stores the current mailbox status in the environment variable YGMBOXSTAT. It has the same bitmask format as the @{" RESULT2 " LINK rslt} return code. @endnode @node "rwbn" "Running from the Workbench" @{u}@{fg highlight}Running from the Workbench@{fg text}@{uu} All of the @{" CLI " LINK rcli} arguments except NOREQ and QUIET also exist as Workbench ToolTypes with the same meaning. @endnode @node "note" "Security Notes" @{u}@{fg highlight}Security Notes@{fg text}@{uu} A note on security: Please be aware of the fact that the usernames and passwords you specify will be used to access your mailboxes. Especially your passwords should always be kept secret so that no one else but you has access to your mail accounts. If you run YGM from the Workbench, usernames and passwords are only stored in one place by default: as ToolTypes in the YGM icon, which equals to the file YGM.info. They are @{u}@{b}NOT@{ub} encrypted@{uu} so make sure that nobody else but you has access to this file! If you run the program from the CLI you normally specify usernames and passwords as command line arguments so they are not stored anywhere. However, if you run YGM from a script file, it is possible to store usernames and passwords unencrypted, so, as above: make sure that no-one else but you has access to this script! If you use the ACCESSFILE argument, all information in the file specified should be kept secret too! I can guarantee you that YGM does nothing naughty with your usernames/passwords like installing a trojan horse or things like that. However, you as the enduser should make sure that you are not using a cracked version which might behave very bad. In order to give you the possibility to verify that this archive has not been modified in any way I enclosed MD5 checksums for all files in this archive. They can be checked with md5sum -vc YGM.md5 The 'md5sum' program can normally be found in PGP releases. The file 'YGM.md5' is also signed with my PGP key to prove that it's untouched. It can be checked with pgp YGM.md5 You can find my public key at @{fg highlight}http://www.sfxsoft.de@{fg text}. If you don't trust this file, or the MD5 checksums or have problems getting my public key, drop me an email and I'll send you the files. If you don't trust me, well, I'm afraid I can't help you on this. In this case you better shouldn't use this program ;-) @endnode @node "xmpl" "Examples" @{u}@{fg highlight}Examples@{fg text}@{uu} @{b}1. YGM USER=JohnDoe PASS=secretword SERVER=my.server.com CX_POPKEY="LShift Alt F3"@{ub} YGM will start up and open the YGM GUI. If you select 'Connect' it will log into JohnDoe's mailbox at the POP3 server my.server.com at the default port using secretword as password. Selecting 'Quit' will exit YGM. If you hide the GUI you can reopen it by pressing the left shift key together with the alt and F3 keys. @{b}2. YGM USER=JohnDoe PASS=secretword SERVER=my.server.com:123 AUTOSTART REPEAT=10 DELAY=0@{ub} YGM will start up and open the YGM GUI. It will immediately log into JohnDoe's mailbox at the POP3 server my.server.com on port number 123 using secretword as password and it will repeat this procedure every 10 minutes. All status messages in the requester will be updated with no delay. @{b}3. YGM ACCESSFILE=ygm.dat DISPLAYBEEP PLAYSOUND=NewMail.8svx RUNCOMMAND=MyMailer NOREQ@{ub} YGM won't open the YGM GUI. It will immediately try to log into all mailboxes being found in ygm.dat and then exit. If there is new mail in one of the mailboxes, all screens will be flashed, the soundfile NewMail.8svx will be played and the program MyMailer will be started. Informative and/or error messages will be printed to the console if the program was started from the CLI. @{b}4. YGM USER=JohnDoe PASS=secretword SERVER=my.server.com NOREQ QUIET NOLOG@{ub} YGM won't open the YGM GUI. It will immediately log into JohnDoe's mailbox once at the POP3 server my.server.com at the default port using secretword as password and then exit. Messages will neither be printed to the console if the program was started from the CLI nor will they be written to the log file T:YGM.log. If you want to run YGM from an AmigaDOS script or from an ARexx script you may find the two example scripts @{b}ygm.scr@{ub} and @{b}ygm.arexx@{ub} helpful, which are to be found in the 's' drawer of this release. @endnode @node "auth" "Author" @{u}@{fg highlight}Author@{fg text}@{uu} YGM is written by Stefan Falke. If you have any comments about the program, should find any bugs or would like to see special features to be added in the next release please feel free to send me an email to the following address: @{fg highlight}Stefan Falke @{fg text} The latest version of YGM can be found under the following address: @{fg highlight}http://www.sfxsoft.de@{fg text} @endnode @node "feed" "Feedback" @{u}@{fg highlight}Feedback@{fg text}@{uu} @{fg highlight}Rating YGM@{fg text} Please rate YGM. To do so, send an EMail to aminet-server@wuarchive.wustl.edu with RATE comm/tcp/YGM.lha in the body of the mail, where is your rating from 0..10 with 10 being the best. You can rate several programs in one mail. @{fg highlight}Language support@{fg text} If you would like to have language support for a language which isn't supplied with this release, please let me know if you would like to make a translation yourself and I will contact you ASAP. Please let me know *before* you start translating--there may be another person already doing the same job. @endnode @node "crdt" "Acknowledgements" @{u}@{fg highlight}Acknowledgements@{fg text}@{uu} The language catalogs were translated by: Dansk : Thomas Siefert Espańol : Dámaso D. Estévez Italiano: Rosario D'Angelo Norsk : Trond K. Tveit Deutsch : @{" Me :-) " LINK auth} Additional string translations for the install script by: Espańol : Dámaso D. Estévez Italiano: Rosario D'Angelo The beta testers (starring in alphabetical order): Gary Beeton Nils Görs Markus Pflaumbaum Thomas Siefert Trond K. Tveit Wendell Watanabe Many thanks to everyone else who contributed. @endnode @node "hist" "Version History" @{u}@{fg highlight}Version History@{fg text}@{uu} @{u}2.7 (2.5.2002)@{uu} @{lindent 2} ° The argument QUIT has been added to tell an already running instance of YGM to quit. @{lindent 0} @{u}2.6 (30.3.2002)@{uu} @{lindent 2} ° The argument NOQUIT has been added to tell YGM not to quit an already running instance of YGM if it is started again. ° Hitting 'Help' when the YGM gui is active will display the YGM user guide now. ° Modified the places where YGM looks for different files to better support running YGM from the WBStartup drawer: - ACCESSFILE will be searched in 'YGM/s/' and 's:' too. - YGM.prefs will be searched in 'YGM:' and 'ENV:' too. - YGM.guide will be searched in 'YGM:' too. - Icons will be searched in 'YGM:icons/' too. - Sound files will be searched in 'YGM:sounds/' too. @{lindent 0} @{u}2.5 (20.4.2001)@{uu} @{lindent 2} ° Mailbox login now supports APOP for transmitting username and password more safely. ° REPEAT values may now be specified in seconds too. ° When REPEAT and AUTOSTART is specified the mailbox check will now only start if bsdsocket.library is available and the TCP/IP stack is online. This prevents annoying 'can't open bsdsocket.library' requesters when YGM is running in the background all the time (MIAMI, Genesis). ° Removed a bug where specifying RUNCOMMAND and NOREQ could lead to a system freeze. @{lindent 0} @{u}2.4 (24.8.2000)@{uu} @{lindent 2} ° The connection with a mail server can now be stopped *immediately* by hitting the 'Stop' button - this eliminates waiting for a timeout. ° Checking the current mailbox can now be skipped by hitting the new 'Skip' button. ° The mailbox status gadget now has a vertical scroll gadget when using the ReAction GUI module. ° The GUI will now refresh immediately after a resize when YGM is busy talking to a mail server. ° Each line in the ACCESSFILE may now also contain an 'Alias' and a 'Disable' field. ° Leading and trailing blanks in fields of ACCESSFILE lines will now be ignored too. ° Usernames and passwords specified in the ACCESSFILE may contain the character '#' now. If an ACCESSFILE line does not contain all necessary values (username, password, server) a specific message will be written to the logfile. ° The argument BUSYICON has been added to specify a different Icon image when YGM is querying the mail server. ° The Menu 'Mailbox' with its item 'Execute RUNCOMMAND' has been added to be able to execute the program or script specified with RUNCOMMAND if at least one mailbox being queried has new or old mail. ° The Menu 'Window' with its items 'Snapshot' and 'UnSnapshot' has been added allowing to fix and free the GUI position and dimension. ° YGM's AppIcon position can now be fixed and freed using the appropriate Workbench menu items under OS3.5. ° YGM will now remember checked mails by default even when the program has been stopped and restarted. ° Specifying DELAY with values smaller than 50 didn't work properly. ° YGM now expects V3.x GUI modules. ° YGM now expects V2.x language catalogs. @{lindent 0} @{u}2.3@{uu} @{lindent 2} ° Internal release. @{lindent 0} @{u}2.2 (20.3.2000)@{uu} @{lindent 2} ° YGM ran into dire straits when it was started again while another instance of the program was talking to the mail servers - this has been fixed. ° The install script speaks italian now too. ° Italian translation catalog added to distribution archive. @{lindent 0} @{u}2.1 (2.3.2000)@{uu} @{lindent 2} ° The current mailbox status will now be written to the environment variable YGMBOXSTAT after each query. This enables other applications to act more specifically when retrieving mails. There are four new ARexx scripts enclosed to demonstrate how to use YGMBOXSTAT. ° YGMs AppIcon won't be reset to zero when the accounts cannot be checked anymore (no stack available, no connection, no successful login, etc.). In this case the last status will be preserved. ° The GUI requester now initially displays the status of the last mailcheck sequence after it has returned from hidden state. ° The arguments LOGLEVEL und LOGNAME have been added. ° YGM now is much more precise when deciding between newmail and oldmail. It will only use NEWMAILICON now if there really is at least one email it hasn't checked before during the active session. ° YGM didn't perform as expected when NOREQ was specified - fixed. ° Some mail servers caused YGM unnecessarily to report an 'error after UIDL' - this has been fixed. ° NEWMAILICON wasn't removed when only NEWMAILICON and NODEFICON were specified and no mail was waiting anymore - fixed. ° Using the PLAYSOUND argument could cause YGM to freeze if other than the official sound.datatypes were used - this has been fixed. ° The installer script now won't overwrite an existing YGM.dat anymore and it now asks before overwriting an existing YGM icon to preserve modified ToolTypes by the user. ° The install script speaks spanish now too. ° The installer script V1.6 contained a bug when it was used under the 'English' language - fixed. ° Spanish translation catalog added to distribution archive. ° YGM now expects V2.x GUI modules. @{lindent 0} @{u}2.0 (8.2.2000)@{uu} @{lindent 2} ° Various application icons now visualize the mailbox status. The arguments NOMAILICON, NEWMAILICON, OLDMAILICON, NODEFICON, ICONX and ICONY have been added. ° YGM now uses the OS3.5 ReAction gui engine to build its GUI by default. The argument GUIENGINE has been added. ° The GUI can now be resized and hidden. ° YGM now is a commodity. It can be controlled via the Commodity Exchange program. The arguments CX_PRIORITY, CX_POPUP, CX_POPKEY have been added. Selecting the window's close gadget will hide the GUI now. ° YGM now is able to check repeatedly for new mail. The argument REPEAT has been added. ° Norwegian translation catalog added to distribution archive. @{lindent 0} @{u}1.3 (25.6.99)@{uu} @{lindent 2} ° The arguments DISPLAYBEEP, PLAYSOUND, RUNCOMMAND have been added to provide various means to inform the user when new mail has arrived. ° The argument ACCESSFILE has been added to allow an unlimited number of mailboxes to be checked during one session. ° The argument TIMEOUT has been added which will be used as a timeout value when connecting to the mail servers. ° It is now possible to specify and use different port numbers when connecting to the mail servers. ° Installer script has been added to distribution archive. ° f!gui.library has been renamed to fgui.library. @{lindent 0} @{u}1.2 (18.3.99)@{uu} @{lindent 2} ° You can now check from AmigaDOS and ARexx whether you've got mail. ° AmigaDOS script ygm.doc and ARexx script ygm.arexx added to distribution archive. ° YGM documention converted to AmigaGuide. ° Danish translation catalog added to distribution archive. ° Specifying NOREQ caused system crash--fixed. @{lindent 0} @{u}1.1 (12.3.99)@{uu} @{lindent 2} ° Internal release. @{lindent 0} @{u}1.0 (16.2.99)@{uu} @{lindent 2} ° Initial public release. @{lindent 0} @endnode