AddHeader (Email subroutine): Difference between revisions
Jump to navigation
Jump to search
m (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>...") |
m (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>...") |
||
| 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. | ||
== | ==Syntax== | ||
{{Template:Email:AddHeader syntax}} | |||
===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 | ==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}} | |||
Revision as of 21:41, 5 July 2011
Add an SMTP request header (Email class)
This callable method lets you add an SMTP request header
to the SMTP request that is sent to the server.
Syntax
email:AddHeader( header, value)
Syntax terms
| A previously declared Email object. | |
| header | A string expression that names an SMTP request
header, such as “Reply-To” or “In-Reply-To.” Header names are case insensitive. Passing multiple occurrences is allowed: if a like-named header is already present, an additional occurrence is added. |
| value | A string expression that yields a value for the
request header. |
Usage notes
- 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. The Mail method will not recognize recipients added with AddHeader.
- Do not set Content-Type headers using this method. These headers require special handling and are set using parameters on the SetBody and AddPart methods. Specifying a header that has a “Content-” prefix causes a request cancellation.
- The SMTP Helper adds a “Date:” header to an Email object instance by default 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. 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.
- For an example that includes this method, see "Basic e-mail".