RemoveRecipient (Email function): Difference between revisions
Jump to navigation
Jump to search
m (→Usage notes) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:Email:RemoveRecipient subtitle}} | {{Template:Email:RemoveRecipient subtitle}} | ||
This [[Notation conventions for methods#Callable functions|callable]] method removes a specified name from the | 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== | ||
Revision as of 15:37, 20 July 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. |
Usage notes
- RemoveRecipient is available as of Version 8.0 of the Sirius Mods.