AddPart (Email subroutine) - Revision history

JAL2 at 21:00, 14 August 2012

2012-08-14T21:00:29Z

← Older revision		Revision as of 21:00, 14 August 2012
Line 3:		Line 3:
	==Syntax==		==Syntax==
	{{Template:Email:AddPart syntax}}		{{Template:Email:AddPart syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>email</th>		<tr><th>email</th>
	<td>~~A previously declared~~ Email object.		<td>An <var>Email</var> object.</td></tr>
	</td></tr>
	<tr><th>content</th>		<tr><th>content</th>
	<td>A Stringlist or ~~longstring~~ that contains the attachment or body part.		<td>A <var>Stringlist</var> or <var>Longstring</var> that contains the attachment or body part.

	If a Stringlist is passed, each item in the Stringlist is delimited		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.		with a carriage-return/line-feed (CR/LF) character pair.
	To override this line-ending, you can specify a non-text content type		To override this line-ending, you can specify a non-text content type
	as the value of the <~~code~~>~~type~~</~~code~~> optional argument, described below.		as the value of the <var>Type</var> optional argument, described below.
	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>~~options~~<~~/th~~>		<tr><th><var>Type</var></th>
	<td>~~Any comma-separated combination of the following options.~~		<td>This [[Notation conventions for methods#Named parameters\|name required]] parameter is a string that 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>.
	~~Each may be specified only once.~~		<p>
	<dl>		<var>AddPart</var> performs no validity checking, but it does distinguish
	<~~dt>Type~~		between text MIME types ("text" is the primary type) and non-text types.
	~~<dd~~>This [[Notation conventions for methods#~~Name required~~ parameters\|name required]] parameter is a string		If non-text, <var>AddPart</var> encodes the content in base64 format to ensure correct translation at SMTP gateways.
	that specifies the MIME type of the content.		You can override this encoding by specifying the <var>Encoding</var> option set to the value <var>None</var>. </p></td></tr>
	MIME content type strings consist
	of a primary type and a subtype delimited by a forward slash ( / ) character,		<tr><th><var>Encoding</var></th>
	for example, <code>text/xml</code>.		<td>This [[Notation conventions for methods#Name required parameters\|name required]] parameter is a string that forces or suppresses encoding for the attachment.

	AddPart performs no validity checking, but it does distinguish
	between text MIME types (~~&ldquo;~~text~~&rdquo;~~ is the primary type) and non-text types.
	If non-text, AddPart 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>Encoding
	<dd>This [[Notation conventions for methods#Name required parameters\|name required]] parameter is a string
	that 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,
	the <var>Encoding</var> option is usually unnecessary.		the <var>Encoding</var> option is usually unnecessary.
Line 47:		Line 38:
	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.
	<dt>Name
	<dd>This name required parameter is a string that		<tr><th><var>Name</var></th>
	provides a name for the attachment.		<td>This name required parameter is a string that provides a name for the attachment. The name is used when saving the attachment to a file.
	The name is used when saving the attachment to a file.
	<dt>Disposition		<tr><th><var>Disposition</var></th>
	<dd>This name required parameter, available as of <var class="product">Sirius Mods</var> version 7.6,		<td>This name required parameter, available as of <var class="product">Sirius Mods</var> version 7.6, provides a content-disposition header for the attachment. If you do not specify a disposition value, no content-disposition header is provided for the attachment.
	provides a content-disposition header for the attachment.
	If you do not specify a disposition value, no content-disposition header
	is provided for the attachment.

	The method does no validity checking for the		The method does no validity checking for the content-disposition, so you can specify whatever disposition you want.
	content-disposition, so you can specify whatever disposition you want.
	<dt>Description		<tr><th><var>Description</var></th>
	<dd>This name required parameter, available as of <var class="product">Sirius Mods</var> version 7.6,		<td>This name required parameter, available as of <var class="product">Sirius Mods</var> version 7.6, is a string that provides a content-description header for the attachment. If you do not specify a description value, no content-description header is provided for the attachment.</td></tr>
	is a string that provides a content-description header for the attachment.		</table>
	If you do not specify a description value, no content-description header
	is provided for the attachment.

	~~</dl>~~
	</td></tr></table>

	==Usage notes==		==Usage notes==
Line 72:		Line 55:
	<li>Subsequent invocations of the <var>AddPart</var> method add a separate attachment		<li>Subsequent invocations of the <var>AddPart</var> method add a separate attachment
	to the existing content.		to the existing content.

	<li>For a code example that includes the addition of an attachment,		<li>For a code example that includes the addition of an attachment,
	see [[Email class#E-mail with attachment\|"E-mail with attachment"]].		see [[Email class#E-mail with attachment\|"E-mail with attachment"]].

JAL2: /* Syntax terms */

2012-03-05T21:42:40Z

Syntax terms

← Older revision		Revision as of 21:42, 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 Email object.		<td>A previously declared Email object.
	</td></tr>		</td></tr>
Line 67:		Line 67:
	</dl>		</dl>
	</td></tr></table>		</td></tr></table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>

JAL2: /* Usage notes */

2011-07-25T19:26:00Z

Usage notes

← Older revision		Revision as of 19:26, 25 July 2011
Line 73:		Line 73:
	to the existing content.		to the existing content.
	<li>For a code example that includes the addition of an attachment,		<li>For a code example that includes the addition of an attachment,
	see [[~~SMTP Helper~~#E-mail with attachment\|"E-mail with attachment"]].		see [[Email class#E-mail with attachment\|"E-mail with attachment"]].
	</ul>		</ul>

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

JAL2 at 19:38, 6 July 2011

2011-07-06T19:38:00Z

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

	~~This callable method allows you to add one or more attachments to the~~
	~~body of an SMTP message.~~
	==Syntax==		==Syntax==
	{{Template:Email:AddPart syntax}}		{{Template:Email:AddPart syntax}}

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 one or more attachments to the body of an SMTP message. ==AddPart syntax==
%email:AddPart(content, [options])
===Syn..."

2011-07-05T21:41:03Z

Created page with "This callable method allows you to add one or more attachments to the body of an SMTP message. ==AddPart syntax== <p class="pre"> %email:AddPart(content, [options]) </p> ===Syn..."

← Older revision		Revision as of 21:41, 5 July 2011
Line 1:		Line 1:
			{{Template:Email:AddPart subtitle}}

	This callable method allows you to add one or more attachments to the		This callable method allows you to add one or more attachments to the
	body of an SMTP message.		body of an SMTP message.
	==~~AddPart syntax~~==		==Syntax==
	~~<p class="pre"> %email~~:AddPart~~(content, [options])~~		{{Template:Email:AddPart syntax}}
	~~</p>~~

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
Line 33:		Line 33:

	AddPart performs no validity checking, but it does distinguish		AddPart 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, AddPart encodes the content in base64 format		If non-text, AddPart encodes the content in base64 format
	to ensure correct translation at SMTP gateways.		to ensure correct translation at SMTP gateways.
Line 70:		Line 70:
	</td></tr></table>		</td></tr></table>

	==Usage ~~Notes~~==		==Usage notes==
	<ul>		<ul>
	<li>Subsequent invocations of the <var>AddPart</var> method add a separate attachment		<li>Subsequent invocations of the <var>AddPart</var> method add a separate attachment
Line 77:		Line 77:
	see [[SMTP Helper#E-mail with attachment\|"E-mail with attachment"]].		see [[SMTP Helper#E-mail with attachment\|"E-mail with attachment"]].
	</ul>		</ul>
			==See also==
			{{Template:Email:AddPart footer}}

JAL2: Created page with "This callable method allows you to add one or more attachments to the body of an SMTP message. ==AddPart syntax==
%email:AddPart(content, [options])
===Syn..."

2011-07-05T21:32:01Z

Created page with "This callable method allows you to add one or more attachments to the body of an SMTP message. ==AddPart syntax== <p class="pre"> %email:AddPart(content, [options]) </p> ===Syn..."

New page

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

===Syntax terms===
<table class="syntaxTable">
<tr><th>%email</th>
<td>A previously declared Email object.
</td></tr>
<tr><th>content</th>
<td>A Stringlist or longstring that contains the attachment or body part.

If a Stringlist is passed, each item in the Stringlist 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 <code>type</code> optional argument, described below.
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 comma-separated combination of the following options.
Each may be specified only once.
<dl>
<dt>Type
<dd>This [[Notation conventions for methods#Name required parameters|name required]] parameter is a string
that 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>.

AddPart performs no validity checking, but it does distinguish
between text MIME types (“text” is the primary type) and non-text types.
If non-text, AddPart 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>Encoding
<dd>This [[Notation conventions for methods#Name required parameters|name required]] parameter is a string
that 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>Name
<dd>This name required parameter is a string that
provides a name for the attachment.
The name is used when saving the attachment to a file.
<dt>Disposition
<dd>This name required parameter, available as of <var class="product">Sirius Mods</var> version 7.6,
provides a content-disposition header for the attachment.
If you do not specify a disposition value, no content-disposition header
is provided for the attachment.

The method does no validity checking for the
content-disposition, so you can specify whatever disposition you want.
<dt>Description
<dd>This name required parameter, available as of <var class="product">Sirius Mods</var> version 7.6,
is a string that provides a content-description header for the attachment.
If you do not specify a description value, no content-description header
is provided for the attachment.

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

==Usage Notes==
<ul>
<li>Subsequent invocations of the <var>AddPart</var> method add a separate attachment
to the existing content.
<li>For a code example that includes the addition of an attachment,
see [[SMTP Helper#E-mail with attachment|"E-mail with attachment"]].
</ul>

AddPart (Email subroutine) - Revision history

JAL2 at 21:00, 14 August 2012

JAL2: /* Syntax terms */

JAL2: /* Usage notes */

JAL2 at 19:38, 6 July 2011

JALWiccan: 1 revision

JAL2: Created page with "This callable method allows you to add one or more attachments to the body of an SMTP message. ==AddPart syntax== %email:AddPart(content, [options]) ===Syn..."

JAL2: Created page with "This callable method allows you to add one or more attachments to the body of an SMTP message. ==AddPart syntax== %email:AddPart(content, [options]) ===Syn..."

JAL2: Created page with "This callable method allows you to add one or more attachments to the body of an SMTP message. ==AddPart syntax==
%email:AddPart(content, [options])
===Syn..."

JAL2: Created page with "This callable method allows you to add one or more attachments to the body of an SMTP message. ==AddPart syntax==
%email:AddPart(content, [options])
===Syn..."