@database "Eucalyptus.guide" @master "Eucalyptus.guide" @author "Paul A. Schifferer" @(c) "Copyright © 1997 Isengard Developments" @$VER: Eucalyptus.guide 1.0 (7.11.97) @wordwrap @node Main "Eucalyptus: Table of Contents" @{i}Eucalyptus@{ui} Version 1.0 @{b}BETA@{ub} Written by Paul A. Schifferer Copyright © 1997 Isengard Developments All rights reserved. @{b}@{i}Table of Contents@{ui}@{ub} @{u}Legal@{uu} @{" I. " link Terms} Terms @{" II. " link Disclaimer} Disclaimer of Warranty @{u}Starting@{uu} @{" III. " link Intro} Introduction @{" IV. " link Required} System requirements @{" V. " link Install} Installing Eucalyptus @{" VI. " link Registration} Registration @{" VII. " link Bugs} Undocumented features @{" VIII. " link Beta} Beta-testers' note @{" IX. " link UsingWB} Using Eucalyptus from the Workbench @{" X. " link UsingShell} Using Eucalyptus from the Shell @{" XI. " link InitConfig} Configuring Eucalyptus initially @{u}Operation@{uu} @{" XII. " link MainWindow} Main window @{" XIII. " link Menus} Menus @{" XIV. " link Folders} Folders @{" XV. " link FolderWindow} Folder window @{" XVI. " link Msgs} Messages @{" XVII. " link MsgWindow} Message window @{" XVIII. " link Composing} Composing mail @{" XIX. " link AddressBook} Address Book @{" XX. " link ConfigFilters} Filters @{" XXI. " link ConfigViewers} Viewers @{" XXII. " link Configure} Configuring Eucalyptus @{" XXIII. " link GetSendMail} Getting and sending mail @{" XXIV. " link SendWindow} Send mail window @{" XXV. " link ReceiveWindow} Receive mail window @{" XXVI. " link ARexx} ARexx Interface @{" XXVII. " link ClassAct} Using the ClassAct gadgets @{u}Miscellaneous@{uu} @{"XXVIII. " link Misc} Miscellaneous @{u}Appendices@{uu} @{" A. " link History} Program history @{" B. " link Refs} References @{" C. " link me} Author information @{" D. " link Acks} Acknowledgements @endnode @node Terms "Eucalyptus: Terms" @{fg shine}Terms@{fg text} You may copy and distribute verbatim copies of the programs' executable code and documentation as you receive it, in any medium, provided that you conspicuosly and appropriately publish only the original, unmodified programs, with all copyright notices and disclaimers of warranty intact and including all the accompanying documentation, example files and anything else that came with the original. You may not copy and/or distribute these programs without the accompanying documentation and other additional files that came with the original. You may not copy and/or distribute modified versions of these programs. You may not disassemble, decompile, re-source or otherwise reverse engineer the programs. You may charge a fee to recover distribution costs. The fee for diskette distribution may not be more than the cost to obtain a public domain diskette from Fred Fish. @endnode @node Disclaimer "Eucalyptus: Disclaimer of Warranty" @{fg shine}Disclaimer of Warranty@{fg text} THERE IS NO WARRANTY FOR THE PROGRAMS, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING, THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAMS "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAMS IS WITH YOU. SHOULD THE PROGRAMS PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY REDISTRIBUTE THE PROGRAMS AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAMS (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAMS TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. SO THERE. @endnode @node Intro "Eucalyptus: Introduction" @toc Main @{fg shine}Introduction@{fg text} It seems like I write a lot of programs because I can't find one that does all the things I want it to do. My philosophy is that if something doesn't do what I need, and I can write it, I will. Eucalyptus was borne of this philosophy. Some of you may be wondering from where the name came. If you've used e-mail on UNIX systems, you should be familiar with some of the popular programs for that purpose, namely Elm and Pine, which, quite obviously, are named after trees. I always thought that this was an interesting tradition. But unlike Elm or Pine, Eucalyptus is not an acronym for anything. (If you can think of anything, I'd be really interested to hear it. :) I wanted the name to be interesting as well, and Eucalyptus was what I came up with. Just say it. "Eucalyptus." See how it rolls off the tongue? I knew you'd like it too. @{b}EUCALYPTUS IS IN DEVELOPMENT, THE PROGRAM WILL PROBABLY CONTAIN PORTIONS THAT APPEAR NOT TO WORK, DO NOT WORK CORRECTLY OR AS DOCUMENTED, OR MAY CONTAIN BUGS. YOU ARE USING THIS PROGRAM AT YOUR OWN RISK. YOU HAVE BEEN WARNED.@{ub} @endnode @node Required "Eucalyptus: System requirements" @toc Main @{fg shine}System requirements@{fg text} - AmigaOS 2.04 or better - 2.1 or better for Locale support - 3.0 or better for Datatype support - 68000 or better processor - 2MB RAM or greater - ClassAct V2.0 classes (included) - Internet connection Optional: - @{i}newicon.library@{ui} for button image remapping - @{i}bsdsocket.library@{ui} for internal POP/SMTP @{b}EUCALYPTUS IS IN DEVELOPMENT, THE PROGRAM WILL PROBABLY CONTAIN PORTIONS THAT APPEAR NOT TO WORK, DO NOT WORK CORRECTLY OR AS DOCUMENTED, OR MAY CONTAIN BUGS. YOU ARE USING THIS PROGRAM AT YOUR OWN RISK. YOU HAVE BEEN WARNED.@{ub} @endnode @node Registration "Eucalyptus: Registration" @toc Main @{fg shine}Registration@{fg text} Eucalyptus is a free product. A labor of love, if you will. I wrote it because I wanted an e-mail program that would do all the things I wanted it to do. The only registration I ask of you is that you drop @{"me" link me} a line, good or bad, about what you think about Eucalyptus. If you don't like it, by all means, tell me why. Maybe I can make that change that'll make you happy. If you do like it, say so, and give me suggestions for improvement. @endnode @node me "Eucalyptus: Author information" @toc Main The official support site for Eucalyptus (and other programs) is: http://www.geocities.com/SiliconValley/Pines/3517 Visit there often to see what's developing. The address to which you can send me money, postcards, a spare Amiga, or anything else is: Paul A. Schifferer 515 11th Street or PSC 3 Box 2342 Edwards, CA 93523 APO AP 96266 USA USA I can also be contacted via Internet at: @{b}gandalf@inet.att.co.kr@{ub} or @{b}isengard@geocities.com@{ub} @endnode @node Install "Eucalyptus: Installing Eucalyptus" Included in the archive is an installer script to be used with the Commodore Installer. If you don't have it, it can be retrieved from the Aminet. @endnode @node Bugs "Eucalyptus: Undocumented features" @toc Main @{fg shine}Undocumented Features@{fg text} Some people call these things 'bugs'. If you happen to notice one of these little critters, let me know, please! I've done my best to make sure all the bugs were discovered and removed, but I can't find them all. If finances are favorable, I may send you the next release at my cost. (See @{"Beta-Testers'" link Beta} Note.) Please, if you send me bug reports, make sure to let me know the type of system you're running it on (CPU, RAM, etc.), which executable you were using, what other programs were running with it (especially commodities and system enhancers, since they tend to gum up the works sometimes), and what you were doing at the time of the bug occurrence/system crash. @{b}EUCALYPTUS IS IN DEVELOPMENT, THE PROGRAM WILL PROBABLY CONTAIN PORTIONS THAT APPEAR NOT TO WORK, DO NOT WORK CORRECTLY OR AS DOCUMENTED, OR MAY CONTAIN BUGS. YOU ARE USING THIS PROGRAM AT YOUR OWN RISK. YOU HAVE BEEN WARNED.@{ub} @endnode @node Beta "Eucalyptus: Beta-testers' note" @toc Main @{fg shine}Beta-Testers' Note@{fg text} This release is an beta version in general public distribution. @{b}EUCALYPTUS IS IN DEVELOPMENT, THE PROGRAM WILL PROBABLY CONTAIN PORTIONS THAT APPEAR NOT TO WORK, DO NOT WORK CORRECTLY OR AS DOCUMENTED, OR MAY CONTAIN BUGS. YOU ARE USING THIS PROGRAM AT YOUR OWN RISK. YOU HAVE BEEN WARNED.@{ub} If you wish to be a beta-tester for future versions of this program, or for any other program I may release, drop @{"me" link me} a postcard or e-mail. I will put you on the list of beta-testers, for which you will receive notification of test-releases and get your fingers first on the newest and neatest stuff. @endnode @node UsingWB "Eucalyptus: Using Eucalyptus from the Workbench" @toc Main @{fg shine}Using Eucalyptus from the Workbench@{fg text} To start Eucalyptus from the Workbench environment, simply double-click on its icon. Eucalyptus's behavior can be modified by using ToolTypes. The following ToolTypes are supported: @{b}SETTINGS=@{i}file@{ui}@{ub} This indicates the settings file to use for Eucalyptus's configuration. If not specified, Eucalyptus will first look in its program directory, then ENV:/ENVARC: for a settings file. @{b}PUBSCREEN=@{i}name@{ui}@{ub} Use this ToolType when you want to open Eucalyptus on another program's existing public screen. The name you supply is the name of the screen on which to open. @{b}PORTNAME=@{i}name@{ui}@{ub} This ToolType gives the name for Eucalyptus's ARexx port, which defaults to EUCALYPTUS. @{b}STARTUP=@{i}name@{ui}@{ub} This ToolType lets you provide the name of an ARexx script to execute when Eucalyptus is started. @{b}QUIET@{ub} This ToolType tells Eucalyptus not to display its initial greeting banner. @endnode @node UsingShell "Eucalyptus: Using Eucalyptus from the Shell" @toc Main @{fg shine}The Shell@{fg text} To start Eucalyptus from the Shell, simply enter its name at the command line, and the program will begin execution. The following options are available from the Shell: @{b}SETTINGS=@{i}file@{ui}@{ub} This indicates the settings file to use for Eucalyptus's configuration. If not specified, Eucalyptus will first look in its program directory, then ENV:/ENVARC: for a settings file. @{b}PUBSCREEN=@{i}name@{ui}@{ub} Use this ToolType when you want to open Eucalyptus on another program's existing public screen. The name you supply is the name of the screen on which to open. @{b}PORTNAME=@{i}name@{ui}@{ub} This ToolType gives the name for Eucalyptus's ARexx port, which defaults to EUCALYPTUS. @{b}STARTUP=@{i}name@{ui}@{ub} This ToolType lets you provide the name of an ARexx script to execute when Eucalyptus is started. @{b}QUIET@{ub} This ToolType tells Eucalyptus not to display its initial greeting banner. @{b}MAIL@{ub} This ToolType tells Eucalyptus to startup in "mail-send mode," which is specifically designed for use with the "mailto:" option in web browsers. "Mail-send mode" causes Eucalyptus to open only a single message composition window. When this window is closed, by sending, postponing or cancelling the message, Eucalyptus will then shutdown. @{b}TO=@{i}name@{ui}@{ub} This argument is used to provide one or more "To" addresses for the message being composed. It is only relevant when used with the "MAIL" switch. @{b}CC=@{i}name@{ui}@{ub} This argument is used to provide one or more "Cc" (carbon copy) addresses for the message being composed. It is only relevant when used with the "MAIL" switch. @{b}BCC=@{i}name@{ui}@{ub} This argument is used to provide one or more "Bcc" (blind carbon copy) addresses for the message being composed. It is only relevant when used with the "MAIL" switch. @{b}SUBJECT=@{i}name@{ui}@{ub} This argument is used to provide the subject for the message being composed. It is only relevant when used with the "MAIL" switch. @{b}REPLYTO=@{i}name@{ui}@{ub} This argument is used to provide a "Reply-To" address for the message being composed. It is only relevant when used with the "MAIL" switch. @endnode @node InitConfig "Eucalyptus: Configuring for first use" @toc Main @{fg shine}Configuring for first use@{fg text} @endnode @node MainWindow "Eucalyptus: The Main Window" @toc Main @{fg shine}The Main Window@{fg text} This is the window from which you begin your e-mail experience with Eucalyptus. It is simply laid-out: a speedbar with a few buttons on the left or top, and a listbrowser that shows you all your folders. Pressing the menu button on your mouse will bring up the available @{"menus" link MainMenu} for the main window. @{b}The Speedbar@{ub} This handy item has a few convenience buttons for doing some common things in Eucalyptus. The following buttons (in the order they appear) currently reside in the speedbar. @{b}NOTE: If the window is not large enough to show all the speedbar buttons, hold down the Shift key, click somewhere in the speedbar, and move the mouse up/down or left/right to scroll through the buttons.@{ub} @{i}Compose a message@{ui} Pressing this button will kick off a new thread wherein you can start @{"composing" link Composing} a new message. @{i}Check for new mail@{ui} This will send a signal to Eucalyptus' mail retrieval thread to check the server for new mail. @{i}Edit addressbook@{ui} This button brings up a window to edit your @{"address book" link AddressBook}. @{i}Create a new folder@{ui} Pressing this will allow you to create a new folder in which to store all those messages you keep getting. (See @{"Folders" link Folders} for more information on maintaining folders.) @{i}Open a folder@{ui} This button will cause the selected folder to open its window. @{i}Edit a folder@{ui} This button will bring up a new window in which you can edit the attributes and various other items about the selected folder. (See @{"Folders" link Folders} for more information on maintaining folders.) @{i}Close a folder@{ui} If the select folder's window is open, this button will tell it to close. @{i}Delete a folder@{ui} This button will delete the selected folder from the folder list. (See @{"Folders" link Folders} for more information on maintaining folders.) @{i}Start online help@{ui} Pressing this will bring up Eucalyptus' online help file, Eucalyptus.guide (what you're reading now). The file should be in either the HELP: assign, or the same directory as Eucalyptus itself. @{b}The Folder List@{ub} This listbrowser is divided into two columns displaying information about your configured folders. The first column shows the name of the folder. To the left of the name may be a small icon (if the folder has sub-folders). Clicking this icon will toggle whether the folder's sub-folders will be shown or hidden in the listbrowser. (See @{"Folders" link Folders} for more information.) The second column shows the number of messages in the folder. It will show the total number of messages, the number of new messages (if there are any), and the number of unread messages (if any). Following this will be the size (in KB) of the folder contents. After that will be an indicator if there are messages in the folder's spool file, if applicable. The folder will be highlighted if there are new messages or messages in its spool file. @endnode @node MainMenu "Eucalyptus: Main menu" @toc MainWindow @{fg shine}Main menu@{fg text} There are five menus in Eucalyptus' main window. They are: @{b}Project@{ub}, @{b}Folder@{ub}, @{b}ARexx@{ub}, @{b}Settings@{ub}, and @{b}Help@{ub}. @{b}Project menu@{ub} From this menu, you can control Eucalyptus' general behavior. @{i}Compose message...@{ui} Starts off a new mail composition thread. (See @{"Composing mail" link Composing} for more information on the options available when composing mail.) @{i}Submit a bug report...@{ui} Starts off a composition thread, just like "Compose message...", but it will use a built-in template that is formatted for your bug-reporting convenience. Hopefully, you'll never have to use this. :) @{i}Get new mail@{ui} Sends a signal to Eucalyptus' "get mail" thread to check for incoming messages. This will reset the mail checking interval. @{i}Open retrieve window...@{ui} Tells Eucalyptus to open the @{"mail retrieval window" link MailRetrieveWindow}, which will allow you to be picky about which mails you want to retrieve from the server. This option is only relevant if you are using the internal POP client and are currently connected to the Internet via a TCP/IP stack, like AmiTCP or Miami. @{i}Send mail@{ui} Sends a signal to Eucalyptus' "send mail" thread to check for outgoing messages. This will reset the mail checking interval. Note that selecting this item will also remove a suspension. @{i}Suspend mail send@{ui} Sets a flag to temporarily suspend (or remove suspension) mail sending. @{i}Stop mail send@{ui} Signals the "send mail" thread to stop sending mail for the current interval. @{i}Hide@{ui} Will close Eucalyptus' main window and place an icon for it on the Workbench. You can double-click this icon to restore the window. @{i}Quit@{ui} Shut down Eucalyptus. @{b}Folder menu@{ub} This menu lets you control various aspects of your folders. @{i}Open...@{ui} @{i}Close@{ui} @{i}New@{ui} @{i}Edit...@{ui} @{i}Delete@{ui} All of these items behave exactly like the corresponding buttons in the @{"main window" link MainWindow}. @{b}ARexx menu@{ub} Allows you to have easy access to your ARexx macros for Eucalyptus. There is only one item in this menu by default, "Execute macro...". This will bring up a file requester, from which you may select the macro to execute. The rest of the menu is user-configurable, via the @{"General" link ConfigGeneral_ARexx} settings panel. You may specify up to 61 ARexx macros to be in this menu. @{b}Settings menu@{ub} This menu gives you access to the settings panels for Eucalyptus. @{i}Enable logging@{ui} Toggles whether you want to have Eucalyptus log its activity/errors to a file on disk. @{i}General...@{ui} Opens the @{"General" link ConfigGeneral} settings panel. @{i}User...@{ui} Opens the @{"User" link ConfigUser} settings panel. @{i}Mail...@{ui} Opens the @{"Mail" link ConfigMail} settings panel. @{i}Address book...@{ui} Opens the @{"Address book" link AddressBook}. @{i}Viewers...@{ui} Opens the @{"Viewers" link ConfigViewers} settings panel. @{i}Filters...@{ui} Opens the @{"Filters" link ConfigFilters} settings panel. @{i}ClassAct...@{ui} Will attempt to start the ClassAct settings program. @{i}Save settings@{ui} Saves the current settings in the last used settings file, or the default file, if none was specified. @{i}Save settings as...@{ui} Brings up a requester, asking which file to which to save the current settings. @{i}Load settings...@{ui} Brings up a requester, asking which file from which you would like to load settings. @{b}Help menu@{ub} This menu lets you find out about informational things about Eucalyptus and access online help. @{i}About...@{ui} @{i}Credits...@{ui} @{i}Miscellaneous...@{ui} These three menu items bring up a requester telling you various things about the program. @{i}Help...@{ui} Brings up the online help file. @endnode @node Folders "Eucalyptus: Folders" @toc Main @{fg shine}Folders@{fg text} This section covers general folder maintenance in Eucalyptus, i.e., creating, deleting and otherwise modifying folders. @{b}Creating a folder@{ub} The first thing that happens when you select this option (via menu or speedbutton) is that you will be prompted to create (or select) a directory for the folder. After a directory is selected, the Folder Information window will be presented (see sub-section "Editing a folder" below). @{b}Editing a folder@{ub} After you initially create, or select for editing, a folder, you will be presented with the @{"Folder Information" link FolderInfo} window. Note that you CANNOT edit a folder's attributes while the folder is open. @{b}Deleting a folder@{ub} This isn't so hard that you need instructions on how to delete a folder, but I wanted to included the fact that there are certain folders in Eucalyptus that @{i}cannot@{ui} be deleted. These folders are: Incoming, Postponed, Outgoing, and Sent. These folders are required for the proper operation of Eucalyptus. @endnode @node FolderWindow "Eucalyptus: Folder window" @toc Main @{fg shine}Folder window@{fg text} Each folder that you configure in Eucalyptus will open with its own window, running in its own process. Folders will remember their last opened size/position and re-open in the same place, if possible. The folder window is made up of four simple items: the speedbar, @{"menu" link FolderMenu}, status bar, and listbrowser. @{b}Speedbar@{ub} This basically provides you with some of the same items available in the menu. They are, in order of appearance: Check spool, Update, Read message, Compose, Reply, Forward, Delete, and Help. @{b}Status bar@{ub} This area tells you what the folder is doing, if it is busy. Otherwise, it tells you how many total messages are in this folder, how many are new and/or unread, and how many are currently selected. @{b}Messages listbrowser@{ub} This is the list of the messages in this folder. The listbrowser is divided into 5 columns: From, Date, Size, Status flags, and Subject. Message that are addressed to you personally, as opposed to messages from, say, a mailing list, are highlighted. Messages with a Priority header of "high" are also highlighted. You can selected the color for these two types in the @{"Mail settings" link ConfigMail} panel. The following symbols are the current supported status flags: N - new message U - unread message (new, but not for this session) R - message has been replied to F - message has been forwarded B - message has been bounced D - message has been deleted P - message is protected from age-deletion The listbrowser allows selection of more than one message at a time. You can do this by shift-clicking on any subsequent messages. It also supports drag-selecting. @endnode @node FolderMenu "Eucalyptus: Folder menu" @toc MainWindow @{fg shine}Folder menu@{fg text} @{b}Folder@{ub} @{i}Check new@{ui} Checks the spool file for the folder, if one is being used, and sends a signal to check mail to Eucalyptus' "get mail" thread. @{i}Send@{ui} Sends a signal to the send process to check for outgoing mail and if there is any, send it. @{i}Refresh@{ui} Rereads the current list of messages for the folder and builds a new index. @{i}Sort@{ui} Applies the current sort type to the folder's message list. @{i}Import...@{ui} Allows you to import one or more message files into the folder. @{i}Apply filters@{ui} Applies the current set of filters against the messages in the folder. @{i}Expunge deleted@{ui} Deletes any messages marked for deletion ('D') from disk. @{i}Hide@{ui} Iconifies the folder window. @{i}Quit@{ui} Closes the folder window and all message windows for the folder. @{b}Message@{ub} @{i}Read...@{ui} Opens a read window for the selected message(s). Asks for verification if more than one message is selected. @{i}Reply...@{ui} @{i}Forward...@{ui} @{i}Bounce...@{ui} Opens a compose thread for replying, forwarding or bouncing the selected message(s). Asks for verification if more than one message is selected. @{i}Print...@{ui} Prints the selected message(s). This item is current unavailable. @{i}Delete@{ui} Sets the delete flag on the selected messages. @{i}Move@{ui} @{i}Copy@{ui} Moves or copies the selected message(s) to another folder. @{i}Get address@{ui} Extracts the "From" or "Reply-To" address from the selected message(s) and adds them to the Address Book. @{i}Select...@{ui} Brings up a window that allows you to @{"select messages" link SelectMsgs} in the folder. @{i}Set status...@{ui} Lets you set the status flags on the selected message(s). @endnode @node SelectMsgs "Eucalyptus: Selecting messages" @toc FolderMenu @{fg shine}Selecting messages@{fg text} With this panel open, you can mass-(un)select messages in the folder by several means. If you input criteria into more than one gadget, you are implying that each message must match ALL the criteria. The two string gadgets, From and Subject, accept AmigaDOS style wildcard patterns. If you don't enter a pattern, Eucalyptus will treat it as a substring match. For example, if you enter "Aminet" in the Subject field, Eucalyptus will match all messages that have the string "Aminet" (case insensitive) in their subject. See your AmigaDOS manual for details on acceptable patterns and how to use them. Selecting "All messages in thread?" tells Eucalyptus that a match against Subject should include matching subjects that may contain "Re:" at their beginning. There are several gadgets to let you specify size comparison. The first gadget, a chooser, allows you to determine how the match will be done. The second, an integer gadget, lets you determine the size to match against, and the last, another chooser, lets you determine how the size is handled that is specified. For example, if you want to match against all messages greater than 5K, you would set the first gadget to "larger than", type "5" into the integer gadget, and set the last gadget to "K". The last group has to do with flags that may be set in the message. Each is a chooser that lets you decide if the flag should be ignored (not matched), if it should match if it is set, or match if unset (clear). At the bottom of the window, you have two buttons: "Select" and "Unselect." Depending on which one you press, matching messages will either be selected or deselected. A status bar just above these buttons tells you how many messages were (un)selected given the current matching criteria. Note that this window does not block input to the folder window, so you may still click around in the folder window while having the Select Message panel opened. @endnode @node SetMsgStatus "Eucalyptus: Set Message Status" @toc Main @{fg shine}Setting Message Status@{fg text} This is a popup window you will get when you want to modify the status flags of messages in a folder. You will get a series of either checkboxes or choosers, depending on whether you have one message or many, respectively, selected in the folder when you bring up this window. Each checkbox/chooser corresponds to one of the settable flags for the message: New, Unread, Replied, Forwarded, Bounced, Deleted, and Don't Delete. All of these flag, except Don't Delete, are set or cleared automatically according to certain actions you perform on the messages. If you get choosers (multiple messages selected), the available settings for each flag are: Ignore (don't modify the flag at all), Set (obvious), and Clear (obvious). Click Okay to make the flags take effect, or click the close gadget to exit the window without making any changes. @endnode @node Msgs "Eucalyptus: Messages" @toc Main @{fg shine}Messages@{fg text} @endnode @node MsgWindow "Eucalyptus: Message window" @toc Main @{fg shine}Message window@{fg text} This sections covers how to use Eucalyptus' internal message reader. When you open up a message, Eucalyptus opens a window with which you may read the message (or various parts of it). In the window is a speedbar, which contains a subset of the options available from the menu, which are: Previous message, Next message, Compose, Reply, Forward, Delete, and Help. At the end of the speedbar is a group of buttons, typically one, sometimes more, depending on the message content. These buttons represent the message and its parts, if it's a multipart message. Each button's image corresponds to the type of attachment it represents. To view a particular attachment, just click on the button corresponding to it. Eucalyptus will process that part of the message, and display it, either via the message window or an external viewer, according to how you have it configured. There are also two display areas in the mesage window. The first, a smaller area, is a listbrowser, that contains the header information for the message. You can set the order you would like the headers displayed, as well as which headers not to display, in the @{"Mail settings" link MailConfig} panel. The second display area shows the actual message itself. On systems running AmigaOS 3.0 or above, this defaults to a datatype for all display purposes, unless you have an external viewer configured. If you would prefer to use a listbrowser for displaying text, then turn off "Use text datatype?" in the @{"Mail settings" link MailConfig} panel. On AmigaOS 2.04/2.1 systems, the message display defaults to the listbrowser. @endnode @node MsgMenu "Eucalyptus: Message menu" @toc MainWindow @{fg shine}Message menu@{fg text} @{b}Message@{ub} @{i}Reply...@{ui} @{i}Forward...@{ui} @{i}Bounce...@{ui} Opens a compose thread for replying, forwarding or bouncing the selected message(s). Asks for verification if more than one message is selected. @{i}Previous...@{ui} @{i}Next...@{ui} Move to the previous/next message in the folder. @{i}Hide@{ui} Iconifies the message window. @{i}Close@{ui} Closes the message window. @{b}Contents@{ub} @{i}Get address@{ui} Extracts the "From" or "Reply-To" address from the message and adds it to the Address Book. @{i}Save text...@{ui} Saves the message text to a file on disk. @{i}Save attachment(s)...@{ui} Saves any attachments to disk. Eucalyptus will present a request that allows you to select which attachments to save. @{i}UUdecode...@{ui} If the message contains uuencoded data, this will decode it and save it to disk. @{b}Security@{ub} @{i}Check signature...@{ui} If this is a signed message, Eucalyptus will attempt to verify the signature. Currently, only PGP signatures are supported. PGP must be installed for this feature to work. @{i}Decrypt...@{ui} Decrypts the message, if it is encrypted, and displays the decrypted text. Currently, only PGP de/encryption is supported. PGP must be installed for this feature to work. Other types of de/encryption, such as S/MIME and MOSS are being considered for possible inclusion into Eucalyptus. @{i}Extract key...@{ui} Extracts any keys included in the message. Currently, only PGP keys are supported. PGP must be installed for this feature to work. @endnode @node Composing "Eucalyptus: Composing mail" @toc Main @{fg shine}Composing mail@{fg text} This section discusses composing e-mail messages, the options available, and the Compose window itself. @{b}The Compose window@{ub} This window is divided into several basic areas: the speedbar, addresses, attachments, reply-to, subject, message text, footer, and security. You can also select options via the window's @{"menu" link ComposeMenu}. @{i}The Speedbar@{ui} Some of the functions available in the menu are also provided in the speedbar. They are, in the order they appear: Send, Queue, Postpone, Check spelling, Editor and Help. @{i}Addresses@{ui} This group is where you determine to whom the message will go. A listbrowser shows the addresses that are currently selected to receive the message. There are two ways to add addresses to this list: clicking the "Add..." button, or typing an address in manually in the string gadget. Addresses added either way will be added according to the type of address selected, To, Cc, or Bcc. Use the chooser to pick the desired one before adding the address(es). To delete an address from the list, select it in the listbrowser and press "Del." When selecting addresses via "Add...", you will get a requester that provides all the addresses available in your address book. You can select multiple addresses from this list. Simply click on the first address, and then shift-click on all subsequent addresses. Click the close gadget to close the window and add them to the list. If you want to add addresses via a group, you do not have to select all the addresses in the group, Simply select the group header. When Eucalyptus builds the message, it will discover and resolve all the addresses in the group. @{i}Attachments@{ui} This is where you add attachments to your messages, like sending a file to a friend, for instance. To add a new attachment, press "New". You will be prompted to select the file to attach, via a standard ASL requester. Once you select the file, another window will come up to give you chance to provide a content description and/or change the MIME type of the file. Eucalyptus will initially attempt to figure out what the file is, but if it can't, the type will default to "application/octet-stream", which is basically MIME's way of say, "I don't know what it is." To edit an existing attachment, select it from the listbrowser, and press "Edit". You will be provided with the same window as when you first added the attachment. To delete an attachment from the list, select it from the listbrowser, and press "Del". You will NOT be asked to confirm this action. @{i}Reply-To@{ui} @{i}Subject@{ui} These two fields are what will appear in the message header. "Reply-To" is provided so that if your the address that should replied to for this mail is different than your From address (you're sending from your friend's account, for example, with his permission of course :), you can provide it here. "Subject" should be self-explanatory. @{i}Message text@{ui} This is where you type in your message. Eucalyptus will take care of line-wrapping and properly formatting the message for you, so don't worry about pressing Enter at the edge of the textfield. @{i}Message footer@{ui} Two items make up the message footer, taglines and signature. Each has a checkbox to the left, so you can select whether they should be added for this message. Taglines, for those unaware, are generally witty remarks provided for your mail recipient's amusement. One will be chosen at random from your tagline file. If you don't like the one selected, simply press "New" and another will be picked. Or you can type in one of your own. Signature file is your own personal stamp on the message. Eucalyptus doesn't impose any guidelines or rules on signature content or length. You can change the selected signature file by clicking the popup button, which will give you a requester to choose another. Pressing the "Edit" button will allow you to edit the file. @{i}Security@{ui} This section is made up of a couple checkboxes and a string gadget. The two checkboxes, Sign and Encrypt, allow you to have Eucalyptus enact certain security measures upon the composed message. Sign tells Eucalyptus to call PGP and have it generate a signature block, in ASCII format, which will be inserted into the message according to RFC 2015. Encrypt tells Eucalyptus to call PGP and have it encrypt the message to the recipients. Key IDs will be automatically extracted from the address book to pass to PGP. If no Key ID is specified for an address, Eucalyptus will give you a chance to provide one. Providing a blank string then will cause the message to not be encrypted to that person. You can also provide additional Key IDs via the string gadget, separated by spaces. @endnode @node ComposeMenu "Eucalyptus: Compose menu" @toc MainWindow @{fg shine}Compose menu@{fg text} @{b}Compose@{ub} @{i}Send@{ui} Writes your message to the Outgoing folder, and signals Eucalyptus' send mail thread to begin processing. @{i}Queue...@{ui} Writes your message to the Outgoing folder, but waits until the next mail cycle comes around to send it. Before the message is written, a small requester will pop up asking for some queuing information. In this request, you can tell Eucalyptus that you want to send the message at specific time, at certain intervals, etc. (See @{"Specifying Queue Information" link QueueInfo} for more information on queuing options. @{i}Postpone@{ui} Writes the message to the Postponed folder for later editing. The message is not written in MIME-compliant format and is not suitable for sending. @{i}Cancel@{ui} Cancels the current message. If you are editing a previously postponed message, you are given the option of re-postponing, removing the postponement altogether, or aborting the cancel. @{b}Edit@{ub} @{i}Undo@{ui} Undoes the last operation. Only one level of undo is supported. @{i}Cut@{ui} Cuts the selected text from the textfield into the clipboard. @{i}Copy@{ui} Copies the selected text from the textfield into the clipboard. @{i}Paste@{ui} Pastes the text currently in the clipboard at the current cursor position in the textfield. @{i}Erase@{ui} Erases the selected text without copying it to the clipboard. @{i}Clear all text@{ui} Erases the entire textfield. @{i}Insert file...@{ui} This will present you with a requester for a file to add to the textfield. It will be added at the current cursor position. @{i}UUencode file...@{ui} This is basically the same thing as "Insert file...", except that the file can be any format (not just text), and the data will be UUencoded into the textfield at the current cursor position. @{i}Save to file...@{ui} Will save the current text in the textfield to a file on disk. You will be asked for a filename. @{b}Misc@{ub} @{i}Check spelling...@{ui} Initiates the spell checker. @endnode @node Menus "Eucalyptus: Menus" @toc Main @{fg shine}Menus@{fg text} @{" Main window " link MainMenu} @{" Folder window " link FolderMenu} @{" Message window " link MsgMenu} @{" Compose window " link ComposeMenu} @endnode @node FolderInfo "Eucalyptus: Folder Information" @toc Main @{fg shine}Folder Information@{fg text} In here, you can determine attributes for the folder. The following options are available in this window: @{i}Name@{ui} This is where you can provide the name for the folder. Avoid naming two or more folders with the same name, as this may have unwanted side effects during message filtering. @{b}NOTE: You may change the names of the special folders (Incoming, Postponed, Outgoing, and Sent) without affecting their special status.@{ub} @{i}Sub-folder of@{ui} Here is where you can set up your folder hierarchy. Use the select gadget at the far right to bring up a list of folders. There is no limit to the number of folder levels you can create. @{i}Folder directory@{ui} This gadget allows you to specify the directory of this folder. @{i}Spool file@{ui} The spool file is where the folder gets its new messages. The only folder that requires a spool file is Incoming; all others are optional. If a spool file is provided, the folder will read from it when it is opened. @{b}Do not specify the same spool for more than one folder.@{ub} @{i}Sort by@{ui} This chooser allows you to specify the sort method that will be used for the folder. The default is Date sorting by newest first. @{i}Open at startup?@{ui} Setting this attribute tells Eucalyptus to open the folder's window when the program starts. @{i}Apply filters on import?@{ui} This attribute tells Eucalyptus to automatically apply filters to the messages in the folder after the initial import when opening the folder window, or when you explicitly tell the folder to import new messages or check its spool file. @{i}Protect messages?@{ui} This attribute tells Eucalyptus to ignore this folder when it goes through and checks mail for age-deletion. @{i}Reverse sort?@{ui} Setting this attribute reverses the sorting algorithm being used. For example, Date sorting is by newest message first. Reversing will cause messages to be sorted by oldest first. @{i}Thread messages?@{ui} This attribute causes messages to be grouped by thread (similar subjects) after sorting is applied. @endnode @node Configure "Eucalyptus: Configure" @toc Main @{fg shine}Configure@{fg text} Configuring Eucalyptus is a snap. Several settings panels are available for you to set up Eucalyptus to suit your needs. @{"General settings" link ConfigGeneral} @{"User settings" link ConfigUser} @{"Mail settings" link ConfigMail} @{"Filter settings" link ConfigFilters} @{"Viewer settings" link ConfigViewers} @endnode @node ConfigGeneral "Eucalyptus: General Settings" @toc Main @{fg shine}General Settings@{fg text} This settings panel lets you configure general program attributes. This panel is broken up into several pages, accessible via the tabs at the top. @{b}General@{ub} This page lets you configure basic settings of Eucalyptus. @{i}ARexx port name@{ui} This is the port name to use for Eucalyptus' main ARexx port, as well as the basename for the two internal mail clients, POP (port name + "_GET") and SMTP (port name + "_SEND"). @{i}Address book@{ui} This is the (path and) filename of the address book file to use. @{i}Auto-sort addresses?@{ui} This lets you determine whether Eucalyptus will attempt to keep the address book sorted when adding new addresses to it, or if you would like to only do it manually. @{i}Ask before quitting?@{ui} This tells Eucalyptus to confirm whether you want to really quit when select quit from the menu or click the close gadget. @{i}Logging@{ui} "Enable logging?" tells Eucalyptus whether to log its actions to a log file. "Old log file" tells Eucalyptus what to do with the old log file from a previous session. "Log file" tells Eucalyptus what file to append/create/use to log its actions. @{i}Priority@{ui} These gadgets you let you determine at what priority the various threads in Eucalyptus will run. @{b}Display@{ub} This page lets you configure display aspects of Eucalytpus. @{i}Screen name@{ui} This field lets you specify the screen on which to open Eucalyptus' windows. It must be a standard Intuition public screen. If you want to run Eucalyptus on its own screen, you can get a screen utility like ScreenWizard. @{i}Window pattern@{ui} This is an image file you would like to use as the backfill pattern for all of Eucalyptus' windows. @{i}Message font@{ui} This is the font to use when displaying message text in the message display windows. @{i}Speedbar placement@{ui} This tells Eucalyptus where to render the speedbar in windows that have one. It affects all windows with speedbars. @{i}Use external imagery?@{ui} If you want to design your own button images for the speedbar buttons, you must enable this swtich to access the images, otherwise Eucalyptus will use its own internal image set. The images are normal icon files, and are found in the "Support/Images" in Eucalyptus' program directory. @{b}Windows@{ub} This page lets you configure the size and position of various windows in Eucalyptus. @{i}Window type@{ui} Use this chooser to select the window size/position you want to edit. @{i}Left@{ui} @{i}Top@{ui} @{i}Width@{ui} @{i}Height@{ui} These settings should be obvious. @{i}Snapshot@{ui} Pressing this button allows you to take a snapshot of the type of window, if it is open. Note that for message and compose windows, it will select the first window in the list, which is hard to say which one it will be, so when doing this, make sure there is only one of that type open. @{i}Handle@{ui} This tells Eucalyptus how to handle the window type for certain types. This only applies to message and compose windows. "Dimensions" will make the window use the set dimensions when opening it. "Center" will make the window open centered on the screen. "Cascade" will attempt to open the window cascaded over another of its kind. If another is not open, it will open in the top-left corner of the screen. @{b}ARexx@{ub} This page allows you to configure the ARexx menu accessible in the main window. The listbrowser shows you the menu items you have configured. @{i}New@{ui} @{i}Del@{ui} These two buttons allow you to create/delete menu items for the ARexx menu. Your action will not be confirmed. @{i}Name@{ui} This is the name that will appear in the menu. It can be anything you want. @{i}Path@{ui} This is the path and script name of the ARexx script to execute when the appropriate menu item is selected. @{b}Misc.@{ub} This page lets you configure miscellaneous other items for Eucalyptus. @{i}PGP program path@{ui} This is the path and filename of your PGP program. Do not specify any switches or parameter in this field. They will be added as necessary. @{i}External editor@{ui} Eucalyptus contains a built-in editor for editing things like your signature, taglines, etc. If you prefer to use your favorite text editor, then specify it here. You can place a '%f' in the command line where you want the filename to be placed, otherwise Eucalyptus will just tack it on to the end of the command line. @{b}Save@{ub} Saves the current settings to disk as well as making them the current session settings. @{b}Use@{ub} Makes the settings the current ones for this session without saving them to disk. @{b}Cancel@{ub} Closes the window without making the changes. @endnode @node ConfigUser "Eucalyptus: User Settings" @toc Main @{fg shine}User Settings@{fg text} This settings panel lets you set the information about yourself. @{b}Real name@{ub} This is your real name, or whatever you want. @{b}E-mail address@{ub} This is your Internet-style e-mail address. @{b}Organization@{ub} Whatever you want. @{b}Home directory@{ub} This is the directory that will be referenced for most of what you do in Eucalyptus. That is, the Mail directory, if not specified as an absolute pathname, will be relative to this directory. Your filters and viewers settings will also be saved in this directory. @{b}Signature file@{ub} This is the default signature file to use when composing messages. It can be changed in the Compose window. @{b}Taglines file@{ub} This is the taglines file to use. This file will be loaded once and kept in memory when you start Eucalyptus. Taglines, if used, are placed just before your signature when generating the message. @{b}Save@{ub} Saves the current settings to disk as well as making them the current session settings. @{b}Use@{ub} Makes the settings the current ones for this session without saving them to disk. @{b}Cancel@{ub} Closes the window without making the changes. @endnode @node ConfigMail "Eucalyptus: Mail Settings" @toc Main @{fg shine}Mail Settings@{fg text} This settings panel lets you configure how Eucalyptus handles message displaying, composing, send and receiving mail, and various other things. This panel is broken up into several pages, accessible via the tabs at the top. @{b}General@{ub} This page lets you configure general mail settings for Eucalyptus. @{i}Mail base directory@{ui} This fields lets you specify the base directory of where your mail will be kept. Folders' directories will be, by default, created relative to this directory. If you don't specify an absolute pathname here, this directory will be relative to your home directory, as specified in User Settings. @{i}Viewers@{ui} This is the (path and) name of the file for your viewers configuration. It defaults to ".mailcap". If no path is specified, Eucalyptus will look in your home directory, as specified in User Settings @{i}Filters@{ui} This is the (path and) name of the file for your filters configuration. It defaults to ".filters". If no path is specified, Eucalyptus will look in your home directory, as specified in User Settings @{i}New mail sound@{ui} This is the sound file that Eucalyptus will play when you have new mail on the server. This only works if you are using internal mail retrieval. @{b}This option is only available on systems running AmigaOS 3.0 or higher.@{ub} @{i}No mail sound@{ui} This is the sound file that Eucalyptus will play if you have no mail on the server. This only works if you are using internal mail retrieval. @{b}Messages@{ub} This page lets you configure more specific message settings for Eucalyptus, particularly in the folder and message read windows. @{i}Header order@{ui} This field holds a semicolon separated list of RFC822/MIME mail headers that will be moved to the top of the header display list in a message read window. Do not put any spaces between the header name and the semicolon. @{i}Hide headers@{ui} This field holds a semicolon separated list of RFC822/MIME mail headers that will be hidden from the header display list in a message read window. Do not put any spaces between the header name and the semicolon. @{i}Date format@{ui} This tells Eucalyptus how you would like the date displayed in the message listbrowser for each folder. Format codes are specified via the C printf-style '%' format specifiers. The following case-sensitive specifiers are supported. Note that date/time strings will be locale-specific, if running OS 2.1 or above. % - A percent character ('%'). n - The month in abbreviated three-letter format (e.g., Jan, Feb, etc.). N - The month spelled out in its entirety. o - The ordinal number of the month (e.g., 1=Jan, 2=Feb, etc.). O - The ordinal number of the month, always 2 digits. d - The day of the month. D - Day of the month, always 2 digits. a - The day of the week, in abbreviate three-letter format (e.g., Mon, Tue, Wed, etc.). A - The day of the week, spelled out in its entirety. y - The 4-digit year. Y - The 2-digit year. h - The hour H - The hour, always 2 digits m - The minute M - The minute, always 2 digits s - The seconds S - The seconds, always 2 digits @{i}Start replies with@{ui} @{i}Start fowards with@{ui} Either of these fields let you specify the prefacing text when generating the corresponding type of message. Format codes are specified via the C printf-style '%' format specifiers. The following case-sensitive specifiers are supported: n - Name of person to whom you are replying N - Your name a - Address of the person to whom you are replying A - Your address O - Your organization d - The current date s - Subject of the message In addition, the following escape sequences are supported (these are the backslash ('\\') followed by a single character): \\ - Backslash n - Newline t - Tab character @{i}Quote prefix@{ui} This is one or more characters which will be placed in front of every line of the original message when replying to it. A space will automatically be added between the quote character and the text. @{i}Wrap text after column@{ui} When generating message text, Eucalyptus will wrap lines at or beyond this column and continue on the next line. @{i}Delete mail after (days)@{ui} This is the number of days any messages will be kept in any mail folder. Any messages found older than this will be deleted. "0" keeps all messages. There are ways of protecting messages from deletion, both individually and per folder. You can turn on a folder's Protect Messages attribute (in the @{"Folder Info" link FolderInfo} window), which will protect all of that folder's messages from being deleted by age deletion. You can also set the Don't Delete attribute for each message individually via the @{"Set Message Status" link SetMsgStatus} window. @{i}Personal@{ui} This is the color of the message item in the folder's listbrowser for messages that are addressed directly to you. Your e-mail address, as specified in User Settings, will be matched against the To address of the message header. This allows you to differentiate between mailing list mail and messages directly addressed to you. @{i}Priority@{ui} This is the color of the message item in the folder's listbrowser for messages that contain a Priority header of "high." @{i}Expunge deleted?@{ui} Selecting this item tells Eucalyptus to expunge (permanently delete) messages marked as deleted from the folder. @{i}Auto-open first new/unread message?@{ui} When this item is selected, Eucalyptus will search for and open the first new or unread message in the folder. @{i}Disable return-receipts?@{ui} Selecting this item tells Eucalyptus not to generate a return-receipt for messages that request one. @{i}Use text datatype?@{ui} If you are using AmigaOS 3.0 or better, Eucalyptus will display messages in the message read window, by default, using the datatype subsystem. Deselecting this item will allow you to use the listbrowser to display text. This is the default behavior for 2.0/2.1 systems. @{b}Composing@{ub} This page lets you configure settings for composing messages in Eucalyptus. @{i}Default Reply-To@{ui} In this field you can supply the address that will be placed in the "Reply-To" header of your messages. This value can be overridden in the Compose window itself. @{i}End-of-line type@{ui} Using this chooser, you can specify the end-of-line type that will be used when generating messages. The RFC822/MIME specifications dictate the use of CR/LF for messages, but if you are using, for example, UUCP's sendmail, which has a tendency to choke on CR/LF's, this is where you would change that. It is recommended that unless you are doing something of this sort, you leave this setting alone. @{i}Use tagline?@{ui} This tells Eucalyptus whether to place a tagline in the message body, by default. This setting can be overridden in the Compose window. @{i}Use signature?@{ui} This tells Eucalyptus whether to place your signature file in the message body, by default. This setting can be overridden in the Compose window. @{b}Send@{ub} This page lets you configure how Eucalyptus will send outgoing mail. @{i}Type@{ui} This is the set of radio-buttons at the far left of the window. From this list, you select how you want Eucalyptus to handle your outgoing mail. Currently, Eucalyptus supports internal sending via SMTP, command execution and sending an ARexx command to a port. In the group to the right of it, you set configure how Eucalyptus will handle the mail depending on the type you selected. The appropriate action will be taken every time the mail send interval occurs. @{i}Internal@{ui} provides you with two gadgets: "Server" and "Port." Enter the name of your SMTP mail server in "Server." "Port" holds the port number on which Eucalyptus communicates with the server. Typically, this is 25 (the default), so you shouldn't have to change this. @{i}Command@{ui} provides you with a single gadget: "Command." Enter the command you want executed to send mail. You MUST place a '%f' in the command line where you want the filename of the message file placed for the command. @{i}Arexx port@{ui} provides you with a single gadget: "ARexx port/command." The syntax for this field is this: "portname; command." Enter the port name to which to send the command, followed by a semicolon, and then the command to send. @{i}Send window is@{ui} This lets you tell Eucalyptus whether you want the send mail window open and at what points. @{i}Mail send interval@{ui} This is the interval, in minutes, of how often Eucalyptus will check its Outgoing folder for mail waiting to be sent. Set this to 0 to not check at all. @{i}Send mail on startup?@{ui} Setting this tells Eucalyptus to check for awaiting outgoing mail on startup. @{b}Receive@{ub} This page lets you configure how Eucalyptus will receive incoming mail. @{i}Type@{ui} This is the set of radio-buttons at the far left of the window. From this list, you select how you want Eucalyptus to handle your incoming mail. Currently, Eucalyptus supports internal receiving via POP3, command execution and sending an ARexx command to a port. In the group to the right of it, you set configure how Eucalyptus will handle fetching mail depending on the type you selected. The appropriate action will be taken every time the mail send interval occurs. @{i}Internal@{ui} provides you with a listbrowser and assorted other gadgets for configuring your mail servers. The listbrowser is divided up into four columns: server name, port number, username, and protocol. Use the "New" and "Del" buttons to create/delete your servers. Your actions will not be confirmed. After you press "New," a blank server entry will be created, for which you must provide the appropriate information. "Server" holds the address of the mail server in question. "Port" is the port number on which Eucalyptus will communicate with the server. Typically this is port 110 for POP3 servers. "Username" is the username of your mailbox on the server. "Password" is the password for your mailbox on the server. This will show as *'s in the gadget. "Use APOP?" lets you specify APOP authentication for the server, as opposed to the standard USER/PASS authentication. "Delete mail on server?" tells Eucalyptus to delete each successfully downloaded message after it is retrieved. "Automatically retrieve mail?" tells Eucalyptus that after it connects to the server and retrieves the headers, to automatically start downloading them instead of waiting for your approval to do so. "Retrieve window is" tells Eucalyptus how to handle the Incoming Mail window when attempting to retrieve mail. This window is only relevant to internal main retrieval. @{i}Command@{ui} provides you with a single gadget: "Command." Enter the command you want executed to receive mail. @{i}Arexx port@{ui} provides you with a single gadget: "ARexx port/command." The syntax for this field is this: "portname; command." Enter the port name to which to send the command, followed by a semicolon, and then the command to send. @{i}Mail retrieve interval@{ui} This is the interval, in minutes, of how often Eucalyptus will check your mail server(s) for mail waiting to be fetched. Set this to 0 to not check at all. @{i}Get mail on startup?@{ui} Setting this tells Eucalyptus to check for awaiting incoming mail on startup. @{b}Save@{ub} Saves the current settings to disk as well as making them the current session settings. @{b}Use@{ub} Makes the settings the current ones for this session without saving them to disk. @{b}Cancel@{ub} Closes the window without making the changes. @endnode @node ConfigFilters "Eucalyptus: Filters" @toc Main @{fg shine}Filters@{fg text} This settings panel lets you set up your message filters. This panel is made up of a listbrowser which displays your filters, and some gadgets below it with which you manipulate the filters. The listbrowser is broken into columns as follows: filter priority, header, pattern, action, and action data. @{b}New@{ub} @{b}Del@{ub} With these two buttons, you create and delete your filters. You will not be asked for confirmation of your actions. @{b}Header@{ub} This string gadget lets you input the RFC822/MIME header field to check for a match for the filter. Next to it is a dropdown button from which you may choose some common message headers. @{b}Pattern@{ub} In this gadget, you input the string/pattern to match against the header's data. The pattern should be a valid AmigaDOS pattern. Consult your manual for details on valid pattern characters. @{b}Priority@{ub} With this gadget, you can determine the priority of the filter in the list. Valid priorities are 127 (highest) to -128 (lowest). @{b}Action@{ub} This gadget is actually made up of three gadgets: a chooser, a string gadget and an action popup. In the chooser, select the action you would like taken with any message that matches this filter. Some actions require a parameter, such as folder name, or a filename. You can input this manually, or with the popup button on the far right. The popup will bring up the appropriate request according to the action, i.e., a list of folders, a file requester, etc. @{b}Disabled?@{ub} With this gadget, you can disable the selected filter without having to delete it from the list. Disabled filters will not be checked when applying filters is accomplished. @{b}Saving@{ub} Your filters will be saved when you exit this window. @endnode @node ConfigViewers "Eucalyptus: Viewers" @toc Main @{fg shine}Viewers@{fg text} This settings panel lets you configure external viewers for use in message reading. This panel is made up of a listbrowser which displays your viewers, and some gadgets below it with which you manipulate the viewers. The listbrowser is broken into columns as follows: MIME type/pattern, command, preprocess command. @{b}New@{ub} @{b}Del@{ub} With these two buttons, you create and delete your viewers. You will not be asked for confirmation of your actions. @{b}Type@{ub} This field allows you to input the MIME type to pass to the configured viewer. This can be a full valid type, e.g., image/jpeg, or a pattern. The only valid pattern character is the '*', which may only be used at the end of a type or sub-type. For instance, "image/*", "video/x-*" and "*" are all valid patterns. The '*' character cannont be used at the beginning or in the middle of a type specification. A dropdown button to the far right of this field can be used to select some common MIME types/patterns. @{b}Action@{ub} This field accepts a command to be executed when the matching type is encountered. There are substitutable parameters for this field, in the form of C printf-style format specifiers. Each specifier is two characters, the first being a '%' and the second being a case-sensitive character identifier. The following are supported: f - Filename of data file which Eucalyptus produces. % - Places a '%' in the specifier's place. All other characters are reproduced literally. @{b}Preprocessor@{ub} This field allows you to set a preprocessor command. The purpose of this is to allow you to filter the displayed data through something before it is passed to the viewer/Eucalyptus for display. This would allow you to, for example, pass message text to an ARexx script which will add ANSI highlighting sequences to the text for quoting, bold, italics, etc, which are displayable via datatypes and some text viewers. Note that this command sequence will be executed whether there is a viewer action configured or not, which allows you to preprocess text before it is displayed by Eucalyptus itself. @{b}Saving@{ub} Your viewers will be saved when you exit this window. @endnode @node AddressBook "Eucalyptus: Address Book" @toc Main @{fg shine}Address Book@{fg text} Eucalyptus includes a lovely little address book for your e-mail address storage enjoyment. This section discusses the options available, in order to derive the maximum amount of pleasure from using your Address Book. The window is divided into three basic sections: the address list, maintenance buttons, and address information. @{b}The Address List@{ub} This is a two-column listbrowser that shows all the addresses in your address book. It supports a two-level address hierarchy (groups). The four arrow buttons on the side of the listbrowser allow you to move the selected address to the top of the list, up one, down one, or to the bottom of the list, respectively. @{b}Maintenance buttons@{ub} The following buttons let you edit the contents of your address book. @{i}New@{ui} This button adds a new address entry into the list. @{i}New member@{ui} This button adds a new entry into the currently selected address group. @{b}NOTE: A group is selected if either the group header or any member of the group is selected.@{ub} @{i}Delete@{ui} Deletes the selected address. If a group header is selected, then all members of the group will be deleted as well. Use this option with care. (See the "Group?" option below for information on preserving group members when deleting a group header.) @{i}Sort@{ui} @{i}Sort group@{ui} These two buttons will do an explicit sort of either the whole list, or the selected group, respectively. @{i}Move to...@{ui} @{i}Copy to...@{ui} These two buttons allow you to move/copy an address or group of addresses to another group or into the main group. After you select the desired address/group, and press one of these, you will be presented with a requester for you to choose the destination group. @{b}Address Information@{ub} This group of gadgets lets you edit the information about the selected address. @{i}Name@{ui} Put the name of the addressee here. This is the group name (per RFC 822) when sending messages to a list of addresses. @{i}Address@{ui} This is the Internet-style (user_name@domain) address of the addressee. This is the part that really counts. This field is irrelevant for group headers. @{i}Comments@{ui} This field is provided for your own personal use. This field is not available for group members. @{i}Key ID@{ui} This field lets you specify the key ID for encrypting the message to this particular user. @{i}Group?@{ui} This attribute determines whether the address entry is a group header or just a regular address entry. If you deselect this option on a group header that contains members, you will be given the option of totally obliterating the group members, making the members part of the root address list, or cancelling. Use this option with care. @endnode @node GetSendMail "Eucalyptus: Getting and sending mail" @toc Main @{fg shine}Getting and sending mail@{fg text} This section will attempt to provide you with information on how to get Eucalyptus configured for sending and receiving mail. @{b}Sending mail@{ub} Eucalyptus will attempt to send mail, in whatever manner you specify, at the configured interval. If you want to get Eucalyptus to send mail before the interval is up, you can do so using the appropriate button in the main window, as well as from the menu, or pressing "Send" in the Outgoing Mail window. @{i}Using the internal SMTP client@{ui} To use Eucalyptus' internal SMTP client, you must first configure the server's address and port number. You do this in the @{"Mail Settings" link ConfigMail} panel under the Send tab, and select "Internal" as the type. Enter the name of your mail server in the Server field. Unless your server uses another port, you should leave the port number as 25. For more information on the Outgoing Mail window itself, see @{"Send mail window" link SendWindow}. @{i}Using the command option@{ui} This field allows you to specify the command you would like Eucalyptus to execute in order to send your mail. This option allows you to specify one format specifier, "%f", which will be replaced by the filename of the message being sent. Eucalyptus executes this command, synchronously, once per waiting message file. The current directory for the command is the Outgoing message folder. Upon successful return from the command, the message file is moved to the Sent folder, so if the sending client wishes to queue the message, it must make a copy of it for its own use. An example of a command might be: SMTPpost >NIL: <%f @{i}Using the ARexx port@{ui} You can easily tell Eucalyptus to send an ARexx message to another program to take care of sending mail. The format of this field is simple: "portname; command". Type the name of the ARexx to which to send the command, a semicolon, and the command to send. Eucalyptus does nothing else as far as letting the sending client know how many messages are waiting, what directory they are in, or what the filenames are. Nor does it move the messages to the Sent folder after the command is sent. So this information must be configurable in the desired client. For these configuration purposes, the message files are standard MIME messages, using the following naming convention: "msgXXXXXXXX", where XXXXXXXX is an 8-digit hexadecimal number. @{b}Receiving mail@{ub} Eucalyptus will attempt to fetch mail, in whatever manner you specify, at the configured interval. If you want to get Eucalyptus to fetch mail before the interval is up, you can do so using the appropriate button in the main window, as well as from the menu, or pressing "Retrieve" in the Incoming Mail window. For more information on the Incoming Mail window itself, see @{"Receive mail window" link ReceiveWindow}. @{i}Using the internal POP client@{ui} Eucalyptus allows you to configure multiple POP servers from which to retrieve your mail. For details on what each of the configuration fields mean, see the @{"Mail settings" link ConfigMail} window. @{i}Using the command option@{ui} This field allows you to specify the command you would like Eucalyptus to execute in order to receive your mail. No format specifiers are permitted. The command is simply executed, synchronously. @{i}Using the ARexx port@{ui} You can easily tell Eucalyptus to send an ARexx message to another program to take care of fetching mail. The format of this field is simple: "portname; command". Type the name of the ARexx to which to send the command, a semicolon, and the command to send. This option is especially suited for use with external clients like AmiPOP. The easiest configuration is to set the POP client to write to a certain spool file, and then set your Incoming folder to point to that for its spool file. @endnode @node SendWindow "Eucalyptus: Send mail window" @toc Main @{fg shine}Send mail window@{fg text} @endnode @node ReceiveWindow "Eucalyptus: Receive mail window" @toc Main @{fg shine}Receive mail window@{fg text} @endnode @node ARexx "Eucalyptus: ARexx" @toc Main @{fg shine}ARexx@{fg text} This section deals with Eucalyptus' ARexx ports. There are four different types of ports: the main port (default: EUCALYPTUS), the mail retrieve port (default: EUCALYPTUS_GET), the mail send port (default: EUCALYPTUS_SEND), and mail composition ports (default: COMPOSE.#). @{b}The main port@{ub} This section details the commands available in Eucalyptus' main ARexx port. @{"AddressBook" link rxAddressBook} @{"CheckMail" link rxCheckMail} @{"Close" link rxClose} @{"CmdShell" link rxCmdShell} @{"Compose" link rxCompose} @{"Delete" link rxDelete} @{"Edit" link rxEdit} @{"EditAddress" link rxEditAddress} @{"ExecuteScript" link rxExecuteScript} @{"Help" link rxHelp} @{"Hide" link rxHide} @{"LoadSettings" link rxLoadSettings} @{"New" link rxNew} @{"NewAddress" link rxNewAddress} @{"Open" link rxOpen} @{"Quit" link rxQuit} @{"RestoreDefaults" link rxRestoreDefaults} @{"Rx" link rxRx} @{"RxCommand" link rxRxCommand} @{"SaveSettings" link rxSaveSettings} @{"Select" link rxSelect} @{"SendMail" link rxSendMail} The following commands, while part of the main ARexx port, are specifically geared toward folder operations. They are only relevant after a Select command. @{"Import" link rxImport} ??? @{b}The mail retrieval port@{ub} This section details the commands available in Eucalyptus' mail retrieval ARexx port. @{"Check" link rxpCheck} @{"CloseWindow" link rxpCloseWindow} @{"Iconify" link rxpIconify} @{"OpenWindow" link rxpOpenWindow} @{"Update" link rxpUpdate} @{b}The mail send port@{ub} This section details the commands available in Eucalyptus' mail send ARexx port. @{"Check" link rxsCheck} @{"CloseWindow" link rxsCloseWindow} @{"Iconify" link rxsIconify} @{"OpenWindow" link rxsOpenWindow} @{"Update" link rxsUpdate} @{b}The composition port@{ub} This section details the commands available in Eucalyptus' composition ARexx ports. Each mail composition process has one of these ports, which is mainly used for interfacing with the spell checker, but can be used for other things. @{"Address" link rxcAddress} @{"Attachment" link rxcAttachment} @{"Cancel" link rxcCancel} @{"CheckSpelling" link rxcCheckSpelling} @{"Editor" link rxcEditor} @{"Postpone" link rxcPostpone} @{"Queue" link rxcQueue} @{"Send" link rxcSend} @endnode @node rxQuit "Eucalyptus: ARexx (Quit)" @toc ARexx @{i}Quit@{ui} Syntax: Quit Description: Tells Eucalyptus to shutdown. This command is simple enough to understand, I think. :) @endnode @node rxNew "Eucalyptus: ARexx (New)" @toc ARexx @{i}New@{ui} Syntax: New folder dir [PARENT folder-name] [SPOOL file] [SORT type] [REVERSE] [STARTUP] [FILTERS] [THREADS] Description: Create a new folder. This command will add a new folder to the current list of folders. folder is the name you want to give the new folder. dir is the directory which the folder should use to store its mail messages. This can be either an absolute pathname or a relative path (derived from the Mail directory setting). PARENT folder-name tells Eucalyptus to make this folder a hierarchical child to the specified folder. If the folder doesn't exist, it will be a root-level folder. SPOOL file lets you specify a spool file for this folder to check upon opening. A spool file is only required for the Incoming folder. All other folders are optional. SORT type lets you determine how the folder will sort its messages. Allowed types are: NONE, DATE, NAME, SUBJECT, SIZE, STATUS. REVERSE tells the folder to reverse the sort key determined by the SORT option. This has no effect for sort-type NONE. STARTUP tells Eucalyptus that this folder should be opened when the program initially starts. FILTERS tells Eucalyptus ??? THREADS tells the folder that after sorting, messages should be grouped according to thread (matching subjects). Note that while Eucalyptus doesn't check for duplicated names, you are encouraged not to give two or more folders the same name. This could result is ambiguity when select a folder for operation. @endnode @node rxOpen "Eucalyptus: ARexx (Open)" @toc ARexx @{i}Open@{ui} Syntax: Open folder Description: Open a folder. This command tells Eucalyptus to open the folder specified by folder. @endnode @node rxEdit "Eucalyptus: ARexx (Edit)" @toc ARexx @{i}Edit@{ui} Syntax: Edit folder [dir] [PARENT dir] [SPOOL file] [SORT type] [[NO]REVERSE] [[NO]STARTUP] [[NO]FILTERS] [[NO]THREADS] Description: Edit a folder's attributes. This command lets you edit the attributes of a folder. folder is the name you want to give the folder. dir is the directory which the folder should use to store its mail messages. This can be either an absolute pathname or a relative path (derived from the Mail directory setting). PARENT folder-name tells Eucalyptus to make this folder a hierarchical child to the specified folder. If the folder doesn't exist, it will be a root-level folder. SPOOL file lets you specify a spool file for this folder to check upon opening. A spool file is only required for the Incoming folder. All other folders are optional. SORT type lets you determine how the folder will sort its messages. Allowed types are: NONE, DATE, NAME, SUBJECT, SIZE, STATUS. REVERSE tells the folder to reverse the sort key determined by the SORT option. This has no effect for sort-type NONE. Specifying the NO version of this parameter will shut off this attribute. STARTUP tells Eucalyptus that this folder should be opened when the program initially starts. Specifying the NO version of this parameter will shut off this attribute. FILTERS tells Eucalyptus that after importing message into this folder, filters should be applied. Specifying the NO version of this parameter will shut off this attribute. THREADS tells the folder that after sorting, messages should be grouped according to thread (matching subjects). Specifying the NO version of this parameter will shut off this attribute. @endnode @node rxClose "Eucalyptus: ARexx (Close)" @toc ARexx @{i}Close@{ui} Syntax: Close folder Description: Close a folder's window. Tells Eucalyptus to close the specified folder's window. This command is asynchronous, so a folder's window may not yet be closed when the command returns. @endnode @node rxDelete "Eucalyptus: ARexx (Delete)" @toc ARexx @{i}Delete@{ui} Syntax: Delete folder Description: Delete a folder. This command lets you delete a folder from the list. Note that required folders (Incoming, Postponed, Outgoing, Sent) cannot be deleted. @endnode @node rxCompose "Eucalyptus: ARexx (Compose)" @toc ARexx @{i}Compose@{ui} Syntax: Compose [TO address [...]] [CC address [...]] [BCC address [...]] [SUBJECT text] [REPLYTO address] [FILE file] [SEND] [QUEUE] Description: Start a new composition process. @{b}NOT IMPLEMENTED YET@{ub} @endnode @node rxCheckMail "Eucalyptus: ARexx (CheckMail)" @toc ARexx @{i}CheckMail@{ui} Syntax: CheckMail Description: Signal the retrieval process to check for new mail. This command sends an asynchronous signal to the retrieval process to check for new incoming mail. There are more specific commands that you can use to manipulate the retrieval process via its own ARexx port. @endnode @node rxSendMail "Eucalyptus: ARexx (SendMail)" @toc ARexx @{i}SendMail@{ui} Syntax: SendMail Description: Signal the send process to send any waiting mail. This command sends an asynchronous signal to the send process to check for awaiting outgoing mail. There are more specific commands that you can use to manipulate the send process via its own ARexx port. @endnode @node rxAddressBook "Eucalyptus: ARexx (AddressBook)" @toc ARexx @{i}AddressBook@{ui} Syntax: AddressBook [CLOSE] Description: Open/close the address book window. This command lets you open and close the address book window. @endnode @node rxNewAddress "Eucalyptus: ARexx (NewAddress)" @toc ARexx @{i}NewAddress@{ui} Syntax: NewAddress name address [COMMENTS text] [GROUP|MEMBER group] [KEYID id] Description: Add a new address to the address book. This command adds an address to the address book. name is the regular name of the person or group. address is the Internet-style address of the person. When creating a group, specify a blank string ("") for this parameter. COMMENTS text let you specify comments for this entry. GROUP tells the address book that this entry is a group header and not an individual address. This option is mutually-exclusive to MEMBER. MEMBER group lets you specify to which group to add this address as a member. KEYID id lets you specify the (PGP) key ID value of this person. This is used when encrypting messages to this person. @endnode @node rxEditAddress "Eucalyptus: ARexx (EditAddress)" @toc ARexx @{i}EditAddress@{ui} Syntax: EditAddress name [address] [COMMENTS text] [GROUP|MEMBER group] [KEYID id] Description: Edit an address in the address book. @{b}NOT IMPLEMENTED YET@{ub} @endnode @node rxImport "Eucalyptus: ARexx (Import)" @toc ARexx @{i}Import@{ui} Syntax: Import dir [file-pattern ...] [NOFILTERS] Description: Import messages to a folder. This command allows you to import messages from other mail programs. dir lets you specify a directory to search for message files. The default is to attempt to import all files in a directory. See also the PATTERN option. file-pattern ... lets you specify the file pattern to use when importing message files. This allows you to narrow down the import to files of only a certain filename. The pattern should be a valid AmigaDOS-style pattern. Multiple files and/or patterns are allowed. NOFILTERS tells Eucalyptus not to apply filters to the new messages when it is done importing. @endnode @node rxSelect "Eucalyptus: ARexx (Select)" @toc ARexx @{i}Select@{ui} Syntax: Select folder Description: Select a folder for further action. Tells Eucalyptus to make the specified folder the current. This command is used to set the folder to which to issue folder-specific commands. @endnode @node rxHelp "Eucalyptus: ARexx (Help)" @toc ARexx @{i}Help@{ui} Syntax: Help Description: Start online help. Starts the online help thread and brings up Eucalyptus.guide for your viewing pleasure. @endnode @node rxHide "Eucalyptus: ARexx (Hide)" @toc ARexx @{i}Hide@{ui} Syntax: Hide Description: Iconify Eucalyptus' main window. Attempts to close the main window and place an icon for it on the Workbench. @endnode @node rxCmdShell "Eucalyptus: ARexx (CmdShell)" @toc ARexx @{i}CmdShell@{ui} Syntax: CmdShell [console-spec] Description: Start a new shell process. @{b}NOT IMPLEMENTED YET@{ub} @endnode @node rxExecuteScript "Eucalyptus: ARexx (ExecuteScript)" @toc ARexx @{i}ExecuteScript@{ui} Syntax: ExecuteScript script Description: Start an AmigaDOS script. @{b}NOT IMPLEMENTED YET@{ub} @endnode @node rxRx "Eucalyptus: ARexx (Rx)" @toc ARexx @{i}Rx@{ui} Syntax: Rx script Description: Start an ARexx script. @{b}NOT IMPLEMENTED YET@{ub} @endnode @node rxRxCommand "Eucalyptus: ARexx (RxCommand)" @toc ARexx @{i}RxCommand@{ui} Syntax: RxCommand port command Description: Send an ARexx command to a specific port. @{b}NOT IMPLEMENTED YET@{ub} @endnode @node rxRestoreDefaults "Eucalyptus: ARexx (RestoreDefaults)" @toc ARexx @{i}RestoreDefaults@{ui} Syntax: RestoreDefaults Description: Restore Eucalytpus' settings to the defaults. Restores settings to the Eucalyptus defaults. Note that the defaults will remove your mail server entries. @endnode @node rxLoadSettings "Eucalyptus: ARexx (LoadSettings)" @toc ARexx @{i}LoadSettings@{ui} Syntax: LoadSettings file Description: Load a settings file. Loads settings in from the specified file. @endnode @node rxSaveSettings "Eucalyptus: ARexx (SaveSettings)" @toc ARexx @{i}SaveSettings@{ui} Syntax: SaveSettings [file] Description: Save the current settings. Saves the current session settings to either your default prefs file, or the file you specify. @endnode @node rxpCheck "Eucalyptus: ARexx (Check)" @toc ARexx @{i}Check@{ui} Syntax: Check Description: Check for new incoming mail. Tells the retrieval process to, depending on the option being used, retrieval mail from the configured mail servers, execute a command, or send an ARexx command to a port. In the case of the internal mail retrieval, this command, as opposed to Update, will check for and retrieve new mail on the servers. @endnode @node rxpUpdate "Eucalyptus: ARexx (Update)" @toc ARexx @{i}Update@{ui} Syntax: Update Description: Update the status window. Gets an update of what mail is waiting to be retrieved on the mail servers and displays it in the mail retrieval window. This command is useless if internal mail retrieval is not configured. This command, as opposed to Check, will check for and, if the server supports it, gather header informaion on the messages waiting on the servers. @endnode @node rxpOpenWindow "Eucalyptus: ARexx (OpenWindow)" @toc ARexx @{i}OpenWindow@{ui} Syntax: OpenWindow Description: Open the retrieval window. Tells the retrieval process to opens its window. @endnode @node rxpIconify "Eucalyptus: ARexx (Iconify)" @toc ARexx @{i}Iconify@{ui} Syntax: Iconify Description: Iconify the retrieval window. Tells the retrieval process to attempt to iconify its window. @endnode @node rxpCloseWindow "Eucalyptus: ARexx (CloseWindow)" @toc ARexx @{i}CloseWindow@{ui} Syntax: CloseWindow Description: Close the retrieval window. Tells the retrieval process to close its window. @endnode @node rxsCheck "Eucalyptus: ARexx (Check)" @toc ARexx @{i}Check@{ui} Syntax: Check Description: Check for and send any waiting mail. Tells the send process to scan the Outoing folder for any mail waiting to be sent, and if some exists, act according to the send options configured. This could be by connecting to an SMTP server, executing a command, or sending a command to an ARexx port. @endnode @node rxsUpdate "Eucalyptus: ARexx (Update)" @toc ARexx @{i}Update@{ui} Syntax: Update Description: Update the status window. Tells the send process to scan the Outgoing folder for any mail waiting to be sent, and update the window. This command does not send the mail. @endnode @node rxsOpenWindow "Eucalyptus: ARexx (OpenWindow)" @toc ARexx @{i}OpenWindow@{ui} Syntax: OpenWindow Description: Open the send window. Tells the send process to open its window. @endnode @node rxsIconify "Eucalyptus: ARexx (Iconify)" @toc ARexx @{i}Iconify@{ui} Syntax: Iconify Description: Iconify the send window. Tells the send process to attempt to iconify its window. @endnode @node rxsCloseWindow "Eucalyptus: ARexx (CloseWindow)" @toc ARexx @{i}CloseWindow@{ui} Syntax: CloseWindow Description: Close the send window. Tells the send process to close its window. @endnode @node rxcAttachment "Eucalyptus: ARexx (Attachment)" @toc ARexx @{i}Attachment@{ui} Syntax: Attachment file [TYPE mime-type] [ENCODING type] [DESC[RIPTION] text] Description: Add an attachment to a message being composed. @{b}NOT IMPLEMENTED YET@{ub} @endnode @node rxcAddress "Eucalyptus: ARexx (Address)" @toc ARexx @{i}Address@{ui} Syntax: Address address [CC|BCC] Description: Add a recipient address to a message being composed. Adds the @{i}address@{ui} to the list of recipients for the message. Use the CC or BCC switch to specify the address as a (blind) carbon copy. @endnode @node rxcSend "Eucalyptus: ARexx (Send)" @toc ARexx @{i}Send@{ui} Syntax: Send Description: Send the message. Tells the compose thread to save the current message to the Outoing folder, and send a signal to the send process to send it right away. @endnode @node rxcQueue "Eucalyptus: ARexx (Queue)" @toc ARexx @{i}Queue@{ui} Syntax: Queue Description: Queue the message. Tells the compose thread to save the current message to the Outoing folder, but do nothing futher with it for now. @endnode @node rxcPostpone "Eucalyptus: ARexx (Postpone)" @toc ARexx @{i}Postpone@{ui} Syntax: Postpone Description: Postpone the message. Writes the current message to the Postponed folder, so you can work on it later. @endnode @node rxcCheckSpelling "Eucalyptus: ARexx (CheckSpelling)" @toc ARexx @{i}CheckSpelling@{ui} Syntax: CheckSpelling Description: Initiate the spell checker. @{b}NOT IMPLEMENTED YET@{ub} @endnode @node rxcEditor "Eucalyptus: ARexx (Editor)" @toc ARexx @{i}Editor@{ui} Syntax: Editor Description: Start the external editor. If you have an external editor configured, this will start it, allowing you to edit the message body in the editor. When the editor exits, Eucalyptus will attempt to read the file back into its own editor. If you editor runs asynchronously, you must provide a switch in the editor command line (in General settings) to make the editor wait until you are done editing the text before it returns. Otherwise this option will not work. @endnode @node rxcCancel "Eucalyptus: ARexx (Cancel)" @toc ARexx @{i}Cancel@{ui} Syntax: Cancel [FORCE] Description: Cancel the current message. Tells the compose process to discard this message. If you were resuming a previously postponed message, Eucalyptus will ask if you just want to quit this compose or discard the postponed message altogether. FORCE tells Eucalyptus not to ask if you're sure you want to cancel the message. @endnode @node ClassAct "Eucalyptus: Using ClassAct gadgets" @toc Main @{fg shine}Using ClassAct gadgets@{fg text} The purpose of this section is to inform you of all the neat features of which the ClassAct gadgets are capable. @{b}General@{ub} @{i}Right-mouse-button abort@{ui} Most all gadgets that support activation or selection allow you to click the right mouse button while still holding the left button to cancel your action. For example, pressing a button in the speedbar, then right-clicking while still holding the left mouse button down will cancel selecting that button. For buttons and choosers, activation can be canceled by also moving the mouse off the gadget's selection area before releasing the left mouse button. @{i}Keyboard shortcuts@{ui} Most all ClassAct gadgets support activation via the keyboard. The keystroke to activate the gadget is indicated by a letter in the gadget's label that is underlined. For gadgets such as choosers and radiobuttons, selecting the key activation will advance the gadget to the next available selection, i.e., a chooser with 3 labels, "Red" "White" and "Blue" that is currently on "White" activated via keyboard will advance to "Blue". NOTE: For choosers and radiobuttons, holding the Shift key while pressing the key will make the gadget select backwards. For instance, now pressing Shift + the activation key in the above mentioned chooser will cause it to go back to "White". Also, if the activation key is still being held down, you can cancel it by pressing Escape before releasing the key. @{i}Miscellaneous@{ui} If you have a gadget in an interim selected state, e.g., a button pressed but not released, or a chooser with the chooser popup opened, and a window or requester opens up, the gadget activation will be cancelled without sending the application an activation. @{b}Windows@{ub} @{i}Iconifying@{ui} Some applications will tell ClassAct to place a gadget in their window's titlebar next to the depth-arrange and zoom gadgets. This is an iconify gadget. By pressing this gadget, you can tell the application to iconify its window. This will place an icon on the Workbench, which you can double-click to restore the window. @{b}Radiobuttons@{ub} Radiobuttons are lists of mutually-exclusive items. Only one of any of the items in the list may be selected at a time. @{i}Strumming@{ui} ClassAct radiobuttons support strumming through the list, by selecting one of the items, and moving the mouse while still holding the left button. @{b}Checkboxes@{ub} @{i}Label activation@{ui} ClassAct checkboxes allow you to select the text label to activate the gadget as well as the normal checkbox area itself. @{b}Speedbars@{ub} A speed bar is a horizontal row or vertical column of button gadgets, usually with an image face denoting some program function. The speedbar gadget could be placed in the main program's window or perhaps its own window to form a floating speedbar/tooldock. @{i}Scrolling@{ui} Some speedbars may contain more buttons than are displayable in its container. In order to see these buttons, you must scroll them into view. You can do this by holding the Shift key while left-clicking with the mouse in the speedbar's area and then moving the mouse in the direction you wish to scroll the speedbar. @{i}Mutually-exclusive groups@{ui} Speedbar buttons may come in different types: "activation," "toggle," and "mutually-exclusive." "Activation" type buttons are standard buttons that depress visually when you select them, and return to normal visual state when you release them. "Toggle" type buttons stay in a selected state even after you release the mouse. These usually denote some type of Boolean action. These buttons can also generally be deselected by click on them again. "Mutually-exclusive" buttons are similar to "toggle" buttons, but belong to a group. In this case, selecting a button in a group will deselect any other selected button in the same group. This behavior is similar to radiobuttons. @{b}Listbrowsers@{ub} This gadget is very similar to the Listview gadget in GadTools, with numerous enhancements. It displays a list in a scrolling view so that you can browse through it an select items in various ways. @{i}Drag/shift-selection@{ui} Some listbrowsers may be known as multi-select, i.e., they allow you to select more than one item from the list. This can be achieved two ways. One way is by Shift-selecting an item, i.e., clicking the item with the left mouse button while holding the Shift key. The other is know as drag-selecting. This is done by clicking on one item, and while holding the left mouse-button, dragging the mouse over all the items you wish to select. Deselection is also possible by Shift-selecting an already selected item. @{i}Checkboxes@{ui} The ClassAct listbrowser also supports items in the list with checkboxes. This checkbox is similar to the normal checkbox gadget. To select or deselect the checkbox, simply click in the checkbox's container. @{i}Hierarchies@{ui} The ClassAct listbrowser also supports hierarchical lists of items, i.e., an item may contain "child" items in the list. Child items show their hierarchical relationship to the "parent" item by being indented below it. The listbrowser supports hiding/showing of "children." This is achieved by clicking on the hierarchy image (discussed below). The shown/hidden state will be toggled with every click. The listbrowser has a default set of images that are displayed to the far left of each item in the list. For an item that does NOT contain any "children," no image is displayed by default. If the items has "children" and they are currently hidden, an image similar to '>' is shown. If the item's "children" are currently shown, an image similar to 'v' is shown. NOTE: Some authors will replace the standard images with custom imagery. Please consult the program's documentation for information on this. @{i}In-place editing@{ui} The ClassAct listbrowser also contains the ability to do in-place editing of items in the list, if the application author has enabled it. This will create a string gadget within the listbrowser that allows you to edit the text/numbers of the selected item. See the String/Integer gadget section below for details on what you can do with those gadgets. @{b}Choosers@{ub} A chooser is a small list-selection object. In its inactive mode it looks much like a button or cycle gadget. When the button is pressed using the mouse, a menu displaying the items in the list is displayed. @{i}Chooser types@{ui} The chooser operates in either of two modes, pop-up and drop-down. A pop-up chooser is visually distinctive from a drop-down chooser, in that at the far right of the gadget select area, a pop-up contains an image like '<<' where a drop-down contains an image like 'V'. Clicking in the chooser's main display area will reveal the list of items from which to choose. While holding the left mouse button, move the mouse to the desired item and release it to select. Release the mouse away from the gadget to retain the current selection. The current selection in denoted in the pop-up list with a checkmark. POP-UP CHOOSERS In this mode, there is a currently active item in the list of selections, which will be displayed in the gadget select button. This has the same advantage of a cycle menu in that it is compact, with the further advantage that all values can be displayed at once and therefore the list of values can be much larger. The pop-up chooser's pop-up selection area will not pop up if the gadget is selected on the '<<' image. This will just advance forward (or backward if Shift-selected) through the list of items. DROP-DOWN CHOOSERS A dropdown chooser is for performing an action from a list of available actions. In this mode, the gadget select box contains a title indicating what the actions are for. These actions are generally closely related, and specific to a certain context within the application. This can be used to replace a group of buttons, or a cycle gadget and a button where the cycle gadget modifies the behaviour of the button. An alternate use for a drop-down is to use it as a means of accessing a "hot list" for a string or integer gadget. For example, in a word processor you might have a string gadget at the top of the screen for entering the text point size. Beside that you could have a drop-down chooser that lists some common point sizes that would then be copied into your integer gadget and change the text size when you make a selection. @{i}Hidden mode@{ui} Some chooser gadgets may be hidden, and activated by the click of a button or other action. These function similar to the drop-down chooser, but are not visually identifiable. @{b}String/Integer gadgets@{ub} These are your standard text/number input gadgets. Described below is a list of editing commands available to these gadgets. Key Function ---------------------------------------------------------------- Cursor left Move to previous character Shift + Cursor left Move to beginning of string Cursor right Move to next character Shift + Cursor right Move to end of string Del Delete character under cursor Shift + Del Delete from the character under the cursor to the end of the string Backspace Delete the character to the left of the cursor Shift + Backspace Delete from the character to the left of the cursor to the beginning of the string Return/Enter Terminate input Right Amiga + Q Undo last editing change to string Right Amiga + X Clear entire string buffer. Undo buffer is left undisturbed. @endnode @node Misc "Eucalyptus: Miscellaneous" @toc Main @{fg shine}Miscellaneous@{fg text} This chapter basically covers, well, miscellaneous things that usually can't be placed anywhere else, plus just some tidbits of information. @{fg shine}The Future@{fg text} The following items are on my to-do list for future versions of Eucalyptus. If you think of an item that is not in this list, please feel free to drop me an e-mail or postcard. - XPK support. - Multiple message security types (de/encryption and signatures in addition to PGP). - IMAP4rev1 - LDAP support - ACAP support - much more! @{fg shine}Authenticity@{fg text} If you want to be sure that the files in this archive are authentic, I have enclosed below my PGP public key. All binaries and documentations are accompanied by a PGP signature file, which can be used to verify the authenticity of each file. -----BEGIN PGP PUBLIC KEY BLOCK----- Version: 2.6.2 mQBtAzFM4HgAAAEDAMrjdVJRvZT93v/e9lKPtEdNsnyFpC66+lJ3tcqy62dcbQKl 2kze/s3vpxDN8DBhs/WeoxPQFmMFekT8BdkxELznxLGPOil1ylPCaNQY2juwQfVP AMYKGbTTzufh5uYGvQAFEbQnUGF1bCBBLiBTY2hpZmZlcmVyIDxnYW5kYWxmQGh1 Z2hlcy5uZXQ+ =gVLn -----END PGP PUBLIC KEY BLOCK----- @endnode @node Caveats "Eucalyptus: Caveats" @toc Main @{fg shine}Caveats@{fg text} @endnode @node History "Eucalyptus: Program history" @toc Main @{fg shine}History@{fg text} @{b}1.0@{ub} ?? ??? 1997 - @{u}Bugs fixed@{uu} @{fg shine}Testing@{fg text} Eucalyptus has been tested on the following systems: @{b}A2000@{ub} Derringer 030/882 @ 33 MHz (20MB) AmigaOS 3.1 (V40) Picasso IV (Picasso 96 V1.29) DataFlyer IDE w/ Western Digital 1.2GB HD GVP Impact Series II SCSI HardCard w/ Quantum 80MB HD @{b}A1200@{ub} 030 @ 40 MHz (8MB) AmigaOS 3.0 (V39) @{b}A2000@{ub} 000 @ 7 MHz (8MB) AmigaOS 2.1 (V38) Original Chip Set (OCS) @{b}A4000@{ub} 040 @ ?? MHz (26MB) AmigaOS 3.1 (V40) @endnode @node Refs "Eucalyptus: References" @toc Main @{fg shine}References@{fg text} The following RFCs were consulted during the creation of Eucalyptus: 821 @{i}Simple Mail Transfer Protocol@{ui}, by Jonathon B. Postel, August 1982. 822 @{i}Standard for the Format of ARPA Internet Text Messages@{ui}, revised by David H. Crocker, August 1982. 1321 @{i}The MD5 Message-Digest Algorithm@{ui}, by R. Rivest, April 1992. 1344 @{i}Implications of MIME for Internet Mail Gateways@{ui}, by N. Borenstein, June 1992. 1524 @{i}A User Agent Configuration Mechanism for Multimedia Mail Format Identification@{ui}, by N. Borenstein, September 1993. 1939 @{i}Post Office Protocol - Version 3@{ui}, by J. Myers, M. Rose, May 1996. 2015 @{i}MIME Security with Pretty Good Privacy (PGP)@{ui}, by M. Elkins, October 1996. 2045 @{i}Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies@{ui}, by N. Freed, N. Borenstein, November 1996. 2046 @{i}Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types@{ui}, by N. Freed, N. Borenstein, November 1996. 2047 @{i}Multipurpose Internet Mail Extensions (MIME) Part Three: Message Header Extensions for Non-ASCII Text@{ui}, by K. Moore, November 1996. 2048 @{i}Multipurpose Internet Mail Extensions (MIME) Part Four: Registration Procedures@{ui}, by N. Freed, J. Klensin, J. Postel, November 1996. 2049 @{i}Multipurpose Internet Mail Extensions (MIME) Part Five: Conformance Criteria and Examples@{ui}, by N. Freed, N. Borenstein, November 1996. 2076 @{i}Common Internet Message Headers@{ui}, by J. Palme, February 1997. @endnode @node Acks "Eucalyptus: Acknowledgements" @toc Main @{fg shine}Acknowledgements@{fg text} I'd like to thank: God, who bestows upon us great things. My wife, Michelle, who has been a great help and encouragement. My beta-testers (names to be inserted later :). Christopher Aldi, for help with ClassAct. @endnode @node nothing "Eucalyptus: nothing" @{fg shine}Nothing!@{fg text} What'd you think a button marked 'nothing' was going to do??? @endnode