m204wiki - User contributions [en]

Email class

2014-03-20T18:18:40Z

SNelson:

The <var>Email</var> class is a high level,
object oriented interface to client sockets that lets you write a <var class="product">SOUL</var> SMTP
(Simple Mail Transfer Protocol) request without knowledge of socket level programming
or the format of SMTP requests and responses.

The <var>Email</var> class methods let a <var class="product">SOUL</var> program act as an SMTP client.
SMTP clients send mail requests
to an SMTP server, not directly to other SMTP clients.
The <var>Email</var> class methods only support communication with SMTP servers.

An SMTP server will "store and forward" mail it receives.
This means that all
messages are first received in entirety on the SMTP server,
then the server attempts to deliver it to the recipients.
Mail delivery can be delayed by a server that is down or too busy to
accept connections.
"Store and forward" gives the SMTP server the ability
to retry delivery without making the SMTP client wait for completion.

A server might try to deliver a message for as long as a week or more.
This, of course, makes it impractical for a client to wait for delivery
confirmation, so the SMTP protocol does not provide such information.
A "success" response from an SMTP server indicates
only that the server has accepted the request and will
attempt to deliver the mail to the recipients.

Most SMTP servers will at least confirm that
any domain names in the recipient list are valid, but they cannot confirm that an
actual recipient name is valid.

<div id="jport"></div>
You must define a Janus <var>[[JANUS CLSOCK|CLSOCK]]</var> port to use the <var>Email</var> class.
If you supply the IP address
of the server and the port number in the port definition, SMTP
applications need only know the Janus port name to communicate with the server.
The following example defines a client socket port for use by SMTP applications.
For more detailed information about defining
<var class="product">Janus</var> client socket ports, see <var>[[JANUS DEFINE]]</var> and <var>[[JANUS CLSOCK]]</var>.

<p class="code">JANUS DEFINE MYSMTP * CLSOCK 5 REMOTE 198.242.244.100 25
</p>

<p class="note">'''Note:'''
To use <var>Email</var> objects under versions of Model 204 earlier than 7.5, you must have licensed <var class="product">[[Janus TCP/IP Base]]</var>, <var class="product">[[Janus Sockets]]</var>, '''and''' <var class="product">[[Janus SOAP]]</var>. Under version 7.5 and later,
you do not require <var class="product">Janus SOAP</var>. </p>

For information about using SOUL objects, see [[Object oriented programming in SOUL]] and
[[Getting started with OOP for User Language programmers]].

==Email class summary==
The following capabilities are provided by the <var>Email</var> class:
<ul>
<li>Creating general purpose e-mail for SMTP
<li>Sending general purpose e-mail via SMTP
<li>Setting e-mail content using <var>[[Longstrings]]</var>
<li>Sending MIME content (attachments and alternative content)
<li>Sending to multiple recipients
<li>Access to status (error or confirmation messages)
</ul>

You use the <var>Email</var> object to generate SMTP messages
(e-mail) to send to an SMTP server.
To construct a request, you use <var>Email</var> methods to set and inspect
header information, content, and attachments.
To send e-mail, you use the <var>[[Mail (Email function)|Mail]]</var> method.

[[List of Email methods]] contains a list of all the methods in the <var>Email</var> class.

==Dummy SMTP Server example==
This is an example of a very basic SMTP Server which simple excepts <var>Email</var> objects from a SMTP client in turn sends a response.
It does not store or retrieve messages.
No <var class="product">Janus</var> port definitions are shown.
For comments about defining <var class="product">Janus</var> ports for the <var>Email</var> class, see
the [[#jport|earlier]] remarks.

===Dummy SMTP Server===

<b>emclass.ul</b>:
<pre>
***********************************************************************
* *
* encoding enumerations. *
* *
***********************************************************************
enumeration encoding
public
value base64
value none
end public
end enumeration

***********************************************************************
* *
* emailPart class. *
* *
***********************************************************************
class emailPart

public
variable headers is object stringlist
variable body is object stringlist
function type is string len 255
function encoding is string len 255
function name is string len 255
function contentlist is object stringlist
function content is longstring
end public

***********************************************************************
* *
* Return complete contentlist from an emailPart *
* *
***********************************************************************
function contentlist is object stringlist

return %this:body

end function

***********************************************************************
* *
* Decode and return content from an emailPart *
* *
***********************************************************************
function content is longstring

%toke is object stringTokenizer
%token is string len 128
%encoding is string len 128
%lf is string len 1
%i is float
%j is float
%content is longstring
%concat is boolean initial(True)
%temp is longstring

if %this:body eq null then return ''; end if

%lf = '0A':x

for %i from %i + 1 to %this:body:count
if %this:encoding eq 'base64' then
%content = %content with %this:body(%i)
elseif %this:encoding eq 'quoted-printable' then
%temp = %this:body(%i):Unspace(Leading=False, Trailing=True, -
Compress=False)
if %concat = False then
%content = %content %lf
end if
for %j from 1 to %temp:Length - 2
if %temp:Substring(%j, 1) = '=' then
%content = %content %temp:Substring(%j + 1, 2): -
HexToString:AsciiToEbcdic(characterEncode=true)
%j = %j + 2
else
%content = %content %temp:Substring(%j, 1)
end if
end for
if %j <= %temp:Length then
for %j from %j to %temp:Length
%content = %content %temp:Substring(%j, 1)
end for
end if
if %content:Right(1) = '=' then
%concat = True
%content = %content:TrimRight(1)
else
%concat = False
end if
else
%content = %content %this:body(%i) with %lf
end if
end for

if %this:encoding eq 'base64' then
%content = %content:base64ToString
if %this:type:left(5) = 'text/' then
%content = %content:AsciiToEbcdic(CharacterEncode=true)
end if
end if

return %content

end function
***********************************************************************
* *
* Return the name (if present) of an emailPart *
* *
***********************************************************************
function name is string len 255

%type is string len 255
%name is string len 255
%temp is string len 255
%i is float
%n is float

for %i from 1 to %this:headers:count
%temp = %this:headers(%i)
if 'Content-Disposition:':toUpper eq %temp:word(1):toUpper then
for %i from %i + 1 to %this:headers:count
if %temp:word(1):right(1) eq ':' then loop end; end if
%temp = %temp %this:headers(%i)
end for
%i = %i - 1
%n = %temp:positionOf(' filename=')
if %n gt 0 then
%name = %temp:subString(%n)
end if
loop end;
end if
if 'Content-Type:':toUpper eq %temp:word(1):toUpper then
for %i from %i + 1 to %this:headers:count
if %temp:word(1):right(1) eq ':' then loop end; end if
%temp = %temp %this:headers(%i)
end for
%i = %i - 1
%n = %temp:positionOf(' name=')
if %n gt 0 then
%name = %temp:subString(%n)
end if
end if
end for

%name = %name:word(2, spaces=' =')
if %name:left(1) = '"' then %name = %name:trimLeft(1); end if
if %name:right(1) = '"' then %name = %name:trimRight(1); end if

return %name

end function

***********************************************************************
* *
* Return the encoding (if present) of an emailPart *
* *
***********************************************************************
function encoding is string len 255

%enc is string len 255
%temp is string len 255
%i is float
%n is float

for %i from 1 to %this:headers:count
%temp = %this:headers(%i)
if 'Content-Transfer-Encoding:':toUpper eq %temp:word(1):toUpper then
for %i from %i + 1 to %this:headers:count
if %this:headers(%i):word(1):right(1) eq ':' then loop end; end if
%temp = %temp %this:headers(%i)
end for
loop end;
end if
end for

if 'Content-Transfer-Encoding:':toUpper eq %temp:word(1):toUpper then
%enc = %temp:word(2)
if %enc:left(1) = '"' then %enc = %enc:trimLeft(1); end if
if %enc:right(1) = '"' then %enc = %enc:trimRight(1); end if
end if

if %enc = '' then %enc = '7bit'; end if

return %enc

end function

***********************************************************************
* *
* Return the content type of an emailPart *
* *
***********************************************************************
function type is string len 255

%type is string len 255
%temp is string len 255
%i is float
%n is float

for %i from 1 to %this:headers:count
%temp = %this:headers(%i)
if 'Content-Type:':toUpper eq %temp:word(1):toUpper then
for %i from %i + 1 to %this:headers:count
if %temp:word(1):right(1) eq ':' then loop end; end if
%temp = %temp %this:headers(%i)
end for
%i = %i - 1
loop end;
end if
end for

%type = %temp:word(2)
if %type:left(1) = '"' then %type = %type:trimLeft(1); end if
if %type:right(1) = '"' then %type = %type:trimRight(1); end if

if %type = '' then %type = 'text/plain'; end if

return %type

end function

end class

***********************************************************************
* *
* receivedEmail class. *
* *
***********************************************************************
class receivedEmail

public
variable headers is object stringlist
variable body is object stringlist
variable rcptList is object stringlist
variable fromHost is string len 128
variable from is string len 128

function header -
(%name is string len 255, %occur is float default(1)) -
is string len 255
function contentList (%x is float) is object stringlist
function part (%number is float) is object emailPart
function parts is float
end public

***********************************************************************
* *
* Return a header from the email message *
* *
***********************************************************************
function header -
(%name is string len 255, %occur is float default(1)) -
is string len 255

%i is float
%toke is object stringTokenizer
%token is string len 255

for %i from 1 to %this:headers:count
%toke = %this:headers(%i):stringTokenizer
%token = %toke:nextToken:toUpper
%toke:discard
if %name:toUpper eq %token then loop end; end if
end for

if %i > %this:headers:count then return ''; end if

%token = %this:headers(%i)
if %this:headers(%i):right(1) ne ';' then return %token; end if

for %i from %i + 1 to %this:headers:count
%token = %token %this:headers(%i)
if %this:headers(%i):right(1) ne ';' then loop end; end if
end for

return %token

end function

***********************************************************************
* *
* Return a "part" of an email message as an emailPart object. *
* *
***********************************************************************
function part (%number is float) is object emailPart

%i is float
%n is float
%bound is string len 72
%part is object emailPart
%encoding is string len 255
%partNumber is float
%cont is boolean initial(false)
%mime is boolean initial(false)
%temp is string len 255

%part = new
%part:headers = new

* Scan global headers for boundary
for %i from 1 to %this:headers:count
%temp = %this:headers(%i)
if 'Content-Type:':toUpper eq %temp:word(1):toUpper then
for %i from %i + 1 to %this:headers:count
if %this:headers(%i):word(1):right(1) eq ':' then loop end; end if
%temp = %temp %this:headers(%i)
end for
%n = %temp:positionOf('boundary=')
if %n gt 0 then
%bound = %temp:subString(%n)
end if
loop end;
end if
end for

%part:headers = new
%part:body = new

if %bound ne '' then
%bound = %bound:substring(10)
if %bound:left(1) = '"' then %bound = %bound:trimLeft(1); end if
if %bound:right(1) = '"' then %bound = %bound:trimRight(1); end if
%bound = '--' %bound;
for %i from 1 to %this:body:count
if %bound = %this:body(%i) then
%partNumber = %partNumber + 1
if %partNumber = %number then loop end; end if
end if
end for
for %i from %i + 1 to %this:body:count
if %this:body(%i) eq '' then loop end; end if
%part:headers:add(%this:body(%i))
end for
for %i from %i + 1 to %this:body:count
if %bound = %this:body(%i):substring(1, %bound:length) then
loop end;
end if
%part:body:add(%this:body(%i))
end for
else
assert %number eq 1
for %i from 1 to %this:headers:count
%temp = %this:headers(%i)
if 'Content-':toUpper eq %temp:word(1):left(8):toUpper then
%part:headers:add(%temp)
for %i from %i + 1 to %this:headers:count
if %this:headers(%i):word(1):right(1) eq ':' then loop end; end if
%part:headers:add(%this:headers(%i))
end for
%i = %i - 1
end if
end for
for %i from 1 to %this:body:count
%part:body:add(%this:body(%i))
end for
end if

return %part

end function

***********************************************************************
* *
* Return number of "parts" of an email message. *
* *
***********************************************************************
function parts is float

%i is float
%n is float
%bound is string len 128
%parts is float
%temp is longstring

* Scan global headers for boundary
for %i from 1 to %this:headers:count
%temp = %this:headers(%i)
if 'Content-Type:':toUpper eq %temp:word(1):toUpper then
for %i from %i + 1 to %this:headers:count
if %this:headers(%i):word(1):right(1) eq ':' then loop end; end if
%temp = %temp %this:headers(%i)
end for
%n = %temp:positionOf('boundary=')
if %n gt 0 then
%bound = %temp:subString(%n)
end if
loop end;
end if
end for

if %bound ne '' then
%bound = %bound:substring(10)
if %bound:left(1) = '"' then %bound = %bound:trimLeft(1); end if
if %bound:right(1) = '"' then %bound = %bound:trimRight(1); end if
%bound = '--' %bound;
else
return 1
end if

%parts = 0
for %i from 1 to %this:body:count
if %bound = %this:body(%i) then
%parts = %parts + 1
end if
end for

return %parts

end function

end class
***********************************************************************
* *
* smtpDriver class. *
* *
***********************************************************************
class smtpDriver
public shared
subroutine -
run(%processEmail is subroutine (receivedEmail):whatever)
end public shared

subroutine run(%processEmail is subroutine (receivedEmail):whatever)

%receivedEmail is object receivedEmail

*****************************************************************
* SMTP server program. *
*****************************************************************

*****************************************************************
* Static values used by the server. *
*****************************************************************

%serverId is string len 80 initial -
("host.sirius-software.com running Model 204 SMTP server")

*****************************************************************
* End of static values used by the server. *
*****************************************************************

local subroutine (stringList):audit
%i is float
for %i from 1 to %this:count
auditText {%i}: {%this(%i)}
end for
end subroutine

%remail is object receivedEmail

%msg is string len 128
%client is string len 128
%command is string len 16
%email is object receivedEmail
%esmtp is boolean initial(false)
%from is string len 128
%by is string len 128
%received is string len 255
%dateTime is string len 128
%inputLength is float
%inputLine is longstring
%sock is object socket
%toke is object stringTokenizer
%token is string len 128

%sock = serverSocket

%sock:set('CHAR', 'CHAR')
%sock:set('LINEND', '0D0A')
%sock:set('PRSTOK', '0D0A')

%dateTime = -
%(system):currentTimeString('DD Mon YYYY HH:MI:SS')
%sock:sendWithLineEnd( -
"220 " with %serverId with " on " with %dateTime)

%inputLength = %sock:receiveAndParse(%inputLine)

%toke = %inputLine:stringTokenizer

%command = %toke:nextToken:toUpper
if %command eq 'EHLO' then
%esmtp = true
elseIf %command ne 'HELO' then
auditText *** Incorrect hello message received, -
command={%command}, closing connection
%sock:close
stop
end if

%client = %toke:nextToken
%msg = "250 Hello " with %client with -
" I'm delighted to meet you"
%sock:sendWithLineEnd(%msg)

auditText **** Entering main SMTP loop for {%client}
repeat forever
%inputLength = %sock:receiveAndParse(%inputLine)
%toke = %inputLine:stringTokenizer
%command = %toke:nextToken:toUpper
if %command eq 'QUIT' then jump to quit; end if
if %command ne 'MAIL' then
auditText **** Unexpected command {%command} received, -
terminating connection
jump to close
end if
%token = %toke:nextToken
if %token:left(5):toUpper ne 'FROM:' then
auditText **** MAIL followed by {%token} not -
FROM:<email-address>, terminating connection
jump to close
end if
%from = %token:substring(6)
%sock:sendWithLineEnd("250 Ok")

%email = new
%email:rcptList = new

%toke = %sock:info('REMOTE'):stringTokenizer
%email:fromHost = %toke:nextToken

repeat forever
%inputLength = %sock:receiveAndParse(%inputLine)
%toke = %inputLine:stringTokenizer
%command = %toke:nextToken:toUpper
if %command eq 'QUIT' then jump to quit; end if
if %command ne 'RCPT' then loop end; end if
%token = %toke:nextToken
if %token:left(3):toUpper ne 'TO:' then
auditText **** RCPT followed by {%token} not -
TO:<email-address>, terminating connection
jump to close
end if
%email:rcptList:add(%token:substring(4))
%sock:sendWithLineEnd("250 Ok")
end repeat

if %email:rcptList:count eq 0 then
auditText **** No RCPT TO:s received after a -
MAIL FROM:, terminating connection
jump to close
end if

if %command ne 'DATA' then
auditText **** No DATA received after a RCPT TO:, -
terminating connection
jump to close
end if
%sock:sendWithLineEnd("354 End data with a single '.'")

%email:headers = new
setText %received = Received: from {%email:fromHost} by -
{%serverid} ; -
{%(system):currentTimeString('Wkd, DD Mon YYYY HH:MI:SS')}
%email:headers:add(%received)

repeat forever
%inputLength = %sock:receiveAndParse(%inputLine)
if %inputLine = '' then loop end; end if
if %inputLine eq '.' then loop end; end if
if %inputLine:left(2) eq '..' then
%inputLine = %inputLine:substring(2);
end if
%email:headers:add(%inputLine)
end repeat

%email:body = new
repeat forever
%inputLength = %sock:receiveAndParse(%inputLine)
if %inputLine eq '.' then loop end; end if
if %inputLine:left(2) eq '..' then
%inputLine = %inputLine:substring(2);
end if
%email:body:add(%inputLine)
end repeat

%sock:sendWithLineEnd("250 E-mail received")
end repeat

quit:

auditText **** QUIT received
%sock:sendWithLineEnd("221 Bye")

close:

auditText **** Terminating SMTP connection
%sock:close

%email:%processEmail

end subroutine

end class
</pre>
<b>driver.ul</b>:
<pre>
UTABLE LNTBL 128
b

i emclass.ul

local subroutine (receivedEmail):process

%i is float
%j is float
%x is float
%ls is longstring
%op is string len 8
%temp is string len 255
%ename is string len 255
%part is object emailPart
%tp is float

%tp = 0
setText %ename = CSURF_EMAIL_{$sir_date('YYMMDDHHMISS')}
%x = $bldproc(%tp, %ename, 'OPEN')
assert %x eq 0
*
* Get attachments and copy content to output procedure
*
%op = 'APPEND'
for %i from 1 to %this:parts
%part = %this:part(%i)
for %j from 1 to %part:headers:count
%temp = %part:headers(%j):left(255)
%x = $bldproc(%tp, %temp, %op)
assert %x eq 0
end for
for %j from 1 to %part:body:count
%temp = %part:body(%j):left(255)
%x = $bldproc(%tp, %temp, %op)
assert %x eq 0
end for
end for

end subroutine

%(smtpDriver):run(process)

end
USE Fred
DISPLAY PROCEDURE 0
</pre>

==SMTP examples==
Examples follow in which <var>Email</var> objects are used to create and send a request to an SMTP server.
No <var class="product">Janus</var> port definitions are shown.
For comments about defining <var class="product">Janus</var> ports for the <var>Email</var> class, see
the [[#jport|earlier]] remarks.

===Basic e-mail example===
This example uses most of the <var>Email</var> methods to send a simple message to three recipients.
The local <var>CLSOCK</var> port used is named <code>SPAM</code>.
<p class="code">b

%letter object Email
%h longstring
%t longstring
%name longstring
%nick string len 64

%letter = new

%name = 'C_Coolidge@presidents.usa'
%nick = 'SilentCal'
%letter:AddRecipient(%name, %nick)

%name = 'D_Eisenhower@presidents.usa'
%nick = 'Ike'
%letter:AddCc(%name, %nick)

%name = L_Johnson@presidents.usa'
%nick = 'LBJ'
%letter:AddBcc(%name, %nick)

%letter:Sender('a_huckster@bankandtrustme.com')

%h = 'Subject:'
%t = 'Lower Mortgage Rates'
%letter:AddHeader(%h, %t)

%h = 'Great deal of debt for you!'
%letter:SetBody(%h)

%letter:mail('SPAM', 0)

print %letter:GetReplyCode with ' - ' with -
%letter:GetReplyText

%letter:discard
end
</p>

===E-mail with attachment===
In the following example, an image is attached to a short e-mail message.
The attachment is produced from a member of a local <var class="product">Model 204</var> procedure file
using <var>Stringlist</var> class methods.

<p class="code">b
%rolex is object Email
%sl is object Stringlist
%procdata is object Stringlist
%jpg longstring
%t longstring
%temp string len 255
%procfile string len 10
%procname string len 63
%q float
%rc float

%rolex = new
%sl = new

%t = 'jbgood@netscape.net'
%rolex:AddRecipient(%t, 'JB')

%t = 'cberry@ucantbee-sirius.com'
%rolex:Sender(%t)
%rolex:AddHeader('Subject:', 'watch this...')

text to %sl
I want an authentic imitation Rolex watch. Something like
the one shown in this image. Know anyone who's got one?
end text
%rolex:SetBody(%sl, encoding='none', type='text/plain')

%procfile = 'MYPROC'
%procname = 'FAKE5.JPG'
%rc = $procopn(%procname, %procfile)
if %rc ne 0 then
print 'Can''t open procedure ' with %procname -
with ' in file ' with %procfile with ', rc = ' -
with %rc
stop
end if

%procdata = new
%procdata:appendOpenProcedure
%jpg = %procData:binaryProcedureDecode
%rolex:AddPart(%jpg, type='image/jpg', name='Rolex1.jpg')

print %rolex:mail('MYSMTP', 0) ' is return from Mail method'
print %rolex:GetReplyCode ' is return from GetReplyCode'
print %rolex:GetReplyText

%rolex:discard
end
</p>

If the request is successful, results like the following display at the terminal:

<p class="code">0 is return from Mail method
221 is return from GetReplyCode
ucantbee-sirius.com running IBM VM SMTP Level 320
closing connection
</p>

==List of Email methods==
The [[List of Email methods|"List of Email methods"]] shows all the class methods.

==See also==
<ul>
<li>[[Janus Sockets User Language coding considerations]]
<li>[[Sample Janus Sockets programs]]
<li>Socket-level interfaces:
<ul>
<li>[[Janus Sockets $functions|$functions]]
<li>[[Socket class]]
</ul>
<li>Higher-level interfaces:
<ul>
<li>[[Email class]]
<li>[[HTTP Helper|HTTP Helper classes]]
<li>[[LDAP class]]
<li>[[Janus FTP Server]]
<li>[[Janus Telnet Server]]
</ul>

[[Category: Janus Sockets]]
[[Category:System classes]]

Email class

2014-03-20T18:03:58Z

SNelson:

The <var>Email</var> class is a high level,
object oriented interface to client sockets that lets you write a <var class="product">SOUL</var> SMTP
(Simple Mail Transfer Protocol) request without knowledge of socket level programming
or the format of SMTP requests and responses.

The <var>Email</var> class methods let a <var class="product">SOUL</var> program act as an SMTP client.
SMTP clients send mail requests
to an SMTP server, not directly to other SMTP clients.
The <var>Email</var> class methods only support communication with SMTP servers.

An SMTP server will "store and forward" mail it receives.
This means that all
messages are first received in entirety on the SMTP server,
then the server attempts to deliver it to the recipients.
Mail delivery can be delayed by a server that is down or too busy to
accept connections.
"Store and forward" gives the SMTP server the ability
to retry delivery without making the SMTP client wait for completion.

A server might try to deliver a message for as long as a week or more.
This, of course, makes it impractical for a client to wait for delivery
confirmation, so the SMTP protocol does not provide such information.
A "success" response from an SMTP server indicates
only that the server has accepted the request and will
attempt to deliver the mail to the recipients.

Most SMTP servers will at least confirm that
any domain names in the recipient list are valid, but they cannot confirm that an
actual recipient name is valid.

<div id="jport"></div>
You must define a Janus <var>[[JANUS CLSOCK|CLSOCK]]</var> port to use the <var>Email</var> class.
If you supply the IP address
of the server and the port number in the port definition, SMTP
applications need only know the Janus port name to communicate with the server.
The following example defines a client socket port for use by SMTP applications.
For more detailed information about defining
<var class="product">Janus</var> client socket ports, see <var>[[JANUS DEFINE]]</var> and <var>[[JANUS CLSOCK]]</var>.

<p class="code">JANUS DEFINE MYSMTP * CLSOCK 5 REMOTE 198.242.244.100 25
</p>

<p class="note">'''Note:'''
To use <var>Email</var> objects under versions of Model 204 earlier than 7.5, you must have licensed <var class="product">[[Janus TCP/IP Base]]</var>, <var class="product">[[Janus Sockets]]</var>, '''and''' <var class="product">[[Janus SOAP]]</var>. Under version 7.5 and later,
you do not require <var class="product">Janus SOAP</var>. </p>

For information about using SOUL objects, see [[Object oriented programming in SOUL]] and
[[Getting started with OOP for User Language programmers]].

==Email class summary==
The following capabilities are provided by the <var>Email</var> class:
<ul>
<li>Creating general purpose e-mail for SMTP
<li>Sending general purpose e-mail via SMTP
<li>Setting e-mail content using <var>[[Longstrings]]</var>
<li>Sending MIME content (attachments and alternative content)
<li>Sending to multiple recipients
<li>Access to status (error or confirmation messages)
</ul>

You use the <var>Email</var> object to generate SMTP messages
(e-mail) to send to an SMTP server.
To construct a request, you use <var>Email</var> methods to set and inspect
header information, content, and attachments.
To send e-mail, you use the <var>[[Mail (Email function)|Mail]]</var> method.

[[List of Email methods]] contains a list of all the methods in the <var>Email</var> class.

==Dummy SMTP Server example==
This is an example of very basic SMTP Service which simple excepts <var>Email</var> objects from a SMTP client and response back to the client.
No <var class="product">Janus</var> port definitions are shown.
For comments about defining <var class="product">Janus</var> ports for the <var>Email</var> class, see
the [[#jport|earlier]] remarks.

===Dummy SMTP Server example===

<b>emclass.ul</b>:
<pre>
***********************************************************************
* *
* encoding enumerations. *
* *
***********************************************************************
enumeration encoding
public
value base64
value none
end public
end enumeration

***********************************************************************
* *
* emailPart class. *
* *
***********************************************************************
class emailPart

public
variable headers is object stringlist
variable body is object stringlist
function type is string len 255
function encoding is string len 255
function name is string len 255
function contentlist is object stringlist
function content is longstring
end public

***********************************************************************
* *
* Return complete contentlist from an emailPart *
* *
***********************************************************************
function contentlist is object stringlist

return %this:body

end function

***********************************************************************
* *
* Decode and return content from an emailPart *
* *
***********************************************************************
function content is longstring

%toke is object stringTokenizer
%token is string len 128
%encoding is string len 128
%lf is string len 1
%i is float
%j is float
%content is longstring
%concat is boolean initial(True)
%temp is longstring

if %this:body eq null then return ''; end if

%lf = '0A':x

for %i from %i + 1 to %this:body:count
if %this:encoding eq 'base64' then
%content = %content with %this:body(%i)
elseif %this:encoding eq 'quoted-printable' then
%temp = %this:body(%i):Unspace(Leading=False, Trailing=True, -
Compress=False)
if %concat = False then
%content = %content %lf
end if
for %j from 1 to %temp:Length - 2
if %temp:Substring(%j, 1) = '=' then
%content = %content %temp:Substring(%j + 1, 2): -
HexToString:AsciiToEbcdic(characterEncode=true)
%j = %j + 2
else
%content = %content %temp:Substring(%j, 1)
end if
end for
if %j <= %temp:Length then
for %j from %j to %temp:Length
%content = %content %temp:Substring(%j, 1)
end for
end if
if %content:Right(1) = '=' then
%concat = True
%content = %content:TrimRight(1)
else
%concat = False
end if
else
%content = %content %this:body(%i) with %lf
end if
end for

if %this:encoding eq 'base64' then
%content = %content:base64ToString
if %this:type:left(5) = 'text/' then
%content = %content:AsciiToEbcdic(CharacterEncode=true)
end if
end if

return %content

end function
***********************************************************************
* *
* Return the name (if present) of an emailPart *
* *
***********************************************************************
function name is string len 255

%type is string len 255
%name is string len 255
%temp is string len 255
%i is float
%n is float

for %i from 1 to %this:headers:count
%temp = %this:headers(%i)
if 'Content-Disposition:':toUpper eq %temp:word(1):toUpper then
for %i from %i + 1 to %this:headers:count
if %temp:word(1):right(1) eq ':' then loop end; end if
%temp = %temp %this:headers(%i)
end for
%i = %i - 1
%n = %temp:positionOf(' filename=')
if %n gt 0 then
%name = %temp:subString(%n)
end if
loop end;
end if
if 'Content-Type:':toUpper eq %temp:word(1):toUpper then
for %i from %i + 1 to %this:headers:count
if %temp:word(1):right(1) eq ':' then loop end; end if
%temp = %temp %this:headers(%i)
end for
%i = %i - 1
%n = %temp:positionOf(' name=')
if %n gt 0 then
%name = %temp:subString(%n)
end if
end if
end for

%name = %name:word(2, spaces=' =')
if %name:left(1) = '"' then %name = %name:trimLeft(1); end if
if %name:right(1) = '"' then %name = %name:trimRight(1); end if

return %name

end function

***********************************************************************
* *
* Return the encoding (if present) of an emailPart *
* *
***********************************************************************
function encoding is string len 255

%enc is string len 255
%temp is string len 255
%i is float
%n is float

for %i from 1 to %this:headers:count
%temp = %this:headers(%i)
if 'Content-Transfer-Encoding:':toUpper eq %temp:word(1):toUpper then
for %i from %i + 1 to %this:headers:count
if %this:headers(%i):word(1):right(1) eq ':' then loop end; end if
%temp = %temp %this:headers(%i)
end for
loop end;
end if
end for

if 'Content-Transfer-Encoding:':toUpper eq %temp:word(1):toUpper then
%enc = %temp:word(2)
if %enc:left(1) = '"' then %enc = %enc:trimLeft(1); end if
if %enc:right(1) = '"' then %enc = %enc:trimRight(1); end if
end if

if %enc = '' then %enc = '7bit'; end if

return %enc

end function

***********************************************************************
* *
* Return the content type of an emailPart *
* *
***********************************************************************
function type is string len 255

%type is string len 255
%temp is string len 255
%i is float
%n is float

for %i from 1 to %this:headers:count
%temp = %this:headers(%i)
if 'Content-Type:':toUpper eq %temp:word(1):toUpper then
for %i from %i + 1 to %this:headers:count
if %temp:word(1):right(1) eq ':' then loop end; end if
%temp = %temp %this:headers(%i)
end for
%i = %i - 1
loop end;
end if
end for

%type = %temp:word(2)
if %type:left(1) = '"' then %type = %type:trimLeft(1); end if
if %type:right(1) = '"' then %type = %type:trimRight(1); end if

if %type = '' then %type = 'text/plain'; end if

return %type

end function

end class

***********************************************************************
* *
* receivedEmail class. *
* *
***********************************************************************
class receivedEmail

public
variable headers is object stringlist
variable body is object stringlist
variable rcptList is object stringlist
variable fromHost is string len 128
variable from is string len 128

function header -
(%name is string len 255, %occur is float default(1)) -
is string len 255
function contentList (%x is float) is object stringlist
function part (%number is float) is object emailPart
function parts is float
end public

***********************************************************************
* *
* Return a header from the email message *
* *
***********************************************************************
function header -
(%name is string len 255, %occur is float default(1)) -
is string len 255

%i is float
%toke is object stringTokenizer
%token is string len 255

for %i from 1 to %this:headers:count
%toke = %this:headers(%i):stringTokenizer
%token = %toke:nextToken:toUpper
%toke:discard
if %name:toUpper eq %token then loop end; end if
end for

if %i > %this:headers:count then return ''; end if

%token = %this:headers(%i)
if %this:headers(%i):right(1) ne ';' then return %token; end if

for %i from %i + 1 to %this:headers:count
%token = %token %this:headers(%i)
if %this:headers(%i):right(1) ne ';' then loop end; end if
end for

return %token

end function

***********************************************************************
* *
* Return a "part" of an email message as an emailPart object. *
* *
***********************************************************************
function part (%number is float) is object emailPart

%i is float
%n is float
%bound is string len 72
%part is object emailPart
%encoding is string len 255
%partNumber is float
%cont is boolean initial(false)
%mime is boolean initial(false)
%temp is string len 255

%part = new
%part:headers = new

* Scan global headers for boundary
for %i from 1 to %this:headers:count
%temp = %this:headers(%i)
if 'Content-Type:':toUpper eq %temp:word(1):toUpper then
for %i from %i + 1 to %this:headers:count
if %this:headers(%i):word(1):right(1) eq ':' then loop end; end if
%temp = %temp %this:headers(%i)
end for
%n = %temp:positionOf('boundary=')
if %n gt 0 then
%bound = %temp:subString(%n)
end if
loop end;
end if
end for

%part:headers = new
%part:body = new

if %bound ne '' then
%bound = %bound:substring(10)
if %bound:left(1) = '"' then %bound = %bound:trimLeft(1); end if
if %bound:right(1) = '"' then %bound = %bound:trimRight(1); end if
%bound = '--' %bound;
for %i from 1 to %this:body:count
if %bound = %this:body(%i) then
%partNumber = %partNumber + 1
if %partNumber = %number then loop end; end if
end if
end for
for %i from %i + 1 to %this:body:count
if %this:body(%i) eq '' then loop end; end if
%part:headers:add(%this:body(%i))
end for
for %i from %i + 1 to %this:body:count
if %bound = %this:body(%i):substring(1, %bound:length) then
loop end;
end if
%part:body:add(%this:body(%i))
end for
else
assert %number eq 1
for %i from 1 to %this:headers:count
%temp = %this:headers(%i)
if 'Content-':toUpper eq %temp:word(1):left(8):toUpper then
%part:headers:add(%temp)
for %i from %i + 1 to %this:headers:count
if %this:headers(%i):word(1):right(1) eq ':' then loop end; end if
%part:headers:add(%this:headers(%i))
end for
%i = %i - 1
end if
end for
for %i from 1 to %this:body:count
%part:body:add(%this:body(%i))
end for
end if

return %part

end function

***********************************************************************
* *
* Return number of "parts" of an email message. *
* *
***********************************************************************
function parts is float

%i is float
%n is float
%bound is string len 128
%parts is float
%temp is longstring

* Scan global headers for boundary
for %i from 1 to %this:headers:count
%temp = %this:headers(%i)
if 'Content-Type:':toUpper eq %temp:word(1):toUpper then
for %i from %i + 1 to %this:headers:count
if %this:headers(%i):word(1):right(1) eq ':' then loop end; end if
%temp = %temp %this:headers(%i)
end for
%n = %temp:positionOf('boundary=')
if %n gt 0 then
%bound = %temp:subString(%n)
end if
loop end;
end if
end for

if %bound ne '' then
%bound = %bound:substring(10)
if %bound:left(1) = '"' then %bound = %bound:trimLeft(1); end if
if %bound:right(1) = '"' then %bound = %bound:trimRight(1); end if
%bound = '--' %bound;
else
return 1
end if

%parts = 0
for %i from 1 to %this:body:count
if %bound = %this:body(%i) then
%parts = %parts + 1
end if
end for

return %parts

end function

end class
***********************************************************************
* *
* smtpDriver class. *
* *
***********************************************************************
class smtpDriver
public shared
subroutine -
run(%processEmail is subroutine (receivedEmail):whatever)
end public shared

subroutine run(%processEmail is subroutine (receivedEmail):whatever)

%receivedEmail is object receivedEmail

*****************************************************************
* SMTP server program. *
*****************************************************************

*****************************************************************
* Static values used by the server. *
*****************************************************************

%serverId is string len 80 initial -
("host.sirius-software.com running Model 204 SMTP server")

*****************************************************************
* End of static values used by the server. *
*****************************************************************

local subroutine (stringList):audit
%i is float
for %i from 1 to %this:count
auditText {%i}: {%this(%i)}
end for
end subroutine

%remail is object receivedEmail

%msg is string len 128
%client is string len 128
%command is string len 16
%email is object receivedEmail
%esmtp is boolean initial(false)
%from is string len 128
%by is string len 128
%received is string len 255
%dateTime is string len 128
%inputLength is float
%inputLine is longstring
%sock is object socket
%toke is object stringTokenizer
%token is string len 128

%sock = serverSocket

%sock:set('CHAR', 'CHAR')
%sock:set('LINEND', '0D0A')
%sock:set('PRSTOK', '0D0A')

%dateTime = -
%(system):currentTimeString('DD Mon YYYY HH:MI:SS')
%sock:sendWithLineEnd( -
"220 " with %serverId with " on " with %dateTime)

%inputLength = %sock:receiveAndParse(%inputLine)

%toke = %inputLine:stringTokenizer

%command = %toke:nextToken:toUpper
if %command eq 'EHLO' then
%esmtp = true
elseIf %command ne 'HELO' then
auditText *** Incorrect hello message received, -
command={%command}, closing connection
%sock:close
stop
end if

%client = %toke:nextToken
%msg = "250 Hello " with %client with -
" I'm delighted to meet you"
%sock:sendWithLineEnd(%msg)

auditText **** Entering main SMTP loop for {%client}
repeat forever
%inputLength = %sock:receiveAndParse(%inputLine)
%toke = %inputLine:stringTokenizer
%command = %toke:nextToken:toUpper
if %command eq 'QUIT' then jump to quit; end if
if %command ne 'MAIL' then
auditText **** Unexpected command {%command} received, -
terminating connection
jump to close
end if
%token = %toke:nextToken
if %token:left(5):toUpper ne 'FROM:' then
auditText **** MAIL followed by {%token} not -
FROM:<email-address>, terminating connection
jump to close
end if
%from = %token:substring(6)
%sock:sendWithLineEnd("250 Ok")

%email = new
%email:rcptList = new

%toke = %sock:info('REMOTE'):stringTokenizer
%email:fromHost = %toke:nextToken

repeat forever
%inputLength = %sock:receiveAndParse(%inputLine)
%toke = %inputLine:stringTokenizer
%command = %toke:nextToken:toUpper
if %command eq 'QUIT' then jump to quit; end if
if %command ne 'RCPT' then loop end; end if
%token = %toke:nextToken
if %token:left(3):toUpper ne 'TO:' then
auditText **** RCPT followed by {%token} not -
TO:<email-address>, terminating connection
jump to close
end if
%email:rcptList:add(%token:substring(4))
%sock:sendWithLineEnd("250 Ok")
end repeat

if %email:rcptList:count eq 0 then
auditText **** No RCPT TO:s received after a -
MAIL FROM:, terminating connection
jump to close
end if

if %command ne 'DATA' then
auditText **** No DATA received after a RCPT TO:, -
terminating connection
jump to close
end if
%sock:sendWithLineEnd("354 End data with a single '.'")

%email:headers = new
setText %received = Received: from {%email:fromHost} by -
{%serverid} ; -
{%(system):currentTimeString('Wkd, DD Mon YYYY HH:MI:SS')}
%email:headers:add(%received)

repeat forever
%inputLength = %sock:receiveAndParse(%inputLine)
if %inputLine = '' then loop end; end if
if %inputLine eq '.' then loop end; end if
if %inputLine:left(2) eq '..' then
%inputLine = %inputLine:substring(2);
end if
%email:headers:add(%inputLine)
end repeat

%email:body = new
repeat forever
%inputLength = %sock:receiveAndParse(%inputLine)
if %inputLine eq '.' then loop end; end if
if %inputLine:left(2) eq '..' then
%inputLine = %inputLine:substring(2);
end if
%email:body:add(%inputLine)
end repeat

%sock:sendWithLineEnd("250 E-mail received")
end repeat

quit:

auditText **** QUIT received
%sock:sendWithLineEnd("221 Bye")

close:

auditText **** Terminating SMTP connection
%sock:close

%email:%processEmail

end subroutine

end class
</pre>
<b>driver.ul</b>:
<pre>
UTABLE LNTBL 128
b

i emclass.ul

local subroutine (receivedEmail):process

%i is float
%j is float
%x is float
%ls is longstring
%op is string len 8
%temp is string len 255
%ename is string len 255
%part is object emailPart
%tp is float

%tp = 0
setText %ename = CSURF_EMAIL_{$sir_date('YYMMDDHHMISS')}
%x = $bldproc(%tp, %ename, 'OPEN')
assert %x eq 0
*
* Get attachments and copy content to output procedure
*
%op = 'APPEND'
for %i from 1 to %this:parts
%part = %this:part(%i)
for %j from 1 to %part:headers:count
%temp = %part:headers(%j):left(255)
%x = $bldproc(%tp, %temp, %op)
assert %x eq 0
end for
for %j from 1 to %part:body:count
%temp = %part:body(%j):left(255)
%x = $bldproc(%tp, %temp, %op)
assert %x eq 0
end for
end for

end subroutine

%(smtpDriver):run(process)

end
USE Fred
DISPLAY PROCEDURE 0
</pre>

==SMTP examples==
Examples follow in which <var>Email</var> objects are used to create and send a request to an SMTP server.
No <var class="product">Janus</var> port definitions are shown.
For comments about defining <var class="product">Janus</var> ports for the <var>Email</var> class, see
the [[#jport|earlier]] remarks.

===Basic e-mail example===
This example uses most of the <var>Email</var> methods to send a simple message to three recipients.
The local <var>CLSOCK</var> port used is named <code>SPAM</code>.
<p class="code">b

%letter object Email
%h longstring
%t longstring
%name longstring
%nick string len 64

%letter = new

%name = 'C_Coolidge@presidents.usa'
%nick = 'SilentCal'
%letter:AddRecipient(%name, %nick)

%name = 'D_Eisenhower@presidents.usa'
%nick = 'Ike'
%letter:AddCc(%name, %nick)

%name = L_Johnson@presidents.usa'
%nick = 'LBJ'
%letter:AddBcc(%name, %nick)

%letter:Sender('a_huckster@bankandtrustme.com')

%h = 'Subject:'
%t = 'Lower Mortgage Rates'
%letter:AddHeader(%h, %t)

%h = 'Great deal of debt for you!'
%letter:SetBody(%h)

%letter:mail('SPAM', 0)

print %letter:GetReplyCode with ' - ' with -
%letter:GetReplyText

%letter:discard
end
</p>

===E-mail with attachment===
In the following example, an image is attached to a short e-mail message.
The attachment is produced from a member of a local <var class="product">Model 204</var> procedure file
using <var>Stringlist</var> class methods.

<p class="code">b
%rolex is object Email
%sl is object Stringlist
%procdata is object Stringlist
%jpg longstring
%t longstring
%temp string len 255
%procfile string len 10
%procname string len 63
%q float
%rc float

%rolex = new
%sl = new

%t = 'jbgood@netscape.net'
%rolex:AddRecipient(%t, 'JB')

%t = 'cberry@ucantbee-sirius.com'
%rolex:Sender(%t)
%rolex:AddHeader('Subject:', 'watch this...')

text to %sl
I want an authentic imitation Rolex watch. Something like
the one shown in this image. Know anyone who's got one?
end text
%rolex:SetBody(%sl, encoding='none', type='text/plain')

%procfile = 'MYPROC'
%procname = 'FAKE5.JPG'
%rc = $procopn(%procname, %procfile)
if %rc ne 0 then
print 'Can''t open procedure ' with %procname -
with ' in file ' with %procfile with ', rc = ' -
with %rc
stop
end if

%procdata = new
%procdata:appendOpenProcedure
%jpg = %procData:binaryProcedureDecode
%rolex:AddPart(%jpg, type='image/jpg', name='Rolex1.jpg')

print %rolex:mail('MYSMTP', 0) ' is return from Mail method'
print %rolex:GetReplyCode ' is return from GetReplyCode'
print %rolex:GetReplyText

%rolex:discard
end
</p>

If the request is successful, results like the following display at the terminal:

<p class="code">0 is return from Mail method
221 is return from GetReplyCode
ucantbee-sirius.com running IBM VM SMTP Level 320
closing connection
</p>

==List of Email methods==
The [[List of Email methods|"List of Email methods"]] shows all the class methods.

==See also==
<ul>
<li>[[Janus Sockets User Language coding considerations]]
<li>[[Sample Janus Sockets programs]]
<li>Socket-level interfaces:
<ul>
<li>[[Janus Sockets $functions|$functions]]
<li>[[Socket class]]
</ul>
<li>Higher-level interfaces:
<ul>
<li>[[Email class]]
<li>[[HTTP Helper|HTTP Helper classes]]
<li>[[LDAP class]]
<li>[[Janus FTP Server]]
<li>[[Janus Telnet Server]]
</ul>

[[Category: Janus Sockets]]
[[Category:System classes]]

Email class

2014-03-20T18:03:00Z

SNelson:

The <var>Email</var> class is a high level,
object oriented interface to client sockets that lets you write a <var class="product">SOUL</var> SMTP
(Simple Mail Transfer Protocol) request without knowledge of socket level programming
or the format of SMTP requests and responses.

The <var>Email</var> class methods let a <var class="product">SOUL</var> program act as an SMTP client.
SMTP clients send mail requests
to an SMTP server, not directly to other SMTP clients.
The <var>Email</var> class methods only support communication with SMTP servers.

An SMTP server will "store and forward" mail it receives.
This means that all
messages are first received in entirety on the SMTP server,
then the server attempts to deliver it to the recipients.
Mail delivery can be delayed by a server that is down or too busy to
accept connections.
"Store and forward" gives the SMTP server the ability
to retry delivery without making the SMTP client wait for completion.

A server might try to deliver a message for as long as a week or more.
This, of course, makes it impractical for a client to wait for delivery
confirmation, so the SMTP protocol does not provide such information.
A "success" response from an SMTP server indicates
only that the server has accepted the request and will
attempt to deliver the mail to the recipients.

Most SMTP servers will at least confirm that
any domain names in the recipient list are valid, but they cannot confirm that an
actual recipient name is valid.

<div id="jport"></div>
You must define a Janus <var>[[JANUS CLSOCK|CLSOCK]]</var> port to use the <var>Email</var> class.
If you supply the IP address
of the server and the port number in the port definition, SMTP
applications need only know the Janus port name to communicate with the server.
The following example defines a client socket port for use by SMTP applications.
For more detailed information about defining
<var class="product">Janus</var> client socket ports, see <var>[[JANUS DEFINE]]</var> and <var>[[JANUS CLSOCK]]</var>.

<p class="code">JANUS DEFINE MYSMTP * CLSOCK 5 REMOTE 198.242.244.100 25
</p>

<p class="note">'''Note:'''
To use <var>Email</var> objects under versions of Model 204 earlier than 7.5, you must have licensed <var class="product">[[Janus TCP/IP Base]]</var>, <var class="product">[[Janus Sockets]]</var>, '''and''' <var class="product">[[Janus SOAP]]</var>. Under version 7.5 and later,
you do not require <var class="product">Janus SOAP</var>. </p>

For information about using SOUL objects, see [[Object oriented programming in SOUL]] and
[[Getting started with OOP for User Language programmers]].

==Email class summary==
The following capabilities are provided by the <var>Email</var> class:
<ul>
<li>Creating general purpose e-mail for SMTP
<li>Sending general purpose e-mail via SMTP
<li>Setting e-mail content using <var>[[Longstrings]]</var>
<li>Sending MIME content (attachments and alternative content)
<li>Sending to multiple recipients
<li>Access to status (error or confirmation messages)
</ul>

You use the <var>Email</var> object to generate SMTP messages
(e-mail) to send to an SMTP server.
To construct a request, you use <var>Email</var> methods to set and inspect
header information, content, and attachments.
To send e-mail, you use the <var>[[Mail (Email function)|Mail]]</var> method.

[[List of Email methods]] contains a list of all the methods in the <var>Email</var> class.

==Dummy SMTP Server example==
This is an example of very basic SMTP Service which simple excepts <var>Email</var> objects from a SMTP client and response back to the client.
No <var class="product">Janus</var> port definitions are shown.
For comments about defining <var class="product">Janus</var> ports for the <var>Email</var> class, see
the [[#jport|earlier]] remarks.

===Dummy SMTP Server example===

<b>emclass</b>:
<pre>
***********************************************************************
* *
* encoding enumerations. *
* *
***********************************************************************
enumeration encoding
public
value base64
value none
end public
end enumeration

***********************************************************************
* *
* emailPart class. *
* *
***********************************************************************
class emailPart

public
variable headers is object stringlist
variable body is object stringlist
function type is string len 255
function encoding is string len 255
function name is string len 255
function contentlist is object stringlist
function content is longstring
end public

***********************************************************************
* *
* Return complete contentlist from an emailPart *
* *
***********************************************************************
function contentlist is object stringlist

return %this:body

end function

***********************************************************************
* *
* Decode and return content from an emailPart *
* *
***********************************************************************
function content is longstring

%toke is object stringTokenizer
%token is string len 128
%encoding is string len 128
%lf is string len 1
%i is float
%j is float
%content is longstring
%concat is boolean initial(True)
%temp is longstring

if %this:body eq null then return ''; end if

%lf = '0A':x

for %i from %i + 1 to %this:body:count
if %this:encoding eq 'base64' then
%content = %content with %this:body(%i)
elseif %this:encoding eq 'quoted-printable' then
%temp = %this:body(%i):Unspace(Leading=False, Trailing=True, -
Compress=False)
if %concat = False then
%content = %content %lf
end if
for %j from 1 to %temp:Length - 2
if %temp:Substring(%j, 1) = '=' then
%content = %content %temp:Substring(%j + 1, 2): -
HexToString:AsciiToEbcdic(characterEncode=true)
%j = %j + 2
else
%content = %content %temp:Substring(%j, 1)
end if
end for
if %j <= %temp:Length then
for %j from %j to %temp:Length
%content = %content %temp:Substring(%j, 1)
end for
end if
if %content:Right(1) = '=' then
%concat = True
%content = %content:TrimRight(1)
else
%concat = False
end if
else
%content = %content %this:body(%i) with %lf
end if
end for

if %this:encoding eq 'base64' then
%content = %content:base64ToString
if %this:type:left(5) = 'text/' then
%content = %content:AsciiToEbcdic(CharacterEncode=true)
end if
end if

return %content

end function
***********************************************************************
* *
* Return the name (if present) of an emailPart *
* *
***********************************************************************
function name is string len 255

%type is string len 255
%name is string len 255
%temp is string len 255
%i is float
%n is float

for %i from 1 to %this:headers:count
%temp = %this:headers(%i)
if 'Content-Disposition:':toUpper eq %temp:word(1):toUpper then
for %i from %i + 1 to %this:headers:count
if %temp:word(1):right(1) eq ':' then loop end; end if
%temp = %temp %this:headers(%i)
end for
%i = %i - 1
%n = %temp:positionOf(' filename=')
if %n gt 0 then
%name = %temp:subString(%n)
end if
loop end;
end if
if 'Content-Type:':toUpper eq %temp:word(1):toUpper then
for %i from %i + 1 to %this:headers:count
if %temp:word(1):right(1) eq ':' then loop end; end if
%temp = %temp %this:headers(%i)
end for
%i = %i - 1
%n = %temp:positionOf(' name=')
if %n gt 0 then
%name = %temp:subString(%n)
end if
end if
end for

%name = %name:word(2, spaces=' =')
if %name:left(1) = '"' then %name = %name:trimLeft(1); end if
if %name:right(1) = '"' then %name = %name:trimRight(1); end if

return %name

end function

***********************************************************************
* *
* Return the encoding (if present) of an emailPart *
* *
***********************************************************************
function encoding is string len 255

%enc is string len 255
%temp is string len 255
%i is float
%n is float

for %i from 1 to %this:headers:count
%temp = %this:headers(%i)
if 'Content-Transfer-Encoding:':toUpper eq %temp:word(1):toUpper then
for %i from %i + 1 to %this:headers:count
if %this:headers(%i):word(1):right(1) eq ':' then loop end; end if
%temp = %temp %this:headers(%i)
end for
loop end;
end if
end for

if 'Content-Transfer-Encoding:':toUpper eq %temp:word(1):toUpper then
%enc = %temp:word(2)
if %enc:left(1) = '"' then %enc = %enc:trimLeft(1); end if
if %enc:right(1) = '"' then %enc = %enc:trimRight(1); end if
end if

if %enc = '' then %enc = '7bit'; end if

return %enc

end function

***********************************************************************
* *
* Return the content type of an emailPart *
* *
***********************************************************************
function type is string len 255

%type is string len 255
%temp is string len 255
%i is float
%n is float

for %i from 1 to %this:headers:count
%temp = %this:headers(%i)
if 'Content-Type:':toUpper eq %temp:word(1):toUpper then
for %i from %i + 1 to %this:headers:count
if %temp:word(1):right(1) eq ':' then loop end; end if
%temp = %temp %this:headers(%i)
end for
%i = %i - 1
loop end;
end if
end for

%type = %temp:word(2)
if %type:left(1) = '"' then %type = %type:trimLeft(1); end if
if %type:right(1) = '"' then %type = %type:trimRight(1); end if

if %type = '' then %type = 'text/plain'; end if

return %type

end function

end class

***********************************************************************
* *
* receivedEmail class. *
* *
***********************************************************************
class receivedEmail

public
variable headers is object stringlist
variable body is object stringlist
variable rcptList is object stringlist
variable fromHost is string len 128
variable from is string len 128

function header -
(%name is string len 255, %occur is float default(1)) -
is string len 255
function contentList (%x is float) is object stringlist
function part (%number is float) is object emailPart
function parts is float
end public

***********************************************************************
* *
* Return a header from the email message *
* *
***********************************************************************
function header -
(%name is string len 255, %occur is float default(1)) -
is string len 255

%i is float
%toke is object stringTokenizer
%token is string len 255

for %i from 1 to %this:headers:count
%toke = %this:headers(%i):stringTokenizer
%token = %toke:nextToken:toUpper
%toke:discard
if %name:toUpper eq %token then loop end; end if
end for

if %i > %this:headers:count then return ''; end if

%token = %this:headers(%i)
if %this:headers(%i):right(1) ne ';' then return %token; end if

for %i from %i + 1 to %this:headers:count
%token = %token %this:headers(%i)
if %this:headers(%i):right(1) ne ';' then loop end; end if
end for

return %token

end function

***********************************************************************
* *
* Return a "part" of an email message as an emailPart object. *
* *
***********************************************************************
function part (%number is float) is object emailPart

%i is float
%n is float
%bound is string len 72
%part is object emailPart
%encoding is string len 255
%partNumber is float
%cont is boolean initial(false)
%mime is boolean initial(false)
%temp is string len 255

%part = new
%part:headers = new

* Scan global headers for boundary
for %i from 1 to %this:headers:count
%temp = %this:headers(%i)
if 'Content-Type:':toUpper eq %temp:word(1):toUpper then
for %i from %i + 1 to %this:headers:count
if %this:headers(%i):word(1):right(1) eq ':' then loop end; end if
%temp = %temp %this:headers(%i)
end for
%n = %temp:positionOf('boundary=')
if %n gt 0 then
%bound = %temp:subString(%n)
end if
loop end;
end if
end for

%part:headers = new
%part:body = new

if %bound ne '' then
%bound = %bound:substring(10)
if %bound:left(1) = '"' then %bound = %bound:trimLeft(1); end if
if %bound:right(1) = '"' then %bound = %bound:trimRight(1); end if
%bound = '--' %bound;
for %i from 1 to %this:body:count
if %bound = %this:body(%i) then
%partNumber = %partNumber + 1
if %partNumber = %number then loop end; end if
end if
end for
for %i from %i + 1 to %this:body:count
if %this:body(%i) eq '' then loop end; end if
%part:headers:add(%this:body(%i))
end for
for %i from %i + 1 to %this:body:count
if %bound = %this:body(%i):substring(1, %bound:length) then
loop end;
end if
%part:body:add(%this:body(%i))
end for
else
assert %number eq 1
for %i from 1 to %this:headers:count
%temp = %this:headers(%i)
if 'Content-':toUpper eq %temp:word(1):left(8):toUpper then
%part:headers:add(%temp)
for %i from %i + 1 to %this:headers:count
if %this:headers(%i):word(1):right(1) eq ':' then loop end; end if
%part:headers:add(%this:headers(%i))
end for
%i = %i - 1
end if
end for
for %i from 1 to %this:body:count
%part:body:add(%this:body(%i))
end for
end if

return %part

end function

***********************************************************************
* *
* Return number of "parts" of an email message. *
* *
***********************************************************************
function parts is float

%i is float
%n is float
%bound is string len 128
%parts is float
%temp is longstring

* Scan global headers for boundary
for %i from 1 to %this:headers:count
%temp = %this:headers(%i)
if 'Content-Type:':toUpper eq %temp:word(1):toUpper then
for %i from %i + 1 to %this:headers:count
if %this:headers(%i):word(1):right(1) eq ':' then loop end; end if
%temp = %temp %this:headers(%i)
end for
%n = %temp:positionOf('boundary=')
if %n gt 0 then
%bound = %temp:subString(%n)
end if
loop end;
end if
end for

if %bound ne '' then
%bound = %bound:substring(10)
if %bound:left(1) = '"' then %bound = %bound:trimLeft(1); end if
if %bound:right(1) = '"' then %bound = %bound:trimRight(1); end if
%bound = '--' %bound;
else
return 1
end if

%parts = 0
for %i from 1 to %this:body:count
if %bound = %this:body(%i) then
%parts = %parts + 1
end if
end for

return %parts

end function

end class
***********************************************************************
* *
* smtpDriver class. *
* *
***********************************************************************
class smtpDriver
public shared
subroutine -
run(%processEmail is subroutine (receivedEmail):whatever)
end public shared

subroutine run(%processEmail is subroutine (receivedEmail):whatever)

%receivedEmail is object receivedEmail

*****************************************************************
* SMTP server program. *
*****************************************************************

*****************************************************************
* Static values used by the server. *
*****************************************************************

%serverId is string len 80 initial -
("host.sirius-software.com running Model 204 SMTP server")

*****************************************************************
* End of static values used by the server. *
*****************************************************************

local subroutine (stringList):audit
%i is float
for %i from 1 to %this:count
auditText {%i}: {%this(%i)}
end for
end subroutine

%remail is object receivedEmail

%msg is string len 128
%client is string len 128
%command is string len 16
%email is object receivedEmail
%esmtp is boolean initial(false)
%from is string len 128
%by is string len 128
%received is string len 255
%dateTime is string len 128
%inputLength is float
%inputLine is longstring
%sock is object socket
%toke is object stringTokenizer
%token is string len 128

%sock = serverSocket

%sock:set('CHAR', 'CHAR')
%sock:set('LINEND', '0D0A')
%sock:set('PRSTOK', '0D0A')

%dateTime = -
%(system):currentTimeString('DD Mon YYYY HH:MI:SS')
%sock:sendWithLineEnd( -
"220 " with %serverId with " on " with %dateTime)

%inputLength = %sock:receiveAndParse(%inputLine)

%toke = %inputLine:stringTokenizer

%command = %toke:nextToken:toUpper
if %command eq 'EHLO' then
%esmtp = true
elseIf %command ne 'HELO' then
auditText *** Incorrect hello message received, -
command={%command}, closing connection
%sock:close
stop
end if

%client = %toke:nextToken
%msg = "250 Hello " with %client with -
" I'm delighted to meet you"
%sock:sendWithLineEnd(%msg)

auditText **** Entering main SMTP loop for {%client}
repeat forever
%inputLength = %sock:receiveAndParse(%inputLine)
%toke = %inputLine:stringTokenizer
%command = %toke:nextToken:toUpper
if %command eq 'QUIT' then jump to quit; end if
if %command ne 'MAIL' then
auditText **** Unexpected command {%command} received, -
terminating connection
jump to close
end if
%token = %toke:nextToken
if %token:left(5):toUpper ne 'FROM:' then
auditText **** MAIL followed by {%token} not -
FROM:<email-address>, terminating connection
jump to close
end if
%from = %token:substring(6)
%sock:sendWithLineEnd("250 Ok")

%email = new
%email:rcptList = new

%toke = %sock:info('REMOTE'):stringTokenizer
%email:fromHost = %toke:nextToken

repeat forever
%inputLength = %sock:receiveAndParse(%inputLine)
%toke = %inputLine:stringTokenizer
%command = %toke:nextToken:toUpper
if %command eq 'QUIT' then jump to quit; end if
if %command ne 'RCPT' then loop end; end if
%token = %toke:nextToken
if %token:left(3):toUpper ne 'TO:' then
auditText **** RCPT followed by {%token} not -
TO:<email-address>, terminating connection
jump to close
end if
%email:rcptList:add(%token:substring(4))
%sock:sendWithLineEnd("250 Ok")
end repeat

if %email:rcptList:count eq 0 then
auditText **** No RCPT TO:s received after a -
MAIL FROM:, terminating connection
jump to close
end if

if %command ne 'DATA' then
auditText **** No DATA received after a RCPT TO:, -
terminating connection
jump to close
end if
%sock:sendWithLineEnd("354 End data with a single '.'")

%email:headers = new
setText %received = Received: from {%email:fromHost} by -
{%serverid} ; -
{%(system):currentTimeString('Wkd, DD Mon YYYY HH:MI:SS')}
%email:headers:add(%received)

repeat forever
%inputLength = %sock:receiveAndParse(%inputLine)
if %inputLine = '' then loop end; end if
if %inputLine eq '.' then loop end; end if
if %inputLine:left(2) eq '..' then
%inputLine = %inputLine:substring(2);
end if
%email:headers:add(%inputLine)
end repeat

%email:body = new
repeat forever
%inputLength = %sock:receiveAndParse(%inputLine)
if %inputLine eq '.' then loop end; end if
if %inputLine:left(2) eq '..' then
%inputLine = %inputLine:substring(2);
end if
%email:body:add(%inputLine)
end repeat

%sock:sendWithLineEnd("250 E-mail received")
end repeat

quit:

auditText **** QUIT received
%sock:sendWithLineEnd("221 Bye")

close:

auditText **** Terminating SMTP connection
%sock:close

%email:%processEmail

end subroutine

end class
</pre>
<u>driver.ul</b>:
<pre>
UTABLE LNTBL 128
b

i emclass.ul

local subroutine (receivedEmail):process

%i is float
%j is float
%x is float
%ls is longstring
%op is string len 8
%temp is string len 255
%ename is string len 255
%part is object emailPart
%tp is float

%tp = 0
setText %ename = CSURF_EMAIL_{$sir_date('YYMMDDHHMISS')}
%x = $bldproc(%tp, %ename, 'OPEN')
assert %x eq 0
*
* Get attachments and copy content to output procedure
*
%op = 'APPEND'
for %i from 1 to %this:parts
%part = %this:part(%i)
for %j from 1 to %part:headers:count
%temp = %part:headers(%j):left(255)
%x = $bldproc(%tp, %temp, %op)
assert %x eq 0
end for
for %j from 1 to %part:body:count
%temp = %part:body(%j):left(255)
%x = $bldproc(%tp, %temp, %op)
assert %x eq 0
end for
end for

end subroutine

%(smtpDriver):run(process)

end
USE Fred
DISPLAY PROCEDURE 0
</pre>

==SMTP examples==
Examples follow in which <var>Email</var> objects are used to create and send a request to an SMTP server.
No <var class="product">Janus</var> port definitions are shown.
For comments about defining <var class="product">Janus</var> ports for the <var>Email</var> class, see
the [[#jport|earlier]] remarks.

===Basic e-mail example===
This example uses most of the <var>Email</var> methods to send a simple message to three recipients.
The local <var>CLSOCK</var> port used is named <code>SPAM</code>.
<p class="code">b

%letter object Email
%h longstring
%t longstring
%name longstring
%nick string len 64

%letter = new

%name = 'C_Coolidge@presidents.usa'
%nick = 'SilentCal'
%letter:AddRecipient(%name, %nick)

%name = 'D_Eisenhower@presidents.usa'
%nick = 'Ike'
%letter:AddCc(%name, %nick)

%name = L_Johnson@presidents.usa'
%nick = 'LBJ'
%letter:AddBcc(%name, %nick)

%letter:Sender('a_huckster@bankandtrustme.com')

%h = 'Subject:'
%t = 'Lower Mortgage Rates'
%letter:AddHeader(%h, %t)

%h = 'Great deal of debt for you!'
%letter:SetBody(%h)

%letter:mail('SPAM', 0)

print %letter:GetReplyCode with ' - ' with -
%letter:GetReplyText

%letter:discard
end
</p>

===E-mail with attachment===
In the following example, an image is attached to a short e-mail message.
The attachment is produced from a member of a local <var class="product">Model 204</var> procedure file
using <var>Stringlist</var> class methods.

<p class="code">b
%rolex is object Email
%sl is object Stringlist
%procdata is object Stringlist
%jpg longstring
%t longstring
%temp string len 255
%procfile string len 10
%procname string len 63
%q float
%rc float

%rolex = new
%sl = new

%t = 'jbgood@netscape.net'
%rolex:AddRecipient(%t, 'JB')

%t = 'cberry@ucantbee-sirius.com'
%rolex:Sender(%t)
%rolex:AddHeader('Subject:', 'watch this...')

text to %sl
I want an authentic imitation Rolex watch. Something like
the one shown in this image. Know anyone who's got one?
end text
%rolex:SetBody(%sl, encoding='none', type='text/plain')

%procfile = 'MYPROC'
%procname = 'FAKE5.JPG'
%rc = $procopn(%procname, %procfile)
if %rc ne 0 then
print 'Can''t open procedure ' with %procname -
with ' in file ' with %procfile with ', rc = ' -
with %rc
stop
end if

%procdata = new
%procdata:appendOpenProcedure
%jpg = %procData:binaryProcedureDecode
%rolex:AddPart(%jpg, type='image/jpg', name='Rolex1.jpg')

print %rolex:mail('MYSMTP', 0) ' is return from Mail method'
print %rolex:GetReplyCode ' is return from GetReplyCode'
print %rolex:GetReplyText

%rolex:discard
end
</p>

If the request is successful, results like the following display at the terminal:

<p class="code">0 is return from Mail method
221 is return from GetReplyCode
ucantbee-sirius.com running IBM VM SMTP Level 320
closing connection
</p>

==List of Email methods==
The [[List of Email methods|"List of Email methods"]] shows all the class methods.

==See also==
<ul>
<li>[[Janus Sockets User Language coding considerations]]
<li>[[Sample Janus Sockets programs]]
<li>Socket-level interfaces:
<ul>
<li>[[Janus Sockets $functions|$functions]]
<li>[[Socket class]]
</ul>
<li>Higher-level interfaces:
<ul>
<li>[[Email class]]
<li>[[HTTP Helper|HTTP Helper classes]]
<li>[[LDAP class]]
<li>[[Janus FTP Server]]
<li>[[Janus Telnet Server]]
</ul>

[[Category: Janus Sockets]]
[[Category:System classes]]

Email class

2014-03-20T18:01:37Z

SNelson:

The <var>Email</var> class is a high level,
object oriented interface to client sockets that lets you write a <var class="product">SOUL</var> SMTP
(Simple Mail Transfer Protocol) request without knowledge of socket level programming
or the format of SMTP requests and responses.

The <var>Email</var> class methods let a <var class="product">SOUL</var> program act as an SMTP client.
SMTP clients send mail requests
to an SMTP server, not directly to other SMTP clients.
The <var>Email</var> class methods only support communication with SMTP servers.

An SMTP server will "store and forward" mail it receives.
This means that all
messages are first received in entirety on the SMTP server,
then the server attempts to deliver it to the recipients.
Mail delivery can be delayed by a server that is down or too busy to
accept connections.
"Store and forward" gives the SMTP server the ability
to retry delivery without making the SMTP client wait for completion.

A server might try to deliver a message for as long as a week or more.
This, of course, makes it impractical for a client to wait for delivery
confirmation, so the SMTP protocol does not provide such information.
A "success" response from an SMTP server indicates
only that the server has accepted the request and will
attempt to deliver the mail to the recipients.

Most SMTP servers will at least confirm that
any domain names in the recipient list are valid, but they cannot confirm that an
actual recipient name is valid.

<div id="jport"></div>
You must define a Janus <var>[[JANUS CLSOCK|CLSOCK]]</var> port to use the <var>Email</var> class.
If you supply the IP address
of the server and the port number in the port definition, SMTP
applications need only know the Janus port name to communicate with the server.
The following example defines a client socket port for use by SMTP applications.
For more detailed information about defining
<var class="product">Janus</var> client socket ports, see <var>[[JANUS DEFINE]]</var> and <var>[[JANUS CLSOCK]]</var>.

<p class="code">JANUS DEFINE MYSMTP * CLSOCK 5 REMOTE 198.242.244.100 25
</p>

<p class="note">'''Note:'''
To use <var>Email</var> objects under versions of Model 204 earlier than 7.5, you must have licensed <var class="product">[[Janus TCP/IP Base]]</var>, <var class="product">[[Janus Sockets]]</var>, '''and''' <var class="product">[[Janus SOAP]]</var>. Under version 7.5 and later,
you do not require <var class="product">Janus SOAP</var>. </p>

For information about using SOUL objects, see [[Object oriented programming in SOUL]] and
[[Getting started with OOP for User Language programmers]].

==Email class summary==
The following capabilities are provided by the <var>Email</var> class:
<ul>
<li>Creating general purpose e-mail for SMTP
<li>Sending general purpose e-mail via SMTP
<li>Setting e-mail content using <var>[[Longstrings]]</var>
<li>Sending MIME content (attachments and alternative content)
<li>Sending to multiple recipients
<li>Access to status (error or confirmation messages)
</ul>

You use the <var>Email</var> object to generate SMTP messages
(e-mail) to send to an SMTP server.
To construct a request, you use <var>Email</var> methods to set and inspect
header information, content, and attachments.
To send e-mail, you use the <var>[[Mail (Email function)|Mail]]</var> method.

[[List of Email methods]] contains a list of all the methods in the <var>Email</var> class.

==Dummy SMTP Server example==
This is an example of very basic SMTP Service which simple excepts <var>Email</var> objects from a SMTP client and response back to the client.
No <var class="product">Janus</var> port definitions are shown.
For comments about defining <var class="product">Janus</var> ports for the <var>Email</var> class, see
the [[#jport|earlier]] remarks.

===Dummy SMTP Server example===

<b>emclass</b>:

***********************************************************************
* *
* encoding enumerations. *
* *
***********************************************************************
enumeration encoding
public
value base64
value none
end public
end enumeration

***********************************************************************
* *
* emailPart class. *
* *
***********************************************************************
class emailPart

public
variable headers is object stringlist
variable body is object stringlist
function type is string len 255
function encoding is string len 255
function name is string len 255
function contentlist is object stringlist
function content is longstring
end public

***********************************************************************
* *
* Return complete contentlist from an emailPart *
* *
***********************************************************************
function contentlist is object stringlist

return %this:body

end function

***********************************************************************
* *
* Decode and return content from an emailPart *
* *
***********************************************************************
function content is longstring

%toke is object stringTokenizer
%token is string len 128
%encoding is string len 128
%lf is string len 1
%i is float
%j is float
%content is longstring
%concat is boolean initial(True)
%temp is longstring

if %this:body eq null then return ''; end if

%lf = '0A':x

for %i from %i + 1 to %this:body:count
if %this:encoding eq 'base64' then
%content = %content with %this:body(%i)
elseif %this:encoding eq 'quoted-printable' then
%temp = %this:body(%i):Unspace(Leading=False, Trailing=True, -
Compress=False)
if %concat = False then
%content = %content %lf
end if
for %j from 1 to %temp:Length - 2
if %temp:Substring(%j, 1) = '=' then
%content = %content %temp:Substring(%j + 1, 2): -
HexToString:AsciiToEbcdic(characterEncode=true)
%j = %j + 2
else
%content = %content %temp:Substring(%j, 1)
end if
end for
if %j <= %temp:Length then
for %j from %j to %temp:Length
%content = %content %temp:Substring(%j, 1)
end for
end if
if %content:Right(1) = '=' then
%concat = True
%content = %content:TrimRight(1)
else
%concat = False
end if
else
%content = %content %this:body(%i) with %lf
end if
end for

if %this:encoding eq 'base64' then
%content = %content:base64ToString
if %this:type:left(5) = 'text/' then
%content = %content:AsciiToEbcdic(CharacterEncode=true)
end if
end if

return %content

end function
***********************************************************************
* *
* Return the name (if present) of an emailPart *
* *
***********************************************************************
function name is string len 255

%type is string len 255
%name is string len 255
%temp is string len 255
%i is float
%n is float

for %i from 1 to %this:headers:count
%temp = %this:headers(%i)
if 'Content-Disposition:':toUpper eq %temp:word(1):toUpper then
for %i from %i + 1 to %this:headers:count
if %temp:word(1):right(1) eq ':' then loop end; end if
%temp = %temp %this:headers(%i)
end for
%i = %i - 1
%n = %temp:positionOf(' filename=')
if %n gt 0 then
%name = %temp:subString(%n)
end if
loop end;
end if
if 'Content-Type:':toUpper eq %temp:word(1):toUpper then
for %i from %i + 1 to %this:headers:count
if %temp:word(1):right(1) eq ':' then loop end; end if
%temp = %temp %this:headers(%i)
end for
%i = %i - 1
%n = %temp:positionOf(' name=')
if %n gt 0 then
%name = %temp:subString(%n)
end if
end if
end for

%name = %name:word(2, spaces=' =')
if %name:left(1) = '"' then %name = %name:trimLeft(1); end if
if %name:right(1) = '"' then %name = %name:trimRight(1); end if

return %name

end function

***********************************************************************
* *
* Return the encoding (if present) of an emailPart *
* *
***********************************************************************
function encoding is string len 255

%enc is string len 255
%temp is string len 255
%i is float
%n is float

for %i from 1 to %this:headers:count
%temp = %this:headers(%i)
if 'Content-Transfer-Encoding:':toUpper eq %temp:word(1):toUpper then
for %i from %i + 1 to %this:headers:count
if %this:headers(%i):word(1):right(1) eq ':' then loop end; end if
%temp = %temp %this:headers(%i)
end for
loop end;
end if
end for

if 'Content-Transfer-Encoding:':toUpper eq %temp:word(1):toUpper then
%enc = %temp:word(2)
if %enc:left(1) = '"' then %enc = %enc:trimLeft(1); end if
if %enc:right(1) = '"' then %enc = %enc:trimRight(1); end if
end if

if %enc = '' then %enc = '7bit'; end if

return %enc

end function

***********************************************************************
* *
* Return the content type of an emailPart *
* *
***********************************************************************
function type is string len 255

%type is string len 255
%temp is string len 255
%i is float
%n is float

for %i from 1 to %this:headers:count
%temp = %this:headers(%i)
if 'Content-Type:':toUpper eq %temp:word(1):toUpper then
for %i from %i + 1 to %this:headers:count
if %temp:word(1):right(1) eq ':' then loop end; end if
%temp = %temp %this:headers(%i)
end for
%i = %i - 1
loop end;
end if
end for

%type = %temp:word(2)
if %type:left(1) = '"' then %type = %type:trimLeft(1); end if
if %type:right(1) = '"' then %type = %type:trimRight(1); end if

if %type = '' then %type = 'text/plain'; end if

return %type

end function

end class

***********************************************************************
* *
* receivedEmail class. *
* *
***********************************************************************
class receivedEmail

public
variable headers is object stringlist
variable body is object stringlist
variable rcptList is object stringlist
variable fromHost is string len 128
variable from is string len 128

function header -
(%name is string len 255, %occur is float default(1)) -
is string len 255
function contentList (%x is float) is object stringlist
function part (%number is float) is object emailPart
function parts is float
end public

***********************************************************************
* *
* Return a header from the email message *
* *
***********************************************************************
function header -
(%name is string len 255, %occur is float default(1)) -
is string len 255

%i is float
%toke is object stringTokenizer
%token is string len 255

for %i from 1 to %this:headers:count
%toke = %this:headers(%i):stringTokenizer
%token = %toke:nextToken:toUpper
%toke:discard
if %name:toUpper eq %token then loop end; end if
end for

if %i > %this:headers:count then return ''; end if

%token = %this:headers(%i)
if %this:headers(%i):right(1) ne ';' then return %token; end if

for %i from %i + 1 to %this:headers:count
%token = %token %this:headers(%i)
if %this:headers(%i):right(1) ne ';' then loop end; end if
end for

return %token

end function

***********************************************************************
* *
* Return a "part" of an email message as an emailPart object. *
* *
***********************************************************************
function part (%number is float) is object emailPart

%i is float
%n is float
%bound is string len 72
%part is object emailPart
%encoding is string len 255
%partNumber is float
%cont is boolean initial(false)
%mime is boolean initial(false)
%temp is string len 255

%part = new
%part:headers = new

* Scan global headers for boundary
for %i from 1 to %this:headers:count
%temp = %this:headers(%i)
if 'Content-Type:':toUpper eq %temp:word(1):toUpper then
for %i from %i + 1 to %this:headers:count
if %this:headers(%i):word(1):right(1) eq ':' then loop end; end if
%temp = %temp %this:headers(%i)
end for
%n = %temp:positionOf('boundary=')
if %n gt 0 then
%bound = %temp:subString(%n)
end if
loop end;
end if
end for

%part:headers = new
%part:body = new

if %bound ne '' then
%bound = %bound:substring(10)
if %bound:left(1) = '"' then %bound = %bound:trimLeft(1); end if
if %bound:right(1) = '"' then %bound = %bound:trimRight(1); end if
%bound = '--' %bound;
for %i from 1 to %this:body:count
if %bound = %this:body(%i) then
%partNumber = %partNumber + 1
if %partNumber = %number then loop end; end if
end if
end for
for %i from %i + 1 to %this:body:count
if %this:body(%i) eq '' then loop end; end if
%part:headers:add(%this:body(%i))
end for
for %i from %i + 1 to %this:body:count
if %bound = %this:body(%i):substring(1, %bound:length) then
loop end;
end if
%part:body:add(%this:body(%i))
end for
else
assert %number eq 1
for %i from 1 to %this:headers:count
%temp = %this:headers(%i)
if 'Content-':toUpper eq %temp:word(1):left(8):toUpper then
%part:headers:add(%temp)
for %i from %i + 1 to %this:headers:count
if %this:headers(%i):word(1):right(1) eq ':' then loop end; end if
%part:headers:add(%this:headers(%i))
end for
%i = %i - 1
end if
end for
for %i from 1 to %this:body:count
%part:body:add(%this:body(%i))
end for
end if

return %part

end function

***********************************************************************
* *
* Return number of "parts" of an email message. *
* *
***********************************************************************
function parts is float

%i is float
%n is float
%bound is string len 128
%parts is float
%temp is longstring

* Scan global headers for boundary
for %i from 1 to %this:headers:count
%temp = %this:headers(%i)
if 'Content-Type:':toUpper eq %temp:word(1):toUpper then
for %i from %i + 1 to %this:headers:count
if %this:headers(%i):word(1):right(1) eq ':' then loop end; end if
%temp = %temp %this:headers(%i)
end for
%n = %temp:positionOf('boundary=')
if %n gt 0 then
%bound = %temp:subString(%n)
end if
loop end;
end if
end for

if %bound ne '' then
%bound = %bound:substring(10)
if %bound:left(1) = '"' then %bound = %bound:trimLeft(1); end if
if %bound:right(1) = '"' then %bound = %bound:trimRight(1); end if
%bound = '--' %bound;
else
return 1
end if

%parts = 0
for %i from 1 to %this:body:count
if %bound = %this:body(%i) then
%parts = %parts + 1
end if
end for

return %parts

end function

end class
***********************************************************************
* *
* smtpDriver class. *
* *
***********************************************************************
class smtpDriver
public shared
subroutine -
run(%processEmail is subroutine (receivedEmail):whatever)
end public shared

subroutine run(%processEmail is subroutine (receivedEmail):whatever)

%receivedEmail is object receivedEmail

*****************************************************************
* SMTP server program. *
*****************************************************************

*****************************************************************
* Static values used by the server. *
*****************************************************************

%serverId is string len 80 initial -
("host.sirius-software.com running Model 204 SMTP server")

*****************************************************************
* End of static values used by the server. *
*****************************************************************

local subroutine (stringList):audit
%i is float
for %i from 1 to %this:count
auditText {%i}: {%this(%i)}
end for
end subroutine

%remail is object receivedEmail

%msg is string len 128
%client is string len 128
%command is string len 16
%email is object receivedEmail
%esmtp is boolean initial(false)
%from is string len 128
%by is string len 128
%received is string len 255
%dateTime is string len 128
%inputLength is float
%inputLine is longstring
%sock is object socket
%toke is object stringTokenizer
%token is string len 128

%sock = serverSocket

%sock:set('CHAR', 'CHAR')
%sock:set('LINEND', '0D0A')
%sock:set('PRSTOK', '0D0A')

%dateTime = -
%(system):currentTimeString('DD Mon YYYY HH:MI:SS')
%sock:sendWithLineEnd( -
"220 " with %serverId with " on " with %dateTime)

%inputLength = %sock:receiveAndParse(%inputLine)

%toke = %inputLine:stringTokenizer

%command = %toke:nextToken:toUpper
if %command eq 'EHLO' then
%esmtp = true
elseIf %command ne 'HELO' then
auditText *** Incorrect hello message received, -
command={%command}, closing connection
%sock:close
stop
end if

%client = %toke:nextToken
%msg = "250 Hello " with %client with -
" I'm delighted to meet you"
%sock:sendWithLineEnd(%msg)

auditText **** Entering main SMTP loop for {%client}
repeat forever
%inputLength = %sock:receiveAndParse(%inputLine)
%toke = %inputLine:stringTokenizer
%command = %toke:nextToken:toUpper
if %command eq 'QUIT' then jump to quit; end if
if %command ne 'MAIL' then
auditText **** Unexpected command {%command} received, -
terminating connection
jump to close
end if
%token = %toke:nextToken
if %token:left(5):toUpper ne 'FROM:' then
auditText **** MAIL followed by {%token} not -
FROM:<email-address>, terminating connection
jump to close
end if
%from = %token:substring(6)
%sock:sendWithLineEnd("250 Ok")

%email = new
%email:rcptList = new

%toke = %sock:info('REMOTE'):stringTokenizer
%email:fromHost = %toke:nextToken

repeat forever
%inputLength = %sock:receiveAndParse(%inputLine)
%toke = %inputLine:stringTokenizer
%command = %toke:nextToken:toUpper
if %command eq 'QUIT' then jump to quit; end if
if %command ne 'RCPT' then loop end; end if
%token = %toke:nextToken
if %token:left(3):toUpper ne 'TO:' then
auditText **** RCPT followed by {%token} not -
TO:<email-address>, terminating connection
jump to close
end if
%email:rcptList:add(%token:substring(4))
%sock:sendWithLineEnd("250 Ok")
end repeat

if %email:rcptList:count eq 0 then
auditText **** No RCPT TO:s received after a -
MAIL FROM:, terminating connection
jump to close
end if

if %command ne 'DATA' then
auditText **** No DATA received after a RCPT TO:, -
terminating connection
jump to close
end if
%sock:sendWithLineEnd("354 End data with a single '.'")

%email:headers = new
setText %received = Received: from {%email:fromHost} by -
{%serverid} ; -
{%(system):currentTimeString('Wkd, DD Mon YYYY HH:MI:SS')}
%email:headers:add(%received)

repeat forever
%inputLength = %sock:receiveAndParse(%inputLine)
if %inputLine = '' then loop end; end if
if %inputLine eq '.' then loop end; end if
if %inputLine:left(2) eq '..' then
%inputLine = %inputLine:substring(2);
end if
%email:headers:add(%inputLine)
end repeat

%email:body = new
repeat forever
%inputLength = %sock:receiveAndParse(%inputLine)
if %inputLine eq '.' then loop end; end if
if %inputLine:left(2) eq '..' then
%inputLine = %inputLine:substring(2);
end if
%email:body:add(%inputLine)
end repeat

%sock:sendWithLineEnd("250 E-mail received")
end repeat

quit:

auditText **** QUIT received
%sock:sendWithLineEnd("221 Bye")

close:

auditText **** Terminating SMTP connection
%sock:close

%email:%processEmail

end subroutine

end class

<u>driver.ul</b>:

UTABLE LNTBL 128
b

i emclass.ul

local subroutine (receivedEmail):process

%i is float
%j is float
%x is float
%ls is longstring
%op is string len 8
%temp is string len 255
%ename is string len 255
%part is object emailPart
%tp is float

%tp = 0
setText %ename = CSURF_EMAIL_{$sir_date('YYMMDDHHMISS')}
%x = $bldproc(%tp, %ename, 'OPEN')
assert %x eq 0
*
* Get attachments and copy content to output procedure
*
%op = 'APPEND'
for %i from 1 to %this:parts
%part = %this:part(%i)
for %j from 1 to %part:headers:count
%temp = %part:headers(%j):left(255)
%x = $bldproc(%tp, %temp, %op)
assert %x eq 0
end for
for %j from 1 to %part:body:count
%temp = %part:body(%j):left(255)
%x = $bldproc(%tp, %temp, %op)
assert %x eq 0
end for
end for

end subroutine

%(smtpDriver):run(process)

end
USE Fred
DISPLAY PROCEDURE 0

==SMTP examples==
Examples follow in which <var>Email</var> objects are used to create and send a request to an SMTP server.
No <var class="product">Janus</var> port definitions are shown.
For comments about defining <var class="product">Janus</var> ports for the <var>Email</var> class, see
the [[#jport|earlier]] remarks.

===Basic e-mail example===
This example uses most of the <var>Email</var> methods to send a simple message to three recipients.
The local <var>CLSOCK</var> port used is named <code>SPAM</code>.
<p class="code">b

%letter object Email
%h longstring
%t longstring
%name longstring
%nick string len 64

%letter = new

%name = 'C_Coolidge@presidents.usa'
%nick = 'SilentCal'
%letter:AddRecipient(%name, %nick)

%name = 'D_Eisenhower@presidents.usa'
%nick = 'Ike'
%letter:AddCc(%name, %nick)

%name = L_Johnson@presidents.usa'
%nick = 'LBJ'
%letter:AddBcc(%name, %nick)

%letter:Sender('a_huckster@bankandtrustme.com')

%h = 'Subject:'
%t = 'Lower Mortgage Rates'
%letter:AddHeader(%h, %t)

%h = 'Great deal of debt for you!'
%letter:SetBody(%h)

%letter:mail('SPAM', 0)

print %letter:GetReplyCode with ' - ' with -
%letter:GetReplyText

%letter:discard
end
</p>

===E-mail with attachment===
In the following example, an image is attached to a short e-mail message.
The attachment is produced from a member of a local <var class="product">Model 204</var> procedure file
using <var>Stringlist</var> class methods.

<p class="code">b
%rolex is object Email
%sl is object Stringlist
%procdata is object Stringlist
%jpg longstring
%t longstring
%temp string len 255
%procfile string len 10
%procname string len 63
%q float
%rc float

%rolex = new
%sl = new

%t = 'jbgood@netscape.net'
%rolex:AddRecipient(%t, 'JB')

%t = 'cberry@ucantbee-sirius.com'
%rolex:Sender(%t)
%rolex:AddHeader('Subject:', 'watch this...')

text to %sl
I want an authentic imitation Rolex watch. Something like
the one shown in this image. Know anyone who's got one?
end text
%rolex:SetBody(%sl, encoding='none', type='text/plain')

%procfile = 'MYPROC'
%procname = 'FAKE5.JPG'
%rc = $procopn(%procname, %procfile)
if %rc ne 0 then
print 'Can''t open procedure ' with %procname -
with ' in file ' with %procfile with ', rc = ' -
with %rc
stop
end if

%procdata = new
%procdata:appendOpenProcedure
%jpg = %procData:binaryProcedureDecode
%rolex:AddPart(%jpg, type='image/jpg', name='Rolex1.jpg')

print %rolex:mail('MYSMTP', 0) ' is return from Mail method'
print %rolex:GetReplyCode ' is return from GetReplyCode'
print %rolex:GetReplyText

%rolex:discard
end
</p>

If the request is successful, results like the following display at the terminal:

<p class="code">0 is return from Mail method
221 is return from GetReplyCode
ucantbee-sirius.com running IBM VM SMTP Level 320
closing connection
</p>

==List of Email methods==
The [[List of Email methods|"List of Email methods"]] shows all the class methods.

==See also==
<ul>
<li>[[Janus Sockets User Language coding considerations]]
<li>[[Sample Janus Sockets programs]]
<li>Socket-level interfaces:
<ul>
<li>[[Janus Sockets $functions|$functions]]
<li>[[Socket class]]
</ul>
<li>Higher-level interfaces:
<ul>
<li>[[Email class]]
<li>[[HTTP Helper|HTTP Helper classes]]
<li>[[LDAP class]]
<li>[[Janus FTP Server]]
<li>[[Janus Telnet Server]]
</ul>

[[Category: Janus Sockets]]
[[Category:System classes]]

Sirius Software product list

2014-03-11T15:32:32Z

SNelson:

Rocket Software, formerly '''[[Sirius Software]]''', provides a wide variety of products to enhance and extend the <var class="product">[[Model 204]]</var> DBMS. Those products, shown in the table below, are now available through Rocket Software.

<table border="1" cellspacing="0" cellpadding="3" width="35%">
<tr class="head">
<th align="center" bgcolor="#ffffd3">
Software product list
</th>
</tr>
<tr>
<td align="left" valign="top">

Fast products:
<ul class="nobul">
<li>[http://m204wiki.rocketsoftware.com/images/1/12/FastbackNew.pdf Fast/Backup]</li>
<li>[http://m204wiki.rocketsoftware.com/images/9/95/FrelrNew.pdf Fast/Reload]</li>
<li>[[Fast/Unload User Language Interface]]</li>
<li>[http://m204wiki.rocketsoftware.com/images/0/0b/CramrNew.pdf Fast/Cram]</li>
<li>[[Fast/Unload]] 
</ul>
<hr width="85%">
<div id="janus"></div>
Janus middleware products:
<ul class="nobul">
<li>[http://m204wiki.rocketsoftware.com/images/d/de/JansslrNew.pdf Janus Network Security]</li>
<li>[http://m204wiki.rocketsoftware.com/images/1/17/JosrvrNew.pdf Janus Open Server]</li>
<li>[http://m204wiki.rocketsoftware.com/images/4/4a/JoclrNew.pdf Janus Open Client]</li>
<li>[[Janus SOAP]]</li>
<li>[[Janus Sockets]]</li>
<li>[http://m204wiki.rocketsoftware.com/images/e/e4/JsdsrNew.pdf Janus Specialty Data Store]</li>
<li>[[Janus TCP/IP Base]]</li>
<li>[[Janus Web Server]]</li>
</ul>
<hr width="85%">

[[ULSPF | UL/SPF]]:
<ul class="nobul">
<li>[[SirDBA]]</li>
<li>[[SirFile]]</li>
<li>[[SirLib]]</li>
<li>[[SirMon]]</li>
<li>[[SirPro]]</li>
<li>[[SirScan]]</li>
</ul>
<hr width="85%">
[[Debugger | The Janus and Sirius Debuggers]]
<hr width="85%">
[[Japanese Functions]]
<hr width="85%">
Other products:
<ul class="nobul">
<li>[http://m204wiki.rocketsoftware.com/images/f/fb/FactrNew.pdf SirFact] </li>
<li>[http://m204wiki.rocketsoftware.com/images/4/4d/SafrNew.pdf SirSafe] </li>
<li>[[SirTune]] </li>
<li>[http://m204wiki.rocketsoftware.com/images/4/4b/SirfieldNew.pdf Sir2000 Field Migration Facility] </li>
<li>[http://m204wiki.rocketsoftware.com/images/d/d6/Ul2krNew.pdf Sir2000 User Language Tools] </li>
<li>[http://m204wiki.rocketsoftware.com/images/f/fc/AudrNew.pdf SirAud]</li>
<li>[http://m204wiki.rocketsoftware.com/images/d/d4/SirzaprNew.pdf SirZap]</li>
</ul> </td>
</tr>
</table>

You can determine which products your site is authorized for by issuing the <var>[[SIRIUS command|SIRIUS]]</var> command in an Online running a load module that includes the <var class="product">Sirius Mods</var>.

===See also===

[http://www.rocketsoftware.com/products?brand=156&category=616 The Rocket M204 products web page]

What's new

2014-03-11T15:29:30Z

SNelson:

__NOTOC__
This page contains recent and forthcoming additions of note to Model 204 documentation.

<div class="mw-collapsible mw-collapsed" data-expandtext="▼" data-collapsetext="▲">
==Model 204 Version 7.5==
<div class="mw-collapsible-content">

Version 7.5, the next release of Model 204, follows the recent acquisition of Sirius Software product line and integrates the Sirius and Janus software products into the Model 204 nucleus. One of the more exciting results of the integration is Simple Objective User Language, or SOUL. SOUL adds object-oriented programming to, and replaces the name of, User Language. It comes with no additional cost, and it is backward compatible with existing User Language applications.

===Release notes===
The main features in this release of Model 204 are summarized on this page and described in greater detail in the [[Release notes for Model 204 version 7.5 (DRAFT)|version 7.5 release notes]].

===SOUL===
Here are some of the new SOUL features:
<ul>
<li>Mixed case User Language support
<li>Generic User Language sorting, searching, and subsetting facilities
<li>Improved syntax for setting/retrieving large object (LOB) values (directly to/from longstrings)
<li>Enhanced printing and auditing statements
<li>Implicit concatenation
<li>The Assert and Loop Next statements
<li>A macro language
<li>Data types:
<ul>
<li>Longstring (including image string items > 255 bytes)
<li>Unicode
</ul>
<li>Full OO programming capabilities including:
<ul>
<li>Class and object definitions, methods, public/private class variables, inheritance, polymorphism, etc.
<li>Support for exceptions such as Try, Catch, and Throw statements
<li>Support for named parameters
<li>Support for method variables, that is, variables that can be used to dynamically invoke functions or subroutines
</ul>
<li>Shorthand right-side assignment operators:
<ul>
<li>%a = @ + 1
<li>%a = @ * 1
<li>%a = @ / 1
<li>%a = @ :div(1)
</ul>
</ul>

===64-bit enablement of the Model 204 infrastructure===
Model 204 moves “Above the Bar” to increase scalability, performance, and growth potential. With this release of Model 204, 64-bit addressing becomes the de-facto standard for all subsequent versions. This may bring new challenges to customers who have written assembly language functions for use within Model 204, and Rocket Software has prepared a new set of service offerings to help accommodate upgrade and conversion needs.

===Physical field groups===
Model 204 supports non-relational, denormalized data structures, and its efficient processing of multiply-occurring fields provides significant cost and performance benefits. This processing is enhanced by the availability of physical field groups, which let you view and process groups of fields as logical entities.

===Range searching by Ordered Index (OI) chunk===
The new CHUNK attribute of the DEFINE FIELD command offers significantly more efficient searching on Ordered Index numeric (ORDERED NUMERIC) field ranges. The storage for the file's values of these fields is automatically maintained, divided into ordered sub-ranges ("OI chunks") whose interval-size is part of the CHUNK definition. Finds of value ranges of these fields search by OI chunk rather than by individual value, so they entail fewer scans of the Ordered Index entries.

===Expanded file-record limit===
In version 7.5 of Model 204, the record limit per file increases from sixteen million records to forty-eight million records.

===New debugging tools===
Developing web and screen applications that use Model 204 is made easier by newly acquired debuggers: <var class="product">Janus Debugger</var>, <var class="product">TN3270 Debugger</var>, and <var class="product">SoftSpy</var>.
</div></div><br clear=all>

<div class="mw-collapsible mw-collapsed" data-expandtext="▼" data-collapsetext="▲">
==The status of Janus SOAP==
<div class="mw-collapsible-content">
<var class="product">Janus SOAP</var> was an important of the Sirius Software product set that is still referenced frequently in the M204wiki pages. Significantly, Janus SOAP included
the Janus SOAP User Language Interface, also known as the Janus SOAP ULI. The Janus SOAP ULI was a collection of extensions to <var class="product">User Language</var> originally intended to simplify the coding of
applications that used the <var class="product">Janus SOAP</var> product. In version 7.5 of Model 204, the <var class="product">Janus SOAP ULI</var> features were incorporated into Model 204. They are the new SOUL features [[#SOUL|highlighted above]]. <var class="product">Janus SOAP</var> continues as a separate product providing support for [[Janus SOAP|XML processing]].

<blockquote class="note">
<b>Note: </b>The <var class="product">Janus SOAP ULI</var> extensions did not alter the behavior of <var class="product">User Language</var>. This is important on two counts:
<ol>
<li>When the extensions formerly known as the <var class="product">Janus SOAP ULI</var> are used, <var class="product">SOUL</var> applications continue to work as they always have.

<li>All documentation concerning <var class="product">SOUL/User Language</var> remains valid.
</ol>
</blockquote>
</div></div><br clear=all>

SOUL

2014-03-11T15:23:51Z

SNelson:

The SOUL programming language is used to write systems and applications in [[Model 204]]. The name of the language, SOUL, may be thought of as an acronym for Simple Objective User Language, which alludes to some of the language's essential features: Most significantly, it offers all of the benefits and features of the object oriented programming model, it provides a natural fit for programmers accustomed to other contemporary object oriented languages, and it provides syntax and semantics that are carefully tailored for the manipulation of Model 204 databases, seamlessly integrated in the language.

Prior to version 7.5 of Model 204, the language used for systems and applications in Model 204 was named User Language, and a number of [[User Language#User Language becomes SOUL|Sirius Software extensions]] to it were available, including but not limited to object oriented features. Under Rocket Software, all the former Sirius products, including these extensions, were merged into the base Model 204 product or provided as separately licensed products.

Starting with version 7.5 of Model 204, SOUL is available to all Model 204 customers. It is an evolving language, frequently enhanced. It contains all of the features formerly provided in User Language, together with the object oriented features provided by Rocket Software (including some, but not all, of the Sirius system classes).

Since the former User Language and Rocket Software documentation is in the process of being combined to describe the single language, SOUL, the current documentation may contain references to "User Language" or to the "Janus SOAP User Language Interface" instead of simply to "SOUL".

==Getting started==
In the set of pages that document SOUL, it is recommended that:
<ul>
<li>For someone new to the language, begin with [[Introduction to User Language]].
</li>

<li>For someone familiar with <var class="product">User Language</var> but not
the Sirius Software extensions, begin with [[Release_notes_for_Model_204_version_7.5_(DRAFT)#SOUL_.28User_Language.29_enhancements|Sirius enhancements added to V7.5 of Model 204]].</li>

<li>For an entry point to object-oriented SOUL, see [[Object oriented programming in SOUL]].

<li>For an alphabetical list of links to all SOUL topics, refer to [[:Category:SOUL]].
</ul>

Model 204 documentation

2013-08-08T19:11:38Z

SNelson: /* Model 204 core documentation */

Rocket Model 204 documentation is being converted from individual manuals in PDF format to a set of cross-linked HTML articles in this integrated wiki, M204wiki. Although it is the goal to move all Model 204 and Sirius PDF documents to M204wiki, many documents remain in PDF. The sections below specify which manuals have been converted and which manuals remain in PDF format.

==Model 204 core documentation==
The following manuals have been converted to M204wiki:
<table>
<tr><th>Manual</th><th>M204wiki starting page</th></tr>

<tr><td><var class="book">Rocket Model 204 User Language Manual</var></td>
<td>[[:Category:SOUL|SOUL/User Language]]</td></tr>

<tr><td><var class="book">Rocket Model 204 File Manager's Guide</var><td>[[File Management Overview]]<br>[[File Architecture Overview]]</td></tr>

<tr><td><var class="book">Rocket Model 204 Parameter and Command Reference</var><td>[[List of Model 204 commands|Model 204 and Sirius commands]]<br>
[[List of Model 204 parameters|Model 204 and Sirius parameters]]</td></tr>

<tr><td><var class="book">Rocket Model 204 Release Notes</var></td>
<td>[[Release notes for Model 204 version 7.5]]</td></tr>
</table>

All other core Model 204 manuals remain in PDF: see [http://docs.rocketsoftware.com/nxt/gateway.dll?f=templates$fn=default.htm Model 204 PDF Documentation]

==Sirius documentation==
This section is the primary home page for Sirius documentation. A significant amount of the Sirius documentation now resides in M204wiki.
<p>
The following manuals have been completely converted to M204wiki:

<table>
<tr class="head"><th>Manual</th><th>M204wiki starting page</th></tr>

<tr><td><var class="book">Janus SOAP Reference Manual</var></td>
<td>[[Janus SOAP]]</td></tr>
<tr><td><var class="book">Janus Web Server Reference Manual</var></td>
<td>[[Janus Web Server]]</td></tr>
<tr><td><var class="book">Sirius Mods Command and Parameter Reference Manual</var></td>
<td>[[List of Model 204 commands]]<br>[[List of Model 204 parameters]]</td></tr>
<tr><td><var class="book">Janus TCP/IP Base Reference Manual</var></td>
<td>[[Janus TCP/IP Base]]</td></tr>
<tr><td><var class="book">Janus Sockets Reference Manual</var></td>
<td>[[Janus Sockets]]</td></tr>
<tr><td><var class="book">Sirius Functions Reference Manual</var></td>
<td>[[List of $functions]]</td></tr>
<tr><td><var class="book">Sirius Messages Manual</var></td>
<td>[[:Category:Messages]]</td></tr>
<tr><td><var class="book">Release notes for Sirius Mods V8.1</var></td>
<td>[[Release notes for Sirius Mods V8.1]]</td></tr>
<tr><td><var class="book">Release notes for Sirius Mods V8.0</var></td>
<td>[[Release notes for Sirius Mods V8.0]]</td></tr>
<tr><td><var class="book">Release notes for Sirius Mods V7.9</var></td>
<td>[[Release notes for Sirius Mods V7.9]]</td></tr>
<tr><td><var class="book">Release notes for Sirius Mods V7.8</var></td>
<td>[[Release notes for Sirius Mods V7.8]]</td></tr>
<tr><td><var class="book">UL/SPF Installation and Maintenance Guide</var></td>
<td>[[UL/SPF installation guide]]</td></tr>
</table>

For products not in the list above, the PDFs remain the principal resource.
A complete list of PDF manuals is available at the [http://www.sirius-software.com/maint/manlist PDF Documentation] page on the Sirius Software web site.
The primary product manuals that are still in PDF format are:
<ul><i>
<li>[http://sirius-software.com/maint/download/fastback.pdf Fast/Backup User's Guide]
<li>[http://sirius-software.com/maint/download/cramr.pdf Fast/CRAM Installation Guide]
<li>[http://sirius-software.com/maint/download/tlogr.pdf Fast/CRAM Trusted Login Reference Manual]
<li>[http://sirius-software.com/maint/download/frelr.pdf Fast/Reload Reference Manual]
<li>[http://sirius-software.com/maint/download/funr.pdf Fast/Unload Reference Manual]
<li>[http://sirius-software.com/maint/download/jansslr.pdf Janus Network Security Reference Manual]
<li>[http://sirius-software.com/maint/download/joclr.pdf Janus Open Client Reference Manual]
<li>[http://sirius-software.com/maint/download/josrvr.pdf Janus Open Server Reference Manual]
<li>[http://sirius-software.com/maint/download/jsdsr.pdf Janus Specialty Data Store Reference Manual]
<li>[http://sirius-software.com/maint/download/jansoldr.pdf Janus SOAP Reference Manual (6.4)]
<li>[http://sirius-software.com/maint/download/jdebugr.pdf Janus/Sirius Debugger User's Guide]
<li>[http://sirius-software.com/maint/download/siri.pdf Sirius Mods Installation Guide]
<li>[http://sirius-software.com/maint/download/perfr.pdf Sirius Performance Enhancements Reference Manual]
<li>[http://sirius-software.com/maint/download/audr.pdf SirAud Installation and Reference Guide]
<li>[http://sirius-software.com/maint/download/dbar.pdf SirDBA User's Guide]
<li>[http://sirius-software.com/maint/download/factr.pdf SirFact Reference Manual]
<li>[http://sirius-software.com/maint/download/filr.pdf SirFile User's Guide]
<li>[http://sirius-software.com/maint/download/libr.pdf SirLib User's Guide]
<li>[http://sirius-software.com/maint/download/monr.pdf SirMon User's Guide]
<li>[http://sirius-software.com/maint/download/pror.pdf SirPro User's Guide]
<li>[http://sirius-software.com/maint/download/safr.pdf SirSafe Reference Manual]
<li>[http://sirius-software.com/maint/download/scanr.pdf SirScan User's Guide]
<li>[http://sirius-software.com/maint/download/tunr.pdf SirTune Reference Manual]
<li>[http://sirius-software.com/maint/download/sirzapr.pdf SirZAP User's Guide and Reference]
<li>[http://sirius-software.com/maint/download/sirfield.pdf Sir2000 Field Migration Facility Reference Manual]
<li>[http://sirius-software.com/maint/download/ul2kr.pdf Sir2000 User Language Tools Reference Manual]
</i></ul>

Model 204 documentation

2013-08-08T19:10:12Z

SNelson: /* Model 204 core documentation */

Rocket Model 204 documentation is being converted from individual manuals in PDF format to a set of cross-linked HTML articles in this integrated wiki, M204wiki. Although it is the goal to move all Model 204 and Sirius PDF documents to M204wiki, many documents remain in PDF. The sections below specify which manuals have been converted and which manuals remain in PDF format.

==Model 204 core documentation==
The following manuals have been converted to M204wiki:
<table>
<tr><th>Manual</th><th>M204wiki starting page</th></tr>

<tr><td><var class="book">Rocket Model 204 User Language Manual</var></td>
<td>[[:Category:SOUL|SOUL/User Language]]</td></tr>

<tr><td><var class="book">Rocket Model 204 File Manager's Guide</var><td>[[File Management Overview]]<br>[[File Architecture Overview]]</td></tr>

<tr><td><var class="book">Rocket Model 204 Parameter and Command Reference</var><td>[[List of Model 204 commands|Model 204 and Sirius commands]]<br>
[[List of Model 204 parameters|Model 204 and Sirius parameters]]</td></tr>

<tr><td><var class="book">Rocket Model 204 Release Notes</var></td>
<td>[[Release notes for Model 204 version 7.5]]</td></tr>
</table>

All other core Model 204 manuals remain in PDF: see [http://docs.rocketsoftware.com/nxt/gateway.dll?f=templates$fn=default.htm]

==Sirius documentation==
This section is the primary home page for Sirius documentation. A significant amount of the Sirius documentation now resides in M204wiki.
<p>
The following manuals have been completely converted to M204wiki:

<table>
<tr class="head"><th>Manual</th><th>M204wiki starting page</th></tr>

<tr><td><var class="book">Janus SOAP Reference Manual</var></td>
<td>[[Janus SOAP]]</td></tr>
<tr><td><var class="book">Janus Web Server Reference Manual</var></td>
<td>[[Janus Web Server]]</td></tr>
<tr><td><var class="book">Sirius Mods Command and Parameter Reference Manual</var></td>
<td>[[List of Model 204 commands]]<br>[[List of Model 204 parameters]]</td></tr>
<tr><td><var class="book">Janus TCP/IP Base Reference Manual</var></td>
<td>[[Janus TCP/IP Base]]</td></tr>
<tr><td><var class="book">Janus Sockets Reference Manual</var></td>
<td>[[Janus Sockets]]</td></tr>
<tr><td><var class="book">Sirius Functions Reference Manual</var></td>
<td>[[List of $functions]]</td></tr>
<tr><td><var class="book">Sirius Messages Manual</var></td>
<td>[[:Category:Messages]]</td></tr>
<tr><td><var class="book">Release notes for Sirius Mods V8.1</var></td>
<td>[[Release notes for Sirius Mods V8.1]]</td></tr>
<tr><td><var class="book">Release notes for Sirius Mods V8.0</var></td>
<td>[[Release notes for Sirius Mods V8.0]]</td></tr>
<tr><td><var class="book">Release notes for Sirius Mods V7.9</var></td>
<td>[[Release notes for Sirius Mods V7.9]]</td></tr>
<tr><td><var class="book">Release notes for Sirius Mods V7.8</var></td>
<td>[[Release notes for Sirius Mods V7.8]]</td></tr>
<tr><td><var class="book">UL/SPF Installation and Maintenance Guide</var></td>
<td>[[UL/SPF installation guide]]</td></tr>
</table>

For products not in the list above, the PDFs remain the principal resource.
A complete list of PDF manuals is available at the [http://www.sirius-software.com/maint/manlist PDF Documentation] page on the Sirius Software web site.
The primary product manuals that are still in PDF format are:
<ul><i>
<li>[http://sirius-software.com/maint/download/fastback.pdf Fast/Backup User's Guide]
<li>[http://sirius-software.com/maint/download/cramr.pdf Fast/CRAM Installation Guide]
<li>[http://sirius-software.com/maint/download/tlogr.pdf Fast/CRAM Trusted Login Reference Manual]
<li>[http://sirius-software.com/maint/download/frelr.pdf Fast/Reload Reference Manual]
<li>[http://sirius-software.com/maint/download/funr.pdf Fast/Unload Reference Manual]
<li>[http://sirius-software.com/maint/download/jansslr.pdf Janus Network Security Reference Manual]
<li>[http://sirius-software.com/maint/download/joclr.pdf Janus Open Client Reference Manual]
<li>[http://sirius-software.com/maint/download/josrvr.pdf Janus Open Server Reference Manual]
<li>[http://sirius-software.com/maint/download/jsdsr.pdf Janus Specialty Data Store Reference Manual]
<li>[http://sirius-software.com/maint/download/jansoldr.pdf Janus SOAP Reference Manual (6.4)]
<li>[http://sirius-software.com/maint/download/jdebugr.pdf Janus/Sirius Debugger User's Guide]
<li>[http://sirius-software.com/maint/download/siri.pdf Sirius Mods Installation Guide]
<li>[http://sirius-software.com/maint/download/perfr.pdf Sirius Performance Enhancements Reference Manual]
<li>[http://sirius-software.com/maint/download/audr.pdf SirAud Installation and Reference Guide]
<li>[http://sirius-software.com/maint/download/dbar.pdf SirDBA User's Guide]
<li>[http://sirius-software.com/maint/download/factr.pdf SirFact Reference Manual]
<li>[http://sirius-software.com/maint/download/filr.pdf SirFile User's Guide]
<li>[http://sirius-software.com/maint/download/libr.pdf SirLib User's Guide]
<li>[http://sirius-software.com/maint/download/monr.pdf SirMon User's Guide]
<li>[http://sirius-software.com/maint/download/pror.pdf SirPro User's Guide]
<li>[http://sirius-software.com/maint/download/safr.pdf SirSafe Reference Manual]
<li>[http://sirius-software.com/maint/download/scanr.pdf SirScan User's Guide]
<li>[http://sirius-software.com/maint/download/tunr.pdf SirTune Reference Manual]
<li>[http://sirius-software.com/maint/download/sirzapr.pdf SirZAP User's Guide and Reference]
<li>[http://sirius-software.com/maint/download/sirfield.pdf Sir2000 Field Migration Facility Reference Manual]
<li>[http://sirius-software.com/maint/download/ul2kr.pdf Sir2000 User Language Tools Reference Manual]
</i></ul>

Model 204

2013-06-24T01:05:27Z

SNelson: /* References */

<var class="product"><b>Model 204</b></var> is a DBMS for IBM and compatible mainframes, which was first deployed as a product in 1972. Formerly owned by Computer Corporation of America (CCA), <var class="product">Model 204</var> was purchased in 2010 by Rocket Software, of Newton, Massachusetts.

<var class="product">Model 204</var> is a database management system (DBMS) that provides facilities for the creation, control, query and maintenance of database files. Access to the data is provided by an internal language known as '''<var class="product"><b>User Language</b></var>''', by a variety of Host Language Interfaces (for example, you can embed queries to <var class="product">Model 204</var> data in COBOL, Assembler, Fortran, etc.) and via SQL using Horizon and CRAM interfaces.

<var class="product">Model 204</var> contains an embedded TP monitor that provides for user sessions directly in the DBMS address space. Note that this makes <var class="product">Model 204</var> unique in the DBMS world: Rather than users viewing the data from an external application, <var class="product">Model 204</var> users typically hold full-screen sessions directly inside <var class="product">Model 204</var>.

<var class="product">Model 204</var> is highly parameterized and can be configured for environments that are quite compact and also for environments spanning the largest IBM and IBM-compatible multiprocessor machines. <var class="product">Model 204</var>'s strengths lie in its ability to handle very large volumes of data accessed by very large numbers of users, processing very high volumes of transactions. In addition, <var class="product">Model 204</var> is characterized by its high level of integration and the ease and variety of programming approaches for application development.

The internal structure of <var class="product">Model 204</var> database files is based on a set of tables which hold file parameters, data records, indexes, procedures and binary large objects. The sizing of the tables is based on expected use of the file. Typically, procedures are held in separate files from data, but this is more of a standard practice and is not enforced by <var class="product">Model 204</var>.

While a <var class="product">Model 204</var> database can be fully ''Normalized'', this too is not enforced by the structure of <var class="product">Model 204</var>. In fact, <var class="product">Model 204</var> records can be completely free-form, with varying lengths of records and varying numbers of occurrences of same-named fields. Because records, and the fields that are populated on records, do not require or use any pre-allocated space, <var class="product">Model 204</var> lends itself to applications where record sizes vary greatly and where the largest records or greatest number of occurrences of any field or set of fields, is unpredictable. Family records, for instance, are well-suited to Model 204 databases, as the average family might have 2 or 3 children, but many will have none, and a few will have dozens, or even hundreds. In a <var class="product">Model 204</var> file, the smallest "Family" record takes up only the space that it requires, and lives happily alongside other "Family" records
that are many times larger.

==Relationship to other vendors==

[[Sirius Software]] develops add-on software for <var class="product">Model 204</var>, including the Janus family of connectivity products and a wide variety of performance, tuning and functional enhancements.

Allscripts Corporation owns and develops a hospital system using <var class="product">Model 204</var> as the database engine.

==Documentation==
<ul>
<li>[[M204wiki main page#Model 204|Model 204 documentation on M204wiki]]

<li>[http://www.rocketsoftware.com/m204/products/model204/documentation Model 204 PDF documentation]
</ul>

==References==
<ul>
<li>[http://www.rocketsoftware.com/m204 Rocket Software (M204)]

<li>[http://sirius-software.com Sirius Software, Inc.]

<li>[http://www.allscripts.com/ Allscripts Corporation]
</ul>

Model 204

2013-06-20T15:23:44Z

SNelson: /* Documentation */

<var class="product"><b>Model 204</b></var> is a DBMS for IBM and compatible mainframes, which was first deployed as a product in 1972. Formerly owned by Computer Corporation of America (CCA), <var class="product">Model 204</var> was purchased in 2010 by Rocket Software, of Newton, Massachusetts.

<var class="product">Model 204</var> is a database management system (DBMS) that provides facilities for the creation, control, query and maintenance of database files. Access to the data is provided by an internal language known as '''<var class="product"><b>User Language</b></var>''', by a variety of Host Language Interfaces (for example, you can embed queries to <var class="product">Model 204</var> data in COBOL, Assembler, Fortran, etc.) and via SQL using Horizon and CRAM interfaces.

<var class="product">Model 204</var> contains an embedded TP monitor that provides for user sessions directly in the DBMS address space. Note that this makes <var class="product">Model 204</var> unique in the DBMS world: Rather than users viewing the data from an external application, <var class="product">Model 204</var> users typically hold full-screen sessions directly inside <var class="product">Model 204</var>.

<var class="product">Model 204</var> is highly parameterized and can be configured for environments that are quite compact and also for environments spanning the largest IBM and IBM-compatible multiprocessor machines. <var class="product">Model 204</var>'s strengths lie in its ability to handle very large volumes of data accessed by very large numbers of users, processing very high volumes of transactions. In addition, <var class="product">Model 204</var> is characterized by its high level of integration and the ease and variety of programming approaches for application development.

The internal structure of <var class="product">Model 204</var> database files is based on a set of tables which hold file parameters, data records, indexes, procedures and binary large objects. The sizing of the tables is based on expected use of the file. Typically, procedures are held in separate files from data, but this is more of a standard practice and is not enforced by <var class="product">Model 204</var>.

While a <var class="product">Model 204</var> database can be fully ''Normalized'', this too is not enforced by the structure of <var class="product">Model 204</var>. In fact, <var class="product">Model 204</var> records can be completely free-form, with varying lengths of records and varying numbers of occurrences of same-named fields. Because records, and the fields that are populated on records, do not require or use any pre-allocated space, <var class="product">Model 204</var> lends itself to applications where record sizes vary greatly and where the largest records or greatest number of occurrences of any field or set of fields, is unpredictable. Family records, for instance, are well-suited to Model 204 databases, as the average family might have 2 or 3 children, but many will have none, and a few will have dozens, or even hundreds. In a <var class="product">Model 204</var> file, the smallest "Family" record takes up only the space that it requires, and lives happily alongside other "Family" records
that are many times larger.

==Relationship to other vendors==

[[Sirius Software]] develops add-on software for <var class="product">Model 204</var>, including the Janus family of connectivity products and a wide variety of performance, tuning and functional enhancements.

Allscripts Corporation owns and develops a hospital system using <var class="product">Model 204</var> as the database engine.

==Documentation==
<ul>
<li>[[M204wiki main page#Model 204|Model 204 documentation on M204wiki]]

<li>[http://www.rocketsoftware.com/m204/products/model204/documentation Model 204 PDF documentation]
</ul>

==References==
<ul>
<li>[http://www.rocketsoftware.com/m204/products/model204/documentation Rocket Software (M204)]

<li>[http://sirius-software.com Sirius Software, Inc.]

<li>[http://www.allscripts.com/ Allscripts Corporation]
</ul>

Model 204

2013-06-20T15:08:24Z

SNelson:

<var class="product"><b>Model 204</b></var> is a DBMS for IBM and compatible mainframes, which was first deployed as a product in 1972. Formerly owned by Computer Corporation of America (CCA), <var class="product">Model 204</var> was purchased in 2010 by Rocket Software, of Newton, Massachusetts.

<var class="product">Model 204</var> is a database management system (DBMS) that provides facilities for the creation, control, query and maintenance of database files. Access to the data is provided by an internal language known as '''<var class="product"><b>User Language</b></var>''', by a variety of Host Language Interfaces (for example, you can embed queries to <var class="product">Model 204</var> data in COBOL, Assembler, Fortran, etc.) and via SQL using Horizon and CRAM interfaces.

<var class="product">Model 204</var> contains an embedded TP monitor that provides for user sessions directly in the DBMS address space. Note that this makes <var class="product">Model 204</var> unique in the DBMS world: Rather than users viewing the data from an external application, <var class="product">Model 204</var> users typically hold full-screen sessions directly inside <var class="product">Model 204</var>.

<var class="product">Model 204</var> is highly parameterized and can be configured for environments that are quite compact and also for environments spanning the largest IBM and IBM-compatible multiprocessor machines. <var class="product">Model 204</var>'s strengths lie in its ability to handle very large volumes of data accessed by very large numbers of users, processing very high volumes of transactions. In addition, <var class="product">Model 204</var> is characterized by its high level of integration and the ease and variety of programming approaches for application development.

The internal structure of <var class="product">Model 204</var> database files is based on a set of tables which hold file parameters, data records, indexes, procedures and binary large objects. The sizing of the tables is based on expected use of the file. Typically, procedures are held in separate files from data, but this is more of a standard practice and is not enforced by <var class="product">Model 204</var>.

While a <var class="product">Model 204</var> database can be fully ''Normalized'', this too is not enforced by the structure of <var class="product">Model 204</var>. In fact, <var class="product">Model 204</var> records can be completely free-form, with varying lengths of records and varying numbers of occurrences of same-named fields. Because records, and the fields that are populated on records, do not require or use any pre-allocated space, <var class="product">Model 204</var> lends itself to applications where record sizes vary greatly and where the largest records or greatest number of occurrences of any field or set of fields, is unpredictable. Family records, for instance, are well-suited to Model 204 databases, as the average family might have 2 or 3 children, but many will have none, and a few will have dozens, or even hundreds. In a <var class="product">Model 204</var> file, the smallest "Family" record takes up only the space that it requires, and lives happily alongside other "Family" records
that are many times larger.

==Relationship to other vendors==

[[Sirius Software]] develops add-on software for <var class="product">Model 204</var>, including the Janus family of connectivity products and a wide variety of performance, tuning and functional enhancements.

Allscripts Corporation owns and develops a hospital system using <var class="product">Model 204</var> as the database engine.

==Documentation==
<ul>
<li>[[M204wiki main page#Model 204|Model 204 documentation on M204wiki]]

<li>[http://www.rocketsoftware.com/m204/products/index/documentation Model 204 PDF documentation]
</ul>

==References==
<ul>
<li>[http://www.rocketsoftware.com/m204/products/model204/documentation Rocket Software (M204)]

<li>[http://sirius-software.com Sirius Software, Inc.]

<li>[http://www.allscripts.com/ Allscripts Corporation]
</ul>

Model 204

2013-06-20T15:06:04Z

SNelson: /* References */

<var class="product"><b>Model 204</b></var> is a DBMS for IBM and compatible mainframes, which was first deployed as a product in 1972. Formerly owned by Computer Corporation of America (CCA), <var class="product">Model 204</var> was purchased in 2010 by Rocket Software, of Newton, Massachusetts.

<var class="product">Model 204</var> is a database management system (DBMS) that provides facilities for the creation, control, query and maintenance of database files. Access to the data is provided by an internal language known as '''<var class="product"><b>User Language</b></var>''', by a variety of Host Language Interfaces (for example, you can embed queries to <var class="product">Model 204</var> data in COBOL, Assembler, Fortran, etc.) and via SQL using Horizon and CRAM interfaces.

<var class="product">Model 204</var> contains an embedded TP monitor that provides for user sessions directly in the DBMS address space. Note that this makes <var class="product">Model 204</var> unique in the DBMS world: Rather than users viewing the data from an external application, <var class="product">Model 204</var> users typically hold full-screen sessions directly inside <var class="product">Model 204</var>.

<var class="product">Model 204</var> is highly parameterized and can be configured for environments that are quite compact and also for environments spanning the largest IBM and IBM-compatible multiprocessor machines. <var class="product">Model 204</var>'s strengths lie in its ability to handle very large volumes of data accessed by very large numbers of users, processing very high volumes of transactions. In addition, <var class="product">Model 204</var> is characterized by its high level of integration and the ease and variety of programming approaches for application development.

The internal structure of <var class="product">Model 204</var> database files is based on a set of tables which hold file parameters, data records, indexes, procedures and binary large objects. The sizing of the tables is based on expected use of the file. Typically, procedures are held in separate files from data, but this is more of a standard practice and is not enforced by <var class="product">Model 204</var>.

While a <var class="product">Model 204</var> database can be fully ''Normalized'', this too is not enforced by the structure of <var class="product">Model 204</var>. In fact, <var class="product">Model 204</var> records can be completely free-form, with varying lengths of records and varying numbers of occurrences of same-named fields. Because records, and the fields that are populated on records, do not require or use any pre-allocated space, <var class="product">Model 204</var> lends itself to applications where record sizes vary greatly and where the largest records or greatest number of occurrences of any field or set of fields, is unpredictable. Family records, for instance, are well-suited to Model 204 databases, as the average family might have 2 or 3 children, but many will have none, and a few will have dozens, or even hundreds. In a <var class="product">Model 204</var> file, the smallest "Family" record takes up only the space that it requires, and lives happily alongside other "Family" records
that are many times larger.

==Relationship to other vendors==

[[Sirius Software]] develops add-on software for <var class="product">Model 204</var>, including the Janus family of connectivity products and a wide variety of performance, tuning and functional enhancements.

Eclipsys Corporation owns and develops a hospital system using <var class="product">Model 204</var> as the database engine.

==Documentation==
<ul>
<li>[[M204wiki main page#Model 204|Model 204 documentation on M204wiki]]

<li>[http://www.rocketsoftware.com/m204/products/index/documentation Model 204 PDF documentation]
</ul>

==References==
<ul>
<li>[http://www.rocketsoftware.com/m204/products/model204/documentation Rocket Software (M204)]

<li>[http://sirius-software.com Sirius Software, Inc.]

<li>[http://www.eclipsys.com/ Eclipsys Corporation]
</ul>