Server API - Server Object Methods 2


Home>Product Description>Programmer API>Server API

Server Object Methods - 2 of 2

$SendMail

Sends an email. The WebPublisher Studio Mail Manager is used to setup the outgoing mail servers.

Syntax

Do SERVER.$SendMail($clib,cSndName,cSndAdr,cSubject,lTo,iType,cBody, [lCC,lBCC,iPriority]) Returns #F

cSndName

character - sender's name.

cSndAdr

character - sender's email address.

cSubject

character - mail subject.

lTo

list - single column list of receiver email addresses.

iType

short integer - content mime type - 0=text/plain, 1=text/html - if omitted defaults to 0.

cBody

character - the mail message body.

lCC

list - optional - single column list of CC email addresses.

lBCC

list - optional - single column list of BCC email addresses.

iPriority

short integer - optional - range 1 through 5 with 1 as the highest priority - if omitted defaults to 3.

#F

true if the operation succeeded, false if a mail error occurred.

Notes

Error messages will be posted to the WebPublisher Studio Mail Error Log.

$GetTemplate

Returns a template from the plugin resource datafile and evaluates any embedded expressions.

Syntax

Do SERVER.$GetTemplate($clib,cResName,cTemplate) Returns #F

cResName

character - resource name of a Template.

cTemplate

character variable that receives the evaluated template.

#F

true if the operation succeeded, false if the resource does not exist.

Notes

Format for embedded variables is: [=expression]
expression can be:
- a file class variable in the Plug-in.
- a hash variable.
- a Macro variable if the function is called from the SERVER object in the macro environment.
- an Omnis expression
.

©Corporate Windows Pty Limited 2012 Previous | Next