AddBCC (Email subroutine): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
mNo edit summary |
||
| Line 3: | Line 3: | ||
==Syntax== | ==Syntax== | ||
{{Template:Email:AddBCC syntax}} | {{Template:Email:AddBCC 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>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 AddBcc, this parameter is superfluous, but it is provided | For <var>AddBcc</var>, this parameter is superfluous, but it is provided | ||
for compatibility with <var>[[AddRecipient (Email subroutine)|AddRecipient]]</var> and | for compatibility with <var>[[AddRecipient (Email subroutine)|AddRecipient]]</var> and | ||
<var>[[Mail (Email function)|Mail]]</var>. | <var>[[Mail (Email function)|Mail]]</var>.</td></tr> | ||
</td></tr></table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
| Line 28: | Line 28: | ||
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>[[AddCC (Email subroutine)|AddCc]]</var>, and <var>AddRecipient</var> methods. | <var>[[AddCC (Email subroutine)|AddCc]]</var>, and <var>AddRecipient</var> methods. | ||
<li>Recipients added with the <var>AddBcc</var> method do not appear in either | <li>Recipients added with the <var>AddBcc</var> method do not appear in either | ||
the "To:" or "Cc:" headers in the e-mail message. | the "To:" or "Cc:" headers in the e-mail message. | ||
<li>The optional <var class="term">nickname</var> parameter is provided only for | <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 [[Email class#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> | ||
Revision as of 18:42, 14 August 2012
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".