AddBCC (Email subroutine): Difference between revisions
Jump to navigation
Jump to search
m (Created page with "This callable method allows you to add an SMTP mail recipient to the SMTP request that is sent to the server. ==AddBcc syntax== <p class="pre"> %email:AddBcc(name, [nickname]) </...") |
m (→Usage notes) |
||
| (10 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Email:AddBCC subtitle}} | {{Template:Email:AddBCC subtitle}} | ||
==Syntax== | ==Syntax== | ||
{{Template:Email:AddBCC syntax}} | {{Template:Email:AddBCC syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th> | <tr><th>email</th> | ||
<td>A previously declared Email object. | <td>A previously declared <var>Email</var> object.</td></tr> | ||
</td></tr> | |||
<tr><th>name</th> | <tr><th>name</th> | ||
<td>A string expression that contains an | <td>A string expression that contains an e-mail address: | ||
a userid, followed by an at sign (@), followed by a domain name. | a userid, followed by an at sign (@), followed by a domain name.</td></tr> | ||
</td></tr> | |||
<tr><th>nickname</th> | <tr><th>nickname</th> | ||
<td>An optional string expression that contains a familiar name associated | <td>An optional string expression that contains a familiar name associated with the e-mail address. | ||
with the e-mail address. | For <var>AddBcc</var>, this parameter is superfluous, but it is provided for compatibility with <var>[[AddRecipient (Email subroutine)|AddRecipient]]</var> and <var>[[Mail (Email function)|Mail]]</var>.</td></tr> | ||
For AddBcc, this parameter is superfluous, but it is provided | </table> | ||
for compatibility with <var>[[AddRecipient (Email subroutine)|AddRecipient]]</var> and | |||
<var>[[Mail (Email function)|Mail]]</var>. | |||
</td></tr></table> | |||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
| Line 29: | Line 24: | ||
by some mail servers. | by some mail servers. | ||
The recipient count is the sum of all e-mail addresses added with the <var>AddBcc</var>, | The recipient count is the sum of all e-mail addresses added with the <var>AddBcc</var>, | ||
<var>[[ | <var>[[AddCC (Email subroutine)|AddCC]]</var>, and <var>AddRecipient</var> methods. | ||
<li>Recipients added with the <var> | |||
the | <li>Recipients added with the <var>AddBCC</var> method do not appear in either | ||
<li>The optional | the "To:" or "CC:" headers in the e-mail message. | ||
<li>The optional <var class="term">nickname</var> parameter is provided only for | |||
compatibility with the <var>AddRecipient</var> and <var>Mail</var> methods. | compatibility with the <var>AddRecipient</var> and <var>Mail</var> methods. | ||
It is not sent as part of the e-mail message. | It is not sent as part of the e-mail message. | ||
<li>For an example that includes this method, see [[ | |||
<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:AddBCC footer}} | {{Template:Email:AddBCC footer}} | ||
Latest revision as of 20:56, 2 September 2014
Add a BCCd mail recipient (Email class)
Syntax
email:AddBCC( name, [nickname])
Syntax terms
| A previously declared Email object. | |
| name | A string expression that contains an e-mail address: a userid, followed by an at sign (@), followed by a domain name. |
| nickname | An optional string expression that contains a familiar name associated with the e-mail address. For AddBcc, this parameter is superfluous, but it is provided for compatibility with AddRecipient and Mail. |
Usage notes
- Mail servers should be able to accept as many as 100 or more distinct recipients for a single mail message, though stricter limits may be imposed by some mail servers. The recipient count is the sum of all e-mail addresses added with the AddBcc, AddCC, and AddRecipient methods.
- Recipients added with the AddBCC method do not appear in either the "To:" or "CC:" headers in the e-mail message.
- The optional nickname parameter is provided only for compatibility with the AddRecipient and Mail methods. It is not sent as part of the e-mail message.
- For an example that includes this method, see Basic e-mail example.