AddHeader (Email subroutine) - Revision history

JAL: /* Usage notes */

2014-09-02T20:57:44Z

Usage notes

← Older revision		Revision as of 20:57, 2 September 2014
Line 20:		Line 20:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>Do ''not'' set "To:" or "Cc:" headers using this method.		<li>Do ''not'' set "To:" or "CC:" headers using this method.
	These headers require special handling and are set using the <var>[[AddRecipient (Email subroutine)\|AddRecipient]]</var> and <var>[[~~AddCc~~ (Email subroutine)\|Add Cc]]</var> methods, respectively.		These headers require special handling and are set using the <var>[[AddRecipient (Email subroutine)\|AddRecipient]]</var> and <var>[[AddCC (Email subroutine)\|Add CC]]</var> methods, respectively.
	The <var>[[Mail (Email function)\|Mail]]</var> method will not recognize recipients added with <var>AddHeader</var>.		The <var>[[Mail (Email function)\|Mail]]</var> method will not recognize recipients added with <var>AddHeader</var>.

Line 34:		Line 34:
	adjusted by the GMT offset specified in the OS system parameters.		adjusted by the GMT offset specified in the OS system parameters.

	<li>For an example that includes this method, see [[Email class#Basic e-mail example\|"Basic e-mail example"]].		<li>For an example that includes this method, see [[Email class#Basic e-mail example\|Basic e-mail example]].
	</ul>		</ul>

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

JAL2 at 20:30, 14 August 2012

2012-08-14T20:30:53Z

← Older revision		Revision as of 20:30, 14 August 2012
Line 3:		Line 3:
	==Syntax==		==Syntax==
	{{Template:Email:AddHeader syntax}}		{{Template:Email:AddHeader 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>header</th>		<tr><th>header</th>
	<td>A string expression that names an SMTP request		<td>A string expression that names an SMTP request header, such as "Reply-To:" or "In-Reply-To:". Header names are case insensitive, but they should have a trailing colon.
	header, such as "Reply-To:" or "In-Reply-To:".		<p>
	Header names are case insensitive but should have a trailing colon.		Passing multiple occurrences is allowed: if a like-named header is already present, an additional occurrence is added.</p></td></tr>

	Passing multiple occurrences is allowed:
	if a like-named header is already present, an additional
	occurrence is added.
	</td></tr>
	<tr><th>value</th>		<tr><th>value</th>
	<td>A string expression that yields a value for the		<td>A string expression that yields a value for the request header.</td></tr>
	request header.		</table>

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

	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>Do ''not'' set "To:" or "Cc:" headers using this method.		<li>Do ''not'' set "To:" or "Cc:" headers using this method.
	These headers require special handling and are set using the AddRecipient and AddCc methods, respectively.		These headers require special handling and are set using the <var>[[AddRecipient (Email subroutine)\|AddRecipient]]</var> and <var>[[AddCc (Email subroutine)\|Add Cc]]</var> methods, respectively.
	The Mail method will not recognize recipients added with AddHeader.		The <var>[[Mail (Email function)\|Mail]]</var> method will not recognize recipients added with <var>AddHeader</var>.

	<li>Do ''not'' set Content-Type headers using this method.		<li>Do ''not'' set Content-Type headers using this method.
	These headers require special handling and are set using parameters on		These headers require special handling and are set using parameters on
	the SetBody and AddPart methods.		the <var>[[SetBody (Email subroutine)\|SetBody]]</var> and <var>[[AddPart (Email subroutine)\|AddPart]]</var> methods.
	Specifying a header that has a "Content-" prefix causes a request cancellation.		Specifying a header that has a "Content-" prefix causes a request cancellation.
	<li>The SMTP Helper adds a "Date:" header to an Email object instance by default if you do not explicitly add one with AddHeader.
			<li>The SMTP Helper adds a "Date:" header to an <var>Email</var> object instance by default if you do not explicitly add one with <var>AddHeader</var>.
	If a Date header is present at the time the mail method is invoked, it is left intact.		If a Date header is present at the time the mail method is invoked, it is left intact.
	The Date header generated by the SMTP Helper uses the system clock (usually GMT),		The Date header generated by the SMTP Helper uses the system clock (usually GMT),
	adjusted by the GMT offset specified in the OS system parameters.		adjusted by the GMT offset specified in the OS system parameters.
	<li>For an example that includes this method, see [[Email class#Basic e-mail\|"Basic e-mail"]].
			<li>For an example that includes this method, see [[Email class#Basic e-mail example\|"Basic e-mail example"]].
	</ul>		</ul>

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

JAL2: /* Syntax terms */

2012-03-05T21:41:34Z

Syntax terms

← Older revision		Revision as of 21:41, 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>

Alex: /* Usage notes */

2011-09-09T13:17:55Z

Usage notes

← Older revision		Revision as of 13:17, 9 September 2011
Line 25:		Line 25:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>Do ''not'' set ~~&ldquo;~~To:~~&rdquo;~~ or ~~&ldquo;~~Cc:~~&rdquo;~~ headers using this method.		<li>Do ''not'' set "To:" or "Cc:" headers using this method.
	These headers		These headers require special handling and are set using the AddRecipient and AddCc methods, respectively.
	require special handling and are set using the AddRecipient and AddCc
	methods, respectively.
	The Mail method will not recognize recipients added with AddHeader.		The Mail method will not recognize recipients added with AddHeader.
	<li>Do ''not'' set Content-Type headers using this method.		<li>Do ''not'' set Content-Type headers using this method.
	These headers require special handling and are set using parameters on		These headers require special handling and are set using parameters on
	the SetBody and AddPart methods.		the SetBody and AddPart methods.
	Specifying a header that has a ~~&ldquo;~~Content-~~&rdquo;~~ prefix causes a request cancellation.		Specifying a header that has a "Content-" prefix causes a request cancellation.
	<li>The SMTP Helper adds a ~~&ldquo;~~Date:~~&rdquo;~~ header to an Email object instance by default		<li>The SMTP Helper adds a "Date:" header to an Email object instance by default if you do not explicitly add one with AddHeader.
	if you do not explicitly add one with AddHeader.		If a Date header is present at the time the mail method is invoked, it is left intact.
	If a Date header is present at the time the mail method is invoked,
	it is left intact.
	The Date header generated by the SMTP Helper uses the system clock (usually GMT),		The Date header generated by the SMTP Helper uses the system clock (usually GMT),
	adjusted by the GMT offset specified in the OS system parameters.		adjusted by the GMT offset specified in the OS system parameters.

Alex: /* Syntax terms */

2011-09-09T13:16:22Z

Syntax terms

← Older revision		Revision as of 13:16, 9 September 2011
Line 10:		Line 10:
	<tr><th>header</th>		<tr><th>header</th>
	<td>A string expression that names an SMTP request		<td>A string expression that names an SMTP request
	header, such as "Reply-To" or "In-Reply-To".		header, such as "Reply-To:" or "In-Reply-To:".
	Header names are case insensitive.		Header names are case insensitive but should have a trailing colon.

	Passing multiple occurrences is allowed:		Passing multiple occurrences is allowed:

Alex: /* Syntax terms */

2011-09-09T13:11:45Z

Syntax terms

← Older revision		Revision as of 13:11, 9 September 2011
Line 10:		Line 10:
	<tr><th>header</th>		<tr><th>header</th>
	<td>A string expression that names an SMTP request		<td>A string expression that names an SMTP request
	header, such as ~~&ldquo;~~Reply-To~~&rdquo;~~ or ~~&ldquo;~~In-Reply-To.~~&rdquo;~~		header, such as "Reply-To" or "In-Reply-To".
	Header names are case insensitive.		Header names are case insensitive.

Line 22:		Line 22:

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

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

JAL2: /* Usage notes */

2011-07-25T19:26:29Z

Usage notes

← Older revision		Revision as of 19:26, 25 July 2011
Line 39:		Line 39:
	The Date header generated by the SMTP Helper uses the system clock (usually GMT),		The Date header generated by the SMTP Helper uses the system clock (usually GMT),
	adjusted by the GMT offset specified in the OS system parameters.		adjusted by the GMT offset specified in the OS system parameters.
	<li>For an example that includes this method, see [[~~SMTP Helper~~#Basic e-mail\|"Basic e-mail"]].		<li>For an example that includes this method, see [[Email class#Basic e-mail\|"Basic e-mail"]].
	</ul>		</ul>

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

JAL2 at 19:36, 6 July 2011

2011-07-06T19:36:27Z

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

	~~This callable method lets you add an SMTP request header~~
	~~to the SMTP request that is sent to the server.~~
	==Syntax==		==Syntax==
	{{Template:Email:AddHeader syntax}}		{{Template:Email:AddHeader 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 lets you add an SMTP request header to the SMTP request that is sent to the server. ==AddHeader syntax==
%email:AddHeader(header, value)
..."

2011-07-05T21:41:03Z

Created page with "This callable method lets you add an SMTP request header to the SMTP request that is sent to the server. ==AddHeader syntax== <p class="pre"> %email:AddHeader(header, value) </p>..."

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

	This callable method lets you add an SMTP request header		This callable method lets you add an SMTP request header
	to the SMTP request that is sent to the server.		to the SMTP request that is sent to the server.
	==~~AddHeader syntax~~==		==Syntax==
	~~<p class="pre"> %email~~:AddHeader~~(header, value)~~		{{Template:Email:AddHeader syntax}}
	~~</p>~~

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
Line 12:		Line 12:
	<tr><th>header</th>		<tr><th>header</th>
	<td>A string expression that names an SMTP request		<td>A string expression that names an SMTP request
	header, such as “Reply-To” or “In-Reply-To.”		header, such as &ldquo;Reply-To&rdquo; or &ldquo;In-Reply-To.&rdquo;
	Header names are case insensitive.		Header names are case insensitive.

Line 24:		Line 24:

	</td></tr></table>		</td></tr></table>
	==Usage ~~Notes~~==		==Usage notes==
	<ul>		<ul>
	<li>Do ''not'' set “To:” or “Cc:” headers using this method.		<li>Do ''not'' set &ldquo;To:&rdquo; or &ldquo;Cc:&rdquo; headers using this method.
	These headers		These headers
	require special handling and are set using the AddRecipient and AddCc		require special handling and are set using the AddRecipient and AddCc
Line 34:		Line 34:
	These headers require special handling and are set using parameters on		These headers require special handling and are set using parameters on
	the SetBody and AddPart methods.		the SetBody and AddPart methods.
	Specifying a header that has a “Content-” prefix causes a request cancellation.		Specifying a header that has a &ldquo;Content-&rdquo; prefix causes a request cancellation.
	<li>The SMTP Helper adds a “Date:” header to an Email object instance by default		<li>The SMTP Helper adds a &ldquo;Date:&rdquo; header to an Email object instance by default
	if you do not explicitly add one with AddHeader.		if you do not explicitly add one with AddHeader.
	If a Date header is present at the time the mail method is invoked,		If a Date header is present at the time the mail method is invoked,
Line 43:		Line 43:
	<li>For an example that includes this method, see [[SMTP Helper#Basic e-mail\|"Basic e-mail"]].		<li>For an example that includes this method, see [[SMTP Helper#Basic e-mail\|"Basic e-mail"]].
	</ul>		</ul>
			==See also==
			{{Template:Email:AddHeader footer}}

AddHeader (Email subroutine) - Revision history

JAL: /* Usage notes */

JAL2 at 20:30, 14 August 2012

JAL2: /* Syntax terms */

Alex: /* Usage notes */

Alex: /* Syntax terms */

Alex: /* Syntax terms */

JAL2: /* Usage notes */

JAL2 at 19:36, 6 July 2011

JALWiccan: 1 revision

JAL2: Created page with "This callable method lets you add an SMTP request header to the SMTP request that is sent to the server. ==AddHeader syntax== %email:AddHeader(header, value) ..."

JAL2: Created page with "This callable method lets you add an SMTP request header to the SMTP request that is sent to the server. ==AddHeader syntax==
%email:AddHeader(header, value)
..."