[interchange-docs] xmldocs - racke modified refs/email
docs at icdevgroup.org
docs at icdevgroup.org
Thu Dec 13 18:09:21 EST 2007
User: racke
Date: 2007-12-13 23:09:21 GMT
Modified: refs email
Log:
attach parameter added, description of attaching single file added
Revision Changes Path
1.5 +46 -0 xmldocs/refs/email
rev 1.5, prev_rev 1.4
Index: email
===================================================================
RCS file: /var/cvs/xmldocs/refs/email,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- email 13 Dec 2004 00:04:41 -0000 1.4
+++ email 13 Dec 2007 23:09:21 -0000 1.5
@@ -45,6 +45,23 @@
<entry>Additional e-mail headers to include. For example,
<literal>Errors-To: errors at mydomain.local</literal>.</entry>
</row>
+<row>
+ <entry>
+ <arg choice='plain'>html</arg>
+ </entry>
+ <entry></entry>
+ <entry></entry>
+ <entry></entry>
+ <entry>HTML part for the message</entry>
+</row>
+<row>
+ <entry>attach</entry>
+ <entry></entry>
+ <entry></entry>
+ <entry></entry>
+ <entry>File(s) to attach to the generated email.</entry>
+</row>
+
&ROW_HIDE_0;
__END__
@@ -62,6 +79,25 @@
all relevant information using tag attributes.
The <arg choice='plain'>to</arg> parameter must be supplied and contain
a valid e-mail address, or the message surely won't be delivered.
+</para>
+<refsect2><title>Attaching Files</title>
+<para>
+To add a single file as an attachment, you just do:
+</para>
+<programlisting><![CDATA[
+[email
+ from=foo at bar.com
+ to=bar at foo.com
+ subject=test
+ attach=foo.gif
+] Here is the gif file I promised. [/email]
+]]></programlisting>
+<para>
+It automatically picks up the MIME type, and handles many if you
+have the optional MIME::Types module installed.
+</para>
+</refsect2>
+<para>
__END__
@@ -77,3 +113,13 @@
</programlisting>
__END__
+__NAME__ example: HTML message
+<programlisting>
+[email
+ from=foo at bar.com
+ to=bar at foo.com
+ subject=test
+ html="[scratch some_big_hairy_mess]"
+ ]This is the plain text part.[/email]
+</programlisting>
+__END__
More information about the docs
mailing list