RemoveRecipient (Email function): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
m (→Examples) |
||
| (8 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Email:RemoveRecipient subtitle}} | {{Template:Email:RemoveRecipient subtitle}} | ||
This | This [[Notation conventions for methods#Callable functions|callable]] method removes a specified name from the <code>To:</code>, <code>CC:</code>, and <code>BCC:</code> lists of recipients of the <var>Email</var> object. | ||
==Syntax== | ==Syntax== | ||
{{Template:Email:RemoveRecipient syntax}} | {{Template:Email:RemoveRecipient syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%number</th><td> | <tr><th>%number</th> | ||
<td>A numeric variable to contain an indicator of the success of the method operation.</td></tr> | |||
<tr><th>email</th> | <tr><th>email</th> | ||
<td>An <var>Email</var> object.</td></tr> | <td>An <var>Email</var> object.</td></tr> | ||
<tr><th>string</th> | <tr><th>string</th> | ||
<td>string< | <td>A string expression that contains the email address to be removed: a userid, followed by an at sign (<tt>@</tt>), followed by a domain name.</td></tr> | ||
</table> | </table> | ||
==See also== | ==See also== | ||
{{Template:Email:RemoveRecipient footer}} | {{Template:Email:RemoveRecipient footer}} | ||
Latest revision as of 21:46, 14 August 2012
Remove a mail recipient (Email class)
[Introduced in Sirius Mods 8.0]
This callable method removes a specified name from the To:, CC:, and BCC: lists of recipients of the Email object.
Syntax
[%number =] email:RemoveRecipient( string)
Syntax terms
| %number | A numeric variable to contain an indicator of the success of the method operation. |
|---|---|
| An Email object. | |
| string | A string expression that contains the email address to be removed: a userid, followed by an at sign (@), followed by a domain name. |