wiki:Documentation/Quickstart

Version 7 (modified by Philippe Duchenne, 3 years ago) (diff)

Languages:

Documentation Contents

  1. Documentation/ARexxAPI
  2. Documentation/ARexxAPI/ADDRDELETE
  3. Documentation/ARexxAPI/ADDREDIT
  4. Documentation/ARexxAPI/ADDRFIND
  5. Documentation/ARexxAPI/ADDRGOTO
  6. Documentation/ARexxAPI/ADDRINFO
  7. Documentation/ARexxAPI/ADDRLOAD
  8. Documentation/ARexxAPI/ADDRNEW
  9. Documentation/ARexxAPI/ADDRRESOLVE
  10. Documentation/ARexxAPI/ADDRSAVE
  11. Documentation/ARexxAPI/APPBUSY
  12. Documentation/ARexxAPI/APPNOBUSY
  13. Documentation/ARexxAPI/FINDMAIL
  14. Documentation/ARexxAPI/FLUSHINDEXES
  15. Documentation/ARexxAPI/FOLDERINFO
  16. Documentation/ARexxAPI/GETCONFIGINFO
  17. Documentation/ARexxAPI/GETFOLDERINFO
  18. Documentation/ARexxAPI/GETMAILINFO
  19. Documentation/ARexxAPI/GETSELECTED
  20. Documentation/ARexxAPI/GETURL
  21. Documentation/ARexxAPI/HELP
  22. Documentation/ARexxAPI/HIDE
  23. Documentation/ARexxAPI/INFO
  24. Documentation/ARexxAPI/ISONLINE
  25. Documentation/ARexxAPI/LISTFREEZE
  26. Documentation/ARexxAPI/LISTSELECT
  27. Documentation/ARexxAPI/LISTUNFREEZE
  28. Documentation/ARexxAPI/MAILARCHIVE
  29. Documentation/ARexxAPI/MAILBOUNCE
  30. Documentation/ARexxAPI/MAILCHANGESUBJECT
  31. Documentation/ARexxAPI/MAILCHECK
  32. Documentation/ARexxAPI/MAILCOPY
  33. Documentation/ARexxAPI/MAILDELETE
  34. Documentation/ARexxAPI/MAILEDIT
  35. Documentation/ARexxAPI/MAILEXPORT
  36. Documentation/ARexxAPI/MAILFILTER
  37. Documentation/ARexxAPI/MAILFORWARD
  38. Documentation/ARexxAPI/MAILIMPORT
  39. Documentation/ARexxAPI/MAILINFO
  40. Documentation/ARexxAPI/MAILMOVE
  41. Documentation/ARexxAPI/MAILREAD
  42. Documentation/ARexxAPI/MAILREPLY
  43. Documentation/ARexxAPI/MAILSEND
  44. Documentation/ARexxAPI/MAILSENDALL
  45. Documentation/ARexxAPI/MAILSTATUS
  46. Documentation/ARexxAPI/MAILUPDATE
  47. Documentation/ARexxAPI/MAILWRITE
  48. Documentation/ARexxAPI/NEWMAILFILE
  49. Documentation/ARexxAPI/QUIT
  50. Documentation/ARexxAPI/READCLOSE
  51. Documentation/ARexxAPI/READINFO
  52. Documentation/ARexxAPI/READPRINT
  53. Documentation/ARexxAPI/READSAVE
  54. Documentation/ARexxAPI/REQUEST
  55. Documentation/ARexxAPI/REQUESTFILE
  56. Documentation/ARexxAPI/REQUESTFOLDER
  57. Documentation/ARexxAPI/REQUESTSTRING
  58. Documentation/ARexxAPI/RESTART
  59. Documentation/ARexxAPI/SCREENTOBACK
  60. Documentation/ARexxAPI/SCREENTOFRONT
  61. Documentation/ARexxAPI/SETFLAG
  62. Documentation/ARexxAPI/SETFOLDER
  63. Documentation/ARexxAPI/SETMAIL
  64. Documentation/ARexxAPI/SETMAILFILE
  65. Documentation/ARexxAPI/SHOW
  66. Documentation/ARexxAPI/USERINFO
  67. Documentation/ARexxAPI/WRITEATTACH
  68. Documentation/ARexxAPI/WRITEBCC
  69. Documentation/ARexxAPI/WRITECC
  70. Documentation/ARexxAPI/WRITEEDITOR
  71. Documentation/ARexxAPI/WRITEFROM
  72. Documentation/ARexxAPI/WRITEIDENTITY
  73. Documentation/ARexxAPI/WRITELETTER
  74. Documentation/ARexxAPI/WRITEMAILTO
  75. Documentation/ARexxAPI/WRITEOPTIONS
  76. Documentation/ARexxAPI/WRITEQUEUE
  77. Documentation/ARexxAPI/WRITEREPLYTO
  78. Documentation/ARexxAPI/WRITESEND
  79. Documentation/ARexxAPI/WRITESUBJECT
  80. Documentation/ARexxAPI/WRITETO
  81. Documentation/Configuration
  82. Documentation/Credits
  83. Documentation/Features
  84. Documentation/Installation
  85. Documentation/Menus
  86. Documentation/Pattern matching
  87. Documentation/Quickstart
  88. Documentation/Reference
  89. Documentation/Requirements
  90. Documentation/Tips & tricks
  91. Documentation/Tooltypes
  92. Documentation/User license
  93. Documentation/What is e-mail
  94. Documentation/Windows
  95. Documentation/Windows/Addressbook
  96. Documentation/Windows/Foldersettings
  97. Documentation/Windows/Mailtransfers
  98. Documentation/Windows/Mainwindow
  99. Documentation/Windows/Readwindow
  100. Documentation/Windows/Searchwindow
  101. Documentation/Windows/Userswindow
  102. Documentation/Windows/Writewindow

Quickstart

This chapter is meant to be a step-by-step guide to the way YAM works. It is assumed that you already have YAM installed on your system and that you're using Miami as your TCP/IP software.

If you have used YAM before, you probably can skip this chapter.

  1. Get the following information from your Internet provider:
    • Your e-mail address
    • The Internet address of the mail server (so called POP- or SMTP server)
    • Your password, required to log in on the mail server
    As an example here's the setup for a fictitious user named 'John Doe' living in Britain. His e-mail address is 'jdoe\@example.com' and the address of his mail server is 'mail.example.com'. His password is 'nguz56'.
  1. Start YAM by double-clicking its icon. After the copyright window has closed, the main window should open with two listings (folder list & message list) and a row of buttons.
  1. The program must be configured before you can do anything else. Choose 'Configuration' from the 'Settings' menu or simply click the button http://yam.ch/export/HEAD/trunk/resources/themes/default/toolbar/tb_Config to open the configuration window. The sheet which then appears is called 'First Steps', and this is where you must enter the information needed for data transfer. Following our example this is:

Real Name: John Doe
Email address: jdoe@…
Mail server: mail.example.com
Password: nguz56
Time zone: GMT

For security reasons the password textfield only shows stars, one for each character you type. If daylight saving time applies to you at the time of installation, switch on the adjustment for it (right beneath the time zone).

  1. YAM allows you to define a text passage which will be appended to all of your e-mail as a complimentary closing phrase. To define it you have to click on 'Write' in the list on the left hand side of the configuration window. On the page appearing now select the text field 'Welcome phrase', delete the original text by hitting RAmiga-X and insert something such as:

Kind regards,\n Joe

The control string \n forces a new line after the word 'regards'.

  1. Save the settings now by clicking on [Save]. YAM now has sufficient data to allow you to write your first message.
  1. After saving the settings you're back in the main window. Click the button 'Write' http://yam.ch/export/HEAD/trunk/resources/themes/default/toolbar/tb_NewMail or choose 'New' from the 'Message' menu. The editor window will open. Insert the e-mail address of the recipient into the 'To' textfield (e.g. 'jdoe\@example.com'). Normally of course you would put someone else's address, but right now you want to test the system, so put your own address instead. Insert two or three words to indicate the subject into the 'Subject' text field ('test' will do nicely for this one!). Now click in the large blank area and type the actual message.

If you were using YAM in a normal way, and wished to send copies (including hidden copies) to anyone, this could be done by clicking on 'Options', thus activating the third of the three sheets (Message, Attachments, Options) in the Write window.

  1. Assuming you are not currently online (Miami is not running), click on [Send later]. This sends the message to the 'Outgoing' folder as opposed to transmitting the message right away [Send now].
  1. Now start Miami and connect to the Internet. Open the 'Outgoing' folder by clicking on 'Outgoing' in the folder list contained in the main window. Send the message by clicking the 'Send' button http://yam.ch/export/HEAD/trunk/resources/themes/default/toolbar/tb_SendAll. The transfer status window will appear and report progress as YAM logs in on the mail server and sends the message.
  1. As you've probably noticed the mail has vanished from the 'Outgoing' folder. Don't panic! It has been moved to the 'Sent' folder. The letter symbol in the list has a little stamp on it now http://yam.ch/export/HEAD/trunk/resources/themes/default/status/status_sent, which means that the message has been sent successfully.
  1. When you double-click the message, the read window will open. You should be able to recognize the text written by you. The lines in the upper part of the message have been inserted by YAM and contain data needed for mail transfer (the so-called "headers").
  1. Since you've written the mail to yourself you should start looking for new mail now. Click the read window to the background or close it, then click on the 'Get' button http://yam.ch/export/HEAD/trunk/resources/themes/default/toolbar/tb_GetMail.
  1. The transfer status window you saw before opens again and you can watch how YAM downloads your mail from the mail server. Provided that everything runs as it should, a requester will open up with the message that you have received new mail. You can read the mail in the 'Incoming' folder.

If you've made it this far without major problems, you now know the essential functions of YAM. For further explanations and more detailed information on single topics, please read the following chapters.