docs.roxen.comView this page in a printer friendly mode
DocsRoxenWebServer 3.3Web Developer ManualProtocol Tags
Copyright  2004, Roxen Internet Software
Suggestions, comments & compliments
manuals@roxen.com
 DEMO  DOCS  PIKE
 COMMUNITY  DOWNLOAD
www.roxen.com



<aconf>
<apre>
<auth-required>
<email>
<expire-time>
<header>
<killframe>
<redirect>
<remove-cookie>
<return>
<set-cookie>
<throttle>

<email></email>

Provided by module: Tags: E-mail module

The <email> sends MIME compliant mail to a mail server using the (E)SMTP protocol. The content is sent as raw text Attribute default values can be changed within the E-mail module's administration interface.


Attributes

server="URL"(localhost)

The hostname of the machine that operates the mail server.


subject=""("[ * No Subject * ]")

The subject line.


from=""((empty))

The email address of sender.


to=""((empty))

The list of recipient email address(es). Separator character can be defined by the 'separator' attribute.


separator=""(,)

The separator character for the recipient list.


mimetype="MIME type"

Overrides the MIME type of the body.


mimeencoding="MIME encoding"

Sets the MIME encoding of the message.


charset=""(iso-8859-1)

The charset of the body.



<email from="foo@bar.com" to="johny@pub.com|pity@bufet.com|ely@rest.com"
separator="|" charset="iso-8859-2" server="mailhub.anywhere.org" >
 This is the contents.
</email>

<attachment/> or <attachment></attachment>

Provided by module: Tags: E-mail module

This tag/subcontainer is designed for adding attachments to the mail.

There are two different kinds of attachments; file and inline. File attachments require the file attribute while inline attachments are written inline. Inline attachments can for instance be a text or a binary (e.g. output from a database).


<email from="foo@bar.com" to="johny@pub.com|pity@bufet.com|ely@rest.com"
separator="|" charset="iso-8859-2" server="mailhub.anywhere.org">

<header name="X-foo-header" value="one two three" />
<header name="Importance">Normal</header>
<header name="X-MSMail-Priority" value="Normal" />
 This is the contents.

<attachment file="/images/hello.gif" />
<attachment file="/excel/p_123.xls" name="partners.xls" />

<attachment name="partners.txt" >
      company1        1.2345  abc
      company2        2.345   ix
      company8        3.4567  az
</attachment>
</email>

Attributes

file="path"

The path to the file in the virtual filesystem. If this attribute is omitted it is assumed that the attachment is a text attachment.


name="filename"

The filename. When sending a file attachment this name is what the reciever will see in his/hers list of attachment, not the original filename. If omitted, the original name will be used. This attribute is required when sending inline text or binary attachments.


mimetype="MIME type"

Sets the MIME type of the file. Since MIME type is set by the Content types module this setting seldom needs to be used.


mimeencoding="MIME encoding"

Sets the MIME encoding of the file. If omitted the E-mail module's default setting within the Roxen WebServer Administration interface might be used if it's a file attachment.


<header/> or <header></header>

Provided by module: Tags: E-mail module

This subtag/container is designed for adding additional headers to the mail.


Attributes

name="string"

The name of the header. Standard headers are 'From:', 'To:', 'Cc:', 'Bcc:' and 'Subject:'. However, there are no restrictions on how many headers are sent.


value=""

The value of the header. This attribute is only used when using the singletag version of the tag. In case of the tag being used as a containertag the content will be the value.



<email from="foo@bar.com" to="johny@pub.com|pity@bufet.com|ely@rest.com"
separator="|" charset="iso-8859-2" server="mailhub.anywhere.org">

<header name="X-foo-header" value="one two three" />
<header name="Importance">Normal</header>
<header name="X-MSMail-Priority" value="Normal" />
 This is the contents.
</email>

<signature/>

Provided by module: Tags: E-mail module

This container is designed for adding a signature to the mail.


Attributes


<email from="foo@bar.com" to="johny@pub.com|pity@bufet.com|ely@rest.com"
separator="|" charset="iso-8859-2" server="mailhub.anywhere.org">

<header name="X-foo-header" value="one two three" />
<header name="Importance">Normal</header>
<header name="X-MSMail-Priority" value="Normal" />
 This is the contents.

<signature>
-------------------
John Doe
Roxen Administrator
</signature>
</email>