wiki:Documentation/Configuration

Version 7 (modified by damato, 22 months ago) (diff)

--

Configuration

YAM has a huge number of options, which can be set up in the configuration window. The program options are divided into sheets which can be selected by clicking on the corresponding word in the left part of the configuration window. There are also three menu items available.

First Steps

This sheet contains some essential information needed for YAM to work.

Minimal configuration

Full Name

Your real name and surname.  Please take care that this field is filled in correctly.  DO NOT use quotation marks in your name.

Example: John Doe

E-mail address

This is your e-mail address, consisting of your <username>@<domainname>.

Example: jdoe@…

Mail server

The Internet address (hostname or IP) of your system's mail server. This server, which normally is a computer of your ISP (Internet Service Provider), must be capable of working with the POP3/SMTP protocol.

Example: mail.example.com

User name

The user name for logging into the mail server of your ISP.

Example: jdoe

Password

The password which is asked from you by your mail server. This password is possibly but not necessarily identical to the password you use to log in on your ISP, and is usually case sensitive.

Example: nguz56

Time zone

Timezone

The time and date displayed by YAM in the message list is always converted to your local time. This guarantees correct sorting of messages from all over the world sent out from different time zones. The time zone is part of the message's date and specifies the difference between local time and Greenwich Mean Time (GMT).

Examples: GMT+01:00 (for Central Europe), GMT 00:00 (for the U.K.), GMT-05:00 (for U.S. EST e.g. New York City)

Normally YAM will get the time zone from your Locale settings, thus this selector will be ghosted.

Add adjustment for daylight saving time

This option is to be activated during daylight saving time. By doing so, one hour will be added to the time zone value. YAM automatically changes to/from daylight saving time if the operating system support DST switching (e.g. AmigaOS4) or if a AutoDST tool like SetDST, FACTS or SummertimeGuard is installed. This is indicated by ghosting this checkbox.

Example: John Doe

TCP/IP

Here you can enter the information needed to actually send email, as well as define additional POP3 accounts.

Send mail (SMTP)

Apart from the primary SMTP server already defined in the First steps section, you can set up an unlimited number of SMTP servers here; the names appear in the list on the left and clicking on a name brings up the relevant details on the right. Note that these accounts can be for the same user on a different server, or a different user on the same server. Either way, you can check for new mail with a single mouse click. Click on [New] to insert the data required for a new e-mail account. With [Delete] you can delete accounts.

Server

The Internet address of the system you're sending your mail to. This server, which usually is a computer of your ISP (Internet Service Provider), must be capable of processing the SMTP protocol.

Example: mail.example.com

Port

The port number of the SMTP service. The standard port is 25 for plain SMTP. In case of using SSL/TLS connections this port may also be 576 or 456.

Example: 25

SMTP server allows 8bit

Originally only the US-ASCII character set was allowed for use in e-mail, which meant that users were forced to use vowels (e.g., they had to use 'ae' instead of 'ä'). The reason for that was that many servers only processed the first 7 bits and simply cut off the 8th bit, crippling the e-mail while doing so. This problem was solved by introducing the MIME quoted-printable standard, which converts all 'unauthorized' characters to 7 bit before transfer and reconverts them to the original characters on delivery. Modern mail servers don't have problems with non-US-ASCII characters any more, so messages do not necessarily have to be converted. If you are absolutely sure that your server supports 8 bit transfers, you can switch this option on and save a few bits when transferring e-mails. The best way to find out if your mail server supports this is to write a message to yourself containing modified vowels and see what happens.

Example: Yes

Use SMTP AUTH

Enable this if you want to use SMTP Authentication, whereby YAM will request your mail server to use an extra authentication layer as documented in RFC 2554. You will need to fill in another couple of UserID/Password fields in this case. If your SMTP server does not support SMTP AUTH, you will receive an error message when trying to send email. Ask your ISP if in doubt.

Example: No

Username

When using SMTP AUTH you can insert the user name for the SMTP authentification here. In most cases this will be identical to the username in your e-mail address. However, there are exceptions, so check the instructions from your ISP (YAM then constructs the full account name in the form <Username>@<server>).

Example: jdoe

Password

The password which has to be sent to the mail server at login time. You can leave this field empty for security reasons -- if you do, the password will be asked to you whenever you send new mails. Also, remember the password is case sensitive.

Example: nguz56

Use SMTP TLSv1/SSLv3

Enable this if your SMTP server supports TLSv1/SSLv3 secure connections. If enabled, YAM will connect via the AmiSSL library with the SMTP server and encrypts every transfer.

Example: No

Receive mail (POP3)

Apart from the primary POP3 server already defined in the First steps section, you can set up an unlimited number of POP3 servers here; the names appear in the list on the left and clicking on a name brings up the relevant details on the right. Note that these accounts can be for the same user on a different server, or a different user on the same server. Either way, you can check for new mail with a single mouse click. Click on [New] to insert the data required for a new e-mail account. With [Delete] you can delete accounts.

Server

The Internet address of the system you're sending your mail to. This server, which usually is a computer of your ISP (Internet Service Provider), must be capable of processing the POP3 protocol.

Example: pop.example.com

Port

The port number of the POP3 service. The standard port is 110 for plain POP3. In case of using SSL/TLS connections this port may also be 995.

Example: 110

Username

The user name for authentication against the specified POP server.. In most cases this will be identical to the username in your e-mail address. However, there are exceptions, so check the instructions from your ISP (YAM then constructs the full account name in the form <Username>@<server>).

Example: jdoe

Password

The password which has to be sent to the mail server at login time. You can leave this field empty for security reasons -- if you do, the password will be asked to you whenever you send new mails. Also, remember the password is case sensitive.

Example: nguz56

Active

Switch this option on to have the selected POP3 account checked for new mail whenever you use the Get new mail button in the toolbar, or the equivalent item in the "Folder" menu. If you don't want this email account to be checked automatically, switch this option off and use the menu item Folder/Check single account from the main window instead.

Example: Yes

Use POP3 TLSv1/SSLv3

Activate this option to use SSL based encryption under the TLS protocol as described in RFC 2595. This adds extra security to prevent the typical eavesdropping and hijacking attacks which POP is commonly subject to, and will use port 995 instead of the usual 110. The with STLS option will force the use of the POP3 STARTTLS extension, adding another layer of security to the communication, using again port 110. If your POP3 server doesn't support any of this, you will receive an error message when checking for new mail. Also, AmiSSL is required.

Example: Yes

Login using APOP

Normally the Username and the password are transmitted as plain text when connecting to a POP3 server. Under certain circumstances, this could be a security risk, and for this reason modern POP3 servers support the APOP authentication, which transmits the username and password encrypted with a key which is delivered by the server. If your POP3 server does not support APOP you'll receive an error message when checking for new mail; in that case, switch this option off. Also note, that if your POP3 server supports TLS/SSL this should be preferred as it also transmits the email content encrypted rather than in plain text.

Example: No

Delete mail on server

If this option is activated, new mail will be deleted after downloading it from the mail server. The messages will be deleted only after they have been successfully saved to your computer. If the POP3 account is used by several people, or if you'd like to access your account again later from another computer, this option can be deactivated.

Example Yes

New mail

Controlling the way mail is downloaded.

Download

Pre-selection

After establishing a link with the POP3 server, a preselection window may open showing a list of all new mail in the POP3 mailbox. This allows you to decide whether to download, delete or leave a message on the server, according to its size, topic or sender. For pre-selection to work properly, the server must support the TOP command which most of them do.

never: pre-selection is deactivated
large messages: only messages bigger than a size defined by you will be displayed in pre-selection
always: every message will be displayed in pre-selection
always, only sizes: all messages will be displayed but only their sizes will be shown. The advantage of this method is that it is pretty fast.

Example: always

Size limit

If pre-selection is activated, messages which exceed the size given here will be highlighted. This way you can avoid downloading messages with huge attachments. The size is given in kilobytes. If you don't want to use any limit, just insert '0'.

In everyday use, the settings 'pre-selection = large messages' and 'size limit=100 kB' have proved to be advantageous. With these settings, the pre-selection window will only appear if at least one of the new messages exceeds 100 kilobytes in size.

Example: 100

Transfer window

Here you can decide if you want to see the transfer window while receiving or sending mail. With automatic it only opens if you manually initialize the transfer, staying closed while YAM automatically checks for new mail.

Example: never

Avoid duplicates

If you choose not to have YAM delete the mail on the server after downloading, it will be downloaded again next time YAM gets your mail, so every message will appear twice in your mail folder. To prevent this, switch the Avoid duplicates option on -- as long as this option is activated, YAM will keep track of all your downloaded messages in the .uidl file and use special commands of the POP3 server to avoid downloading the same message twice. If the POP3 server supports these UIDL commands, this check will be done rather quickly. If the server doesn't support these commands, YAM will try to read the Message-ID using the TOP command instead of the UIDL commands. In case the mail server doesn't support any of these commands, this option must be turned off.

Example: Yes

Update message status

If this option is activated, new messages in the 'Incoming' folder will be marked as 'unread' before downloading new mail. This way you can instantly recognize the new mail that was downloaded the last time you've fetched mail.

Example: Yes

Automatic operation

Check for new mail every [xx] minutes

Here you can specify a time interval after which YAM will automatically recheck your mail server for new mail. To deactivate this option, simply select zero.

Example: 15 minutes

Download large messages

Whenever new mail is downloaded automatically (every x minutes or using ARexx), the selection window won't pop up since the user is likely to be working with another program at the time, or not in front of the computer at all. Mails exceeding the size limit won't be downloaded and will remain on the server if this option is not activated.

Example: No

Notification

Requester

Once YAM has downloaded new mail, it will display a requester showing the number of new and deleted messages.

Example: Yes

Sound

Once YAM has downloaded new mail, it will play a sound file. The datatypes library is used for playing, so the sound file can be of any format (like AIFF or WAVE), as long as you have installed the appropriate datatypes. Click the small arrow (PLAY symbol) to test the sound.

Example: Data:Audio/Newmail.snd

Command

This is a program to be executed when new mail arrives. Insert the command as you'd do at a command line interface. If it is an Arexx script, you have to put the 'RX' command in front of the name of the script.

Example: RX PROGDIR:rexx/Newmail.YAM

Filters

The purpose of a mail filter is to process mail according to criteria defined by the user. Whenever a mail matches a specified pattern, it can trigger certain actions. Applications for the use of filters include

  • automatically moving mail from a mailing list to a specified folder
  • automatic processing of incoming inquiries by sending pre-defined answers
  • automatic deletion of unwanted spam (advertising by e-mail, a real pest nowadays)
  • automatic re-directing of mails to another recipient.

You can define theoretically an unlimited number of filters. The list on the left shows the names of all the filters defined so far. Click on a name to bring up its details on the right, spread across three sheets -- Options, Comparison and Action. Click on [New] to create a new filter or use [Delete] to delete one. Filters are executed in top-to-bottom order, therefore you should place filters that delete or move messages at the bottom of the list.

Options

Name

The filter's name is merely for recognition and not of any other use.

Remote filter

With a remote filter, new email can be checked on the POP3 server without being downloaded completely. The POP3 server must support the TOP command to be able to process this kind of filter. In contrast to 'normal' filters, only the contents of the e-mail headers can be searched for certain patterns. For obvious reasons, functions like forwarding or moving e-mails cannot be used with remote filters. In addition, if remote filters are activated they might slow down downloading e-mail, but they are handy and powerful if used with care.

Apply to new mail

Activate this option to have all new mail processed by this filter. Processing will start automatically after receiving new mail.

Apply to sent mail

Activate this option to have all sent mail processed by this filter. Processing will be initiated automatically after sending mail.

Apply on request

If this option is activated, the filtering process will be started by clicking on the Filter button in the main window or by choosing 'Filter' from the 'Folder' menu. This way you can also process old messages which do not necessarily have to be in the Incoming folder.

Comparison

Search in

Here you can define what part of the e-mail should be scanned for the search pattern. If you want a field of the message header to be searched, you can choose one from the list which appears when clicking on the cycle gadget, or select 'Other field' and insert the name of the header field into the text field on the right side of the cycle gadget. If 'Message body' is selected, the whole message -except for the headers- will be searched. Please note that this type of full text search may take quite a long time when big mails are processed (YAM will have to decode mails in MIME format).

Example: 'Other field: X-Mailer'

Comparison

The instruction comprises the comparison operator and the search pattern.

YAM supports the following comparison operators:

  • = the text which is compared must match the search pattern
  • < the text must be "less" than the search pattern
  • > the text must be "greater than" the search pattern
  • <> the text must be different from the search pattern
  • IN the text must match pattern contained in the file which is specified in the text field to the right side of the comparison cycle gadget. Instead of a search pattern itself, the name of a file has to be inserted here, containing one or several lines of search patterns. In this way it is possible to create a so-called 'Killfile' containing a list of e-mail addresses. Click on the page icon to edit the file.

Note that the comparison operators '<' and '>' work differently according to the type of field. YAM knows that a message size or date is numeric and sorts these in numerical order, but for fields such as "Subject:", alphanumeric order is used as in a telephone directory, so James < Jim and 12 < 2.

The search pattern may contain AmigaDOS wildcards such as ?, #?, (a|b) or [abc]. Please note that the search pattern [YAM]#? will filter all messages beginning with Y, A or M. For filtering mails coming from a mailing list (for example, a mailing list related to YAM), you'd better use the search pattern #?YAM#? or have the filter compare the Reply-To: field with the address of the mailing list.

Example: '= YAM 1.3.#?'

Address/Name

If you make the filter search a header field containing an e-mail address, you can specify here whether the search pattern should be processed on the actual address (e.g. jdoe@…) or the author's name (e.g. 'John Doe').

Case sensitive

Activate this option if you want the filtering process to distinguish between normal and capital letters.

Substring search

If the search pattern consists of only a part of the header field which is to be searched through, you must activate this option - YAM will then complete the search pattern with #? internally.

It is possible to combine two search criteria. The cycle gadget lets you select how this is to be done:

none don't use a second criterion and both criteria must be satisfied or at least one of the two criteria must be met exclusive or either one or the other of the two criteria must apply, but not both

Action

Bounce

Activate this option to have mail matching the search criteria bounced to another recipient -- for instance, you might use this to automatically resend certain email to your mailbox at work.

The new recipient's e-mail address must be inserted into the text field next to the option.

Example: jdoe@…

Forward

Activate this option when you want e-mail matching the search criteria to be forwarded to another person. The new recipient's e-mail address must be inserted into the text field next to the option.

Reply

If this option is activated, YAM will send an automatic reply to any mail matching the search pattern. Enter the filename containing the auto-answer text into the text field next to this option.

Example: PROGDIR:Auto-Texts/Answer1.txt

Execute

If this option is activated, an external program will be executed whenever an email matches the search criterion. YAM will send the path of the e-mail to the external program as a starting parameter. Insert the command line into the text field next to this option.

Please note that if you want an ARexx script to be executed, you will have to explicitely put the 'RX' command first.

Example: 'rx PROGDIR:Rexx/Subscribe.rexx'

Play sound

Activate this option to have a sound played whenever a message matches the search pattern. The sound file name is to be inserted into the text field next to this option. YAM uses the datatypes library for playing the sound. Click the small arrow (PLAY symbol) to test the sound.

Example: Data:Audio/Ihatespam.wav

Move

If you activate this option, YAM will move any email matching the search pattern to another folder. You can select the folder with the pop-up button.

Delete

If this option is activated, all messages matching the search pattern will be deleted. (You probably guessed that... ;) )

Don't download

If this option is activated, any message matching the search pattern will not be downloaded from the mail server. You can use a remote filter together with this option if several people share the same POP3 account.

Spam

Setup of the spam filter.

Activate spam filter

Activates the spam filter, believe it or not :)

Reset Spam training data

Resets the Spam training data. Should only be necessary in rare circumstances.

Check new mail for spam content

Automatically checks new mail for spam content.

Addressbook whitelisted

If a mail has an From: address that exist in your addressbook, it will never be considered as spam.

Mark mail as spam when moved to Spam folder

Any mail that is manually moved to the Spam folder are automatically marked as spam.

Mark new spam as read

This option will automatically mark new spam mails as read.

Move 'Not Spam' back to 'Incoming'

Will move mails that has been wrongfully detected as spam or mails that have manually been marked as 'Not Spam' back to 'Incoming' folder.

Apply filters

Applies all your defined filters to mail that is moved back to the 'Incoming' folder.