SetBody (Email subroutine) - Revision history

JAL2 at 21:54, 14 August 2012

2012-08-14T21:54:39Z

← Older revision		Revision as of 21:54, 14 August 2012
Line 7:		Line 7:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>email</th>		<tr><th>email</th>
	<td>~~A previously declared~~ <var>Email</var> object.		<td>An <var>Email</var> object.</td></tr>
	</td></tr>
	<tr><th>content</th>		<tr><th>content</th>
	<td>A <var>Stringlist</var> or <var>Longstring</var> that contains the actual e-mail body.		<td>A <var>Stringlist</var> or <var>Longstring</var> that contains the actual e-mail body.
Line 22:		Line 22:
	<tr><th><var>Type</var></th>		<tr><th><var>Type</var></th>
	<td>This [[Notation conventions for methods#Name required\|name required]] parameter specifies the MIME type of the content.		<td>This [[Notation conventions for methods#Name required\|name required]] parameter specifies the MIME type of the content.
	MIME content type strings consist of a primary type and a subtype delimited by a forward slash ( / ) character, for example, <code>text/xml</code>.		MIME content-type strings consist of a primary type and a subtype delimited by a forward slash ( / ) character, for example, <code>text/xml</code>.

	<var>SetBody</var> performs no validity checking, but it does distinguish between text MIME types ("text"; is the primary type) and non-text types.		<var>SetBody</var> performs no validity checking, but it does distinguish between text MIME types ("text"; is the primary type) and non-text types.
Line 36:		Line 36:
	To enable base64 encoding for text content, specify <code>encoding=base64</code>. To disable encoding for non-text content, specify <code>encoding=none</code>.		To enable base64 encoding for text content, specify <code>encoding=base64</code>. To disable encoding for non-text content, specify <code>encoding=none</code>.

	Specifying <code>encoding=none</code> for non-text content is not recommended: the likely result is that the recipient receives corrupt data, or otherwise the SMTP gateway may simply discard the message.</td></tr>		Specifying <code>encoding=none</code> for non-text content is ''not'' recommended: the likely result is that the recipient receives corrupt data, or otherwise the SMTP gateway may simply discard the message.</td></tr>
	</table>		</table>

Line 62:		Line 62:
	...		...
	</p>		</p>
	<li>For <var>SetBody</var> method examples, see [[Email class#Basic e-mail\|"Basic e-mail"]] and		<li>For more <var>SetBody</var> method examples, see [[Email class#Basic e-mail example\|"Basic e-mail example"]] and
	[[Email class#E-mail with attachment\|"E-mail with attachment"]].		[[Email class#E-mail with attachment\|"E-mail with attachment"]].
	</ul>		</ul>

JAL2 at 22:10, 5 March 2012

2012-03-05T22:10:28Z

← Older revision		Revision as of 22:10, 5 March 2012
Line 3:		Line 3:
	==Syntax==		==Syntax==
	{{Template:Email:SetBody syntax}}		{{Template:Email:SetBody syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
Line 17:		Line 18:
	In this case, no delimiter is added at the end of an item.		In this case, no delimiter is added at the end of an item.

	If a longstring is passed, no delimiters are added to the content.		If a longstring is passed, no delimiters are added to the content. </td></tr>
	</td></tr>
	<tr><th>Type</~~th>~~		<tr><th><var>Type</var></th>
	~~<td>Any combination of the following options. Each may be specified only once.~~		<td>This [[Notation conventions for methods#Name required\|name required]] parameter specifies the MIME type of the content.
	~~<dl~~>		MIME content type strings consist of a primary type and a subtype delimited by a forward slash ( / ) character, for example, <code>text/xml</code>.
	~~<dt><b>Type~~</b>
	<td>This [[Notation conventions for methods#Name required\|name required]] parameter
	specifies the MIME type of the content.
	MIME content type strings consist
	of a primary type and a subtype delimited by a forward slash ( / ) character,
	for example, <code>text/xml</code>.

	<var>SetBody</var> performs no validity checking, but it does distinguish		<var>SetBody</var> performs no validity checking, but it does distinguish between text MIME types ("text"; is the primary type) and non-text types.
	between text MIME types ("text"; is the primary type) and non-text types.		If non-text, <var>SetBody</var> encodes the content in base64 format to ensure correct translation at SMTP gateways.
	If non-text, <var>SetBody</var> encodes the content in base64 format		You can override this encoding by specifying the <var>Encoding</var> option set to the value <code>none</code>. </td></tr>
	to ensure correct translation at SMTP gateways.
	You can override this encoding by specifying
	the <var>Encoding</var> option set to the value <code>none</code>.

	<dt><b>Name</b>		<tr><th><var>Name</var></th>
	<dd>This name required parameter provides a name for the		<td>This name required parameter provides a name for the message body or a message part. This option is rarely used for the mail body, and it is usually ignored by the mail client. It is most often used for attachments, which are added with <var>[[AddPart (Email subroutine)\|AddPart]]</var>. </td></tr>
	message body or a message part.
	This option is rarely used for the mail body, and it is usually ignored
	by the mail client.
	It is most often used for attachments, which are added with <var>[[AddPart (Email subroutine)\|AddPart]]</var>.

	<dt><b>Encoding</b>		<tr><th><var>Encoding</var>
	<dd>This name required parameter		<td>This name required parameter forces or suppresses encoding for the attachment.
	forces or suppresses encoding for the attachment.		Since base64 encoding is automatically enabled for any non-text content, the <var>Encoding</var> option is usually unnecessary.
	Since base64 encoding is automatically enabled for any non-text content,		To enable base64 encoding for text content, specify <code>encoding=base64</code>. To disable encoding for non-text content, specify <code>encoding=none</code>.
	the <var>Encoding</var> option is usually unnecessary.
	To enable base64 encoding for text content, specify <code>encoding=base64</code>.
	To disable encoding for non-text content, specify <code>encoding=none</code>.

	Specifying <code>encoding=none</code> for non-text content is		Specifying <code>encoding=none</code> for non-text content is not recommended: the likely result is that the recipient receives corrupt data, or otherwise the SMTP gateway may simply discard the message.</td></tr>
	not recommended: the likely result is that the recipient receives corrupt data,		</table>
	or otherwise the SMTP gateway may simply discard the message.~~</dl>~~
	</td></tr></table>

	==Usage notes==		==Usage notes==
	Subsequent invocations of the <var>SetBody</var> method completely replace any		<ul>
	existing content.		<li>The <var>Type</var>, <var>Name</var>, and <var>Encoding</var> options may be specified in any combination, but each may be specified only once.
			<li>Subsequent invocations of the <var>SetBody</var> method completely replace any existing content.
			</ul>

	==Examples==		==Examples==

JAL2: /* Syntax terms */

2012-03-05T21:58:30Z

Syntax terms

JAL2: /* Syntax terms */

2012-03-05T21:54:50Z

Syntax terms

← Older revision		Revision as of 21:54, 5 March 2012
Line 35:		Line 35:
	You can override this encoding by specifying		You can override this encoding by specifying
	the <var>Encoding</var> option set to the value <code>none</code>.		the <var>Encoding</var> option set to the value <code>none</code>.

			<dt><b>Name</b>
			<dd>This name required parameter provides a name for the
			message body or a message part.
			This option is rarely used for the mail body, and it is usually ignored
			by the mail client.
			It is most often used for attachments, which are added with <var>[[AddPart (Email subroutine)\|AddPart]]</var>.

	<dt><b>Encoding</b>		<dt><b>Encoding</b>
	<dd>This name required parameter		<dd>This name required parameter
Line 45:		Line 53:
	Specifying <code>encoding=none</code> for non-text content is		Specifying <code>encoding=none</code> for non-text content is
	not recommended: the likely result is that the recipient receives corrupt data,		not recommended: the likely result is that the recipient receives corrupt data,
	or otherwise the SMTP gateway may simply discard the message.		or otherwise the SMTP gateway may simply discard the message.</dl>
	~~<dt><b>Name</b>~~
	~~<dd>This name required parameter provides a name for the~~
	~~message body or a message part.~~
	~~This option is rarely used for the mail body, and it is usually ignored~~
	~~by the mail client.~~
	~~It is most often used for attachments, which are added with <var>[[AddPart (Email subroutine)\|AddPart]]</var>.~~
	</dl>
	</td></tr></table>		</td></tr></table>

JAL2: /* Syntax terms */

2012-03-05T21:54:13Z

Syntax terms

← Older revision		Revision as of 21:54, 5 March 2012
Line 5:		Line 5:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%email</th>		<tr><th>email</th>
	<td>A previously declared <var>Email</var> object.		<td>A previously declared <var>Email</var> object.
	</td></tr>		</td></tr>
Line 54:		Line 54:
	</dl>		</dl>
	</td></tr></table>		</td></tr></table>

	==Usage notes==		==Usage notes==
	Subsequent invocations of the <var>SetBody</var> method completely replace any		Subsequent invocations of the <var>SetBody</var> method completely replace any

JAL2: /* Examples */

2011-07-25T19:24:26Z

Examples

← Older revision		Revision as of 19:24, 25 July 2011
Line 76:		Line 76:
	...		...
	</p>		</p>
	<li>For <var>SetBody</var> method examples, see [[~~SMTP Helper~~#Basic e-mail\|"Basic e-mail"]] and		<li>For <var>SetBody</var> method examples, see [[Email class#Basic e-mail\|"Basic e-mail"]] and
	[[~~SMTP Helper~~#E-mail with attachment\|"E-mail with attachment"]].		[[Email class#E-mail with attachment\|"E-mail with attachment"]].
	</ul>		</ul>

	==See also==		==See also==
	{{Template:Email:SetBody footer}}		{{Template:Email:SetBody footer}}

JAL2 at 19:53, 6 July 2011

2011-07-06T19:53:50Z

← Older revision		Revision as of 19:53, 6 July 2011
Line 1:		Line 1:
	{{Template:Email:SetBody subtitle}}		{{Template:Email:SetBody subtitle}}

	~~This callable method allows you to add content to the body of an SMTP message.~~
	==Syntax==		==Syntax==
	{{Template:Email:SetBody syntax}}		{{Template:Email:SetBody syntax}}
Line 37:		Line 36:
	the <var>Encoding</var> option set to the value <code>none</code>.		the <var>Encoding</var> option set to the value <code>none</code>.
	<dt><b>Encoding</b>		<dt><b>Encoding</b>
	<dd>This ~~[[Notation conventions for methods#Name required\|~~name required]] parameter		<dd>This name required parameter
	forces or suppresses encoding for the attachment.		forces or suppresses encoding for the attachment.
	Since base64 encoding is automatically enabled for any non-text content,		Since base64 encoding is automatically enabled for any non-text content,
Line 57:		Line 56:

	==Usage notes==		==Usage notes==

	Subsequent invocations of the <var>SetBody</var> method completely replace any		Subsequent invocations of the <var>SetBody</var> method completely replace any
	existing content.		existing content.
	~~<br>~~
	==Examples==		==Examples==
	<ul>		<ul>
	<li>The following code fragment adds HTML text to the to the body of an		<li>The following code fragment adds HTML text to the to the body of an
	SMTP message:		SMTP message:
	<p class="code"> ...		<p class="code"> ...
	%greet is object Email		%greet is object Email
	%sl is object Stringlist		%sl is object Stringlist
	html to %sl		html to %sl
	<html>		<html>
	<h1>		<nowiki><h1>
	Hello world!		Hello world!
	</h1>		</h1></nowiki>
	</html>		</html>
	end html		end html
	%greet:SetBody(%sl, type='text/html')		%greet:SetBody(%sl, type='text/html')
	...		...
	</p>		</p>
	<li>For <var>SetBody</var> method examples, see [[SMTP Helper#Basic e-mail\|"Basic e-mail"]] and		<li>For <var>SetBody</var> method examples, see [[SMTP Helper#Basic e-mail\|"Basic e-mail"]] and

JALWiccan: 1 revision

2011-07-05T21:41:05Z

1 revision

← Older revision	Revision as of 21:41, 5 July 2011
(No difference)

JAL2: Created page with "This callable method allows you to add content to the body of an SMTP message. ==SetBody syntax==
%email:SetBody(content, [options])
===Syntax terms===
2011-07-05T21:41:03Z

Created page with "This callable method allows you to add content to the body of an SMTP message. ==SetBody syntax== <p class="pre"> %email:SetBody(content, [options]) </p> ===Syntax terms=== <ta..."

← Older revision Revision as of 21:41, 5 July 2011
Line 1: Line 1:

{{Template:Email:SetBody subtitle}}

This callable method allows you to add content to the body of an SMTP message.
This callable method allows you to add content to the body of an SMTP message.

==SetBody syntax==
==Syntax==

<p class="pre"> %email:SetBody(content, [options])
{{Template:Email:SetBody syntax}}

</p>

===Syntax terms===
===Syntax terms===

<table class="syntaxTable">
<table class="syntaxTable">

Line 31: Line 31:

<var>SetBody</var> performs no validity checking, but it does distinguish
<var>SetBody</var> performs no validity checking, but it does distinguish

between text MIME types (“text” is the primary type) and non-text types.
between text MIME types (&ldquo;text&rdquo; is the primary type) and non-text types.

If non-text, <var>SetBody</var> encodes the content in base64 format
If non-text, <var>SetBody</var> encodes the content in base64 format

to ensure correct translation at SMTP gateways.
to ensure correct translation at SMTP gateways.

Line 56: Line 56:

</td></tr></table>
</td></tr></table>

==Usage Notes==
==Usage notes==

Subsequent invocations of the <var>SetBody</var> method completely replace any
Subsequent invocations of the <var>SetBody</var> method completely replace any

Line 81: Line 81:

[[SMTP Helper#E-mail with attachment|"E-mail with attachment"]].
[[SMTP Helper#E-mail with attachment|"E-mail with attachment"]].

</ul>
</ul>

==See also==

{{Template:Email:SetBody footer}}

JAL2: Created page with "This callable method allows you to add content to the body of an SMTP message. ==SetBody syntax==
%email:SetBody(content, [options])
===Syntax terms===
2011-07-05T21:39:01Z

Created page with "This callable method allows you to add content to the body of an SMTP message. ==SetBody syntax== <p class="pre"> %email:SetBody(content, [options]) </p> ===Syntax terms=== <ta..."

New page
This callable method allows you to add content to the body of an SMTP message.
==SetBody syntax==
<p class="pre"> %email:SetBody(content, [options])
</p>

===Syntax terms===
<table class="syntaxTable">
<tr><th>%email</th>
<td>A previously declared <var>Email</var> object.
</td></tr>
<tr><th>content</th>
<td>A <var>Stringlist</var> or <var>Longstring</var> that contains the actual e-mail body.

If a <var>Stringlist</var> is passed, each item in the <var>Stringlist</var> is delimited
with a carriage-return/line-feed (CR/LF) character pair.
To override this line-ending, you can specify a non-text content type
as the value of the <var>Type</var> optional argument.
In this case, no delimiter is added at the end of an item.

If a longstring is passed, no delimiters are added to the content.
</td></tr>
<tr><th>options</th>
<td>Any combination of the following options. Each may be specified only once.
<dl>
<dt><b>Type</b>
<dd>This [[Notation conventions for methods#Name required|name required]] parameter
specifies the MIME type of the content.
MIME content type strings consist
of a primary type and a subtype delimited by a forward slash ( / ) character,
for example, <code>text/xml</code>.

<var>SetBody</var> performs no validity checking, but it does distinguish
between text MIME types (“text” is the primary type) and non-text types.
If non-text, <var>SetBody</var> encodes the content in base64 format
to ensure correct translation at SMTP gateways.
You can override this encoding by specifying
the <var>Encoding</var> option set to the value <code>none</code>.
<dt><b>Encoding</b>
<dd>This [[Notation conventions for methods#Name required|name required]] parameter
forces or suppresses encoding for the attachment.
Since base64 encoding is automatically enabled for any non-text content,
the <var>Encoding</var> option is usually unnecessary.
To enable base64 encoding for text content, specify <code>encoding=base64</code>.
To disable encoding for non-text content, specify <code>encoding=none</code>.

Specifying <code>encoding=none</code> for non-text content is
not recommended: the likely result is that the recipient receives corrupt data,
or otherwise the SMTP gateway may simply discard the message.
<dt><b>Name</b>
<dd>This name required parameter provides a name for the
message body or a message part.
This option is rarely used for the mail body, and it is usually ignored
by the mail client.
It is most often used for attachments, which are added with <var>[[AddPart (Email subroutine)|AddPart]]</var>.
</dl>
</td></tr></table>

==Usage Notes==

Subsequent invocations of the <var>SetBody</var> method completely replace any
existing content.
<br>
==Examples==
<ul>
<li>The following code fragment adds HTML text to the to the body of an
SMTP message:
<p class="code"> ...
%greet is object Email
%sl is object Stringlist
html to %sl
<html>
<h1>
Hello world!
</h1>
</html>
end html
%greet:SetBody(%sl, type='text/html')
...
</p>
<li>For <var>SetBody</var> method examples, see [[SMTP Helper#Basic e-mail|"Basic e-mail"]] and
[[SMTP Helper#E-mail with attachment|"E-mail with attachment"]].
</ul>

← Older revision		Revision as of 21:58, 5 March 2012
Line 19:		Line 19:
	If a longstring is passed, no delimiters are added to the content.		If a longstring is passed, no delimiters are added to the content.
	</td></tr>		</td></tr>
	<tr><th>~~options~~</th>		<tr><th>Type</th>
	<td>Any combination of the following options. Each may be specified only once.		<td>Any combination of the following options. Each may be specified only once.
	<dl>		<dl>
	<dt><b>Type</b>		<dt><b>Type</b>
	<dd>This [[Notation conventions for methods#Name required\|name required]] parameter		<td>This [[Notation conventions for methods#Name required\|name required]] parameter
	specifies the MIME type of the content.		specifies the MIME type of the content.
	MIME content type strings consist		MIME content type strings consist
Line 30:		Line 30:

	<var>SetBody</var> performs no validity checking, but it does distinguish		<var>SetBody</var> performs no validity checking, but it does distinguish
	between text MIME types (~~&ldquo;~~text~~&rdquo~~; is the primary type) and non-text types.		between text MIME types ("text"; is the primary type) and non-text types.
	If non-text, <var>SetBody</var> encodes the content in base64 format		If non-text, <var>SetBody</var> encodes the content in base64 format
	to ensure correct translation at SMTP gateways.		to ensure correct translation at SMTP gateways.