SIMPOL Documentation

Chapter 85. smtpclientlib

This library provides a more direct access to the sending of SMTP emails than the sendmail library, and it is used by the sendmail library. It currently only implements text-based emails. See the source code for further information.

smtpmessage

Description

Type Tags

None

Object Value

Objects of type smtpmessage have no value, and it is an error to try to get or set this value.

smtpmessage.new()

Description

Prototype

smtpmessage.new ( smtpmessage me, string contenttype, string transferencoding )

Parameters

ParameterDefault valueType nameDescription
meNonesmtpmessage
contenttypetext/plain; charset="iso-8859-15"string
transferencoding8bitstring

Properties

PropertyTypeDescription
addattachmentfunction
addrecipfunction
attachmentsset
authtypeinteger
bccset
bodystring
boundarystring
ccset
commentstring
contenttypestring
createmimeboundaryfunction
debugboolean
dtdatetime
fromstring
getaddressfunction
hostnamestring
mailhoststring
messageidstring
passwordstring
preparemsgfunction
replytostring
sendfunction
send8bitfunction
setauthinfofunction
subjectstring
timezonestring
toset
transferencodingstring
typetype
usehtmlboolean
usernamestring

Methods

addattachment()

Description

Prototype

smtpmessagevar.addattachment ( smtpmessage me, string filename, integer error )

Parameters
ParameterDefault valueType nameDescription
meNonesmtpmessage
filenameNonestring
errorNoneinteger

addrecip()

Description

Prototype

smtpmessagevar.addrecip ( smtpmessage me, string reciptype, string address )

Parameters
ParameterDefault valueType nameDescription
meNonesmtpmessage
reciptypeNonestring
addressNonestring

createmimeboundary()

Description

Prototype

smtpmessagevar.createmimeboundary ( smtpmessage me )

Parameters
ParameterDefault valueType nameDescription
meNonesmtpmessage

getaddress()

Description

Prototype

smtpmessagevar.getaddress ( smtpmessage me, string s )

Parameters
ParameterDefault valueType nameDescription
meNonesmtpmessage
sNonestring

send()

Description

Prototype

smtpmessagevar.send ( smtpmessage me )

Parameters
ParameterDefault valueType nameDescription
meNonesmtpmessage

send8bit()

Description

Prototype

smtpmessagevar.send8bit ( smtpmessage me )

Parameters
ParameterDefault valueType nameDescription
meNonesmtpmessage

setauthinfo()

Description

Prototype

smtpmessagevar.setauthinfo ( smtpmessage me, integer authtype, string username, string password, integer error )

Parameters
ParameterDefault valueType nameDescription
meNonesmtpmessage
authtypeNoneinteger
usernameNonestring
passwordNonestring
errorNoneinteger