AddRecipient (Email subroutine): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (→Usage notes) |
||
(4 intermediate revisions by one other user not shown) | |||
Line 1: | Line 1: | ||
{{Template:Email:AddRecipient subtitle}} | {{Template:Email:AddRecipient subtitle}} | ||
==Syntax== | ==Syntax== | ||
{{Template:Email:AddRecipient syntax}} | {{Template:Email:AddRecipient syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th> | <tr><th>email</th> | ||
<td> | <td>An <var>Email</var> object.</td></tr> | ||
</td></tr> | |||
<tr><th>name</th> | <tr><th>name</th> | ||
<td>A string expression that contains an email address: | <td>A string expression that contains an email address: a userid, followed by an at sign (<tt>@</tt>), followed by a domain name.</td></tr> | ||
a userid, followed by an at sign (<tt>@</tt>), followed by a domain name. | |||
</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. | |||
</td></tr></table> | </td></tr></table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
Line 26: | Line 22: | ||
by some mail servers. | by some mail servers. | ||
The recipient count is the sum of all e-mail addresses added with the <var>AddRecipient</var>, | The recipient count is the sum of all e-mail addresses added with the <var>AddRecipient</var>, | ||
<var>[[ | <var>[[AddCC (Email subroutine)|AddCC]]</var>, and <var>[[AddBCC (Email subroutine)|AddBCC]]</var> methods. | ||
<li>Recipients added with the <var>AddRecipient</var> method appear in the | </li> | ||
header in the e-mail. | |||
<li>Recipients added with the <var>AddRecipient</var> method appear in the "To:" | |||
header in the e-mail. </li> | |||
</ul> | </ul> | ||
==See also== | ==See also== | ||
{{Template:Email:AddRecipient footer}} | {{Template:Email:AddRecipient footer}} |
Latest revision as of 20:54, 2 September 2014
Add a mail recipient (Email class)
Syntax
email:AddRecipient( name, [nickname])
Syntax terms
An Email object. | |
name | A string expression that contains an email 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. |
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 AddRecipient, AddCC, and AddBCC methods.
- Recipients added with the AddRecipient method appear in the "To:" header in the e-mail.