Skip over navigation

Roxen Interactive RXML Help

<email></email>

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
server=URL (localhost)

The hostname of the machine that operates the mail server.

subject
subject= ([ * No Subject * ])

The subject line.

from
from=

The email address of sender. Values on the form John Doe foo@bar.com renders a From: header like From: "John Doe" <foo@bar.com>. If the value contains a '<' the value is left unaltered.

envelope-from
envelope-from=

The email address of sender to use on the SMTP envelope. Values on the form John Doe foo@bar.com renders a From: header like From: "John Doe" <foo@bar.com>. If the value contains a '<' the value is left unaltered.

to
to=

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

cc
cc=

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

bcc
bcc=

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

separator
separator= (,)

The separator character for the recipient list.

mimetype
mimetype=MIME type

Overrides the MIME type of the body.

main-mimetype
main-mimetype=MIME type

Overrides the MIME type of the enclosing message when attachments are used. Default is 'multipart/mixed' but it might be useful to set this to 'multipart/related' when sending HTML mail with inlined images. Note that HTML mails should use either quoted-printable or base64 transfer encoding to ensure that you don't exceed the SMTP line length maximum.

mimeencoding
mimeencoding=MIME encoding

Sets the MIME encoding of the message. Typical values are 8bit, quoted-printable and base64.

charset
charset= (iso-8859-1)

The charset of the body and subject. The body will be encoded in utf-8 if it was not possible to encode the text in the supplied charset. The subject will be unencoded if possible otherwise encoded with the supplied charset or encoded in utf-8 if it was not possible to encode the text in the supplied charset.

error-variable
error-variable=RXML variable

An RXML variable to store a potential error message in.

<email from="foo@bar.com" to="johny@pub.com|pity@bufet.com|ely@rest.com" separator="|" charset="iso-8859-2" server="mailhub.anywhere.org" error-variable="var.error"> This is the contents. </email> <else> Failed to send email: &var.error; </else>

Defined in content

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

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
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
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.

disposition
disposition=Content-disposition

The MIME content-disposition to use for the attachment. The default disposition is "attachment".

cid
cid=Content-ID

The content-id to use for the attachment. The default id is "nocid".

mimetype
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
mimeencoding=MIME encoding

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

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

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

By default replacing standard headers is not allowed.

Attributes

name
name=string
This attribute is required.

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
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. The 'Bcc' and 'Cc' headers can contain multiple addresses separated by ',' or the string in the split attribute of <email>.

<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="Bcc">joe@bar.com|jane@foo.com</header> <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/>

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

<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>