|  | M016 -2.5-

Module : Mail V2.5

Category / Domain : | CommTools
Scol Engine Compatibility : | v3.2d and higher
Operating Systems : | Windows 95/98
| Windows NT 4.0
Documentation dated : | 07/07/2000

Supersedes sheet : M016 -2.4-

Module Description

This module is a simple text mail sender.

Editor Description

The SMTP server used must be declared with its name or IP address.

The SMTP port (usually 25) can be changed.

The sender real name can be either the client login name or a specific given value.

In the same way, the sender host IP can be either the scol server IP address or a specific given value (name or IP).

You can also specify two text portions that will be included in all mails sent before and after the user text body.

Actions and Events

Actions

- send : sends a mail without displaying the client interface ;
It must be associated with a parameter containing any of sender, recipients, copy, blind copy, subject and body, each one on a line (separated by '\n') :

> snd sender_e-mail_address
> from from_e-mail_address
> rcp recipient_e-mail_address_list (separated by commas ",")
> cc copy_e-mail_address_list (separated by commas ",")
> bcc blind_copy_e-mail_address_list (separated by commas ",")
> sub subject
> txt body_text
> id identifier

> The identifier is optional and will be given back in the parameter of events "sent OK" or "sent KO"

- start : starts the client

- show : displays the client interface ;
It can be associated with a parameter containing any of sender, recipients, copy, blind copy, subject and body, each one on a line (separated by '\n') :

> snd flag sender_e-mail_address
> rcp flag recipient_e-mail_address_list (separated by commas ",")
> cc flag copy_e-mail_address_list (separated by commas ",")
> bcc flag blind_copy_e-mail_address_list (separated by commas ",")
> sub flag subject
> txt flag body_text
> id identifier

> The identifier is optional and will be given back in the parameter of events "sent OK" or "sent KO"
> The values given are default values that will be sent with the mail.
> The client will be able to modify or append them according to the flag.
> The flag tells the client how to display the relative field :

> > 0 : field not displayed
> > 1 : value visible but read-only
> > 20 : value visible and append before
> > 21 : value visible and append after
> > 3 : value visible and alterable
> > 40 : value invisible and append before
> > 41 : value invisible and append after

> If no parameter is associated with the "show" action, all the fields are displayed and alterable.

- hide : hides the client interface

- destroy : destroys the client

Events

- in : the client is started

- shown : the client interface is shown

- hidden : the client interface is hidden

- sent OK : the mail has been sent ;
The parameter is :

> id identifier
> sub subject

- sent KO : the mail has not been sent (an error occured) ;
The parameter is :

> id identifier
> sub subject

- destroyed : the client is destroyed

Zones

- Mail : mail interface zone (if no zone associated, the interface is a popup window)