RemoveRecipient (Email function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Template:Email:RemoveRecipient subtitle}}
{{Template:Email:RemoveRecipient subtitle}}


This page is [[under construction]].
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==
Line 9: Line 9:
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%number</th>
<tr><th>%number</th>
<td>number</td></tr>
<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>
Line 15: Line 15:


<tr><th>string</th>
<tr><th>string</th>
<td>string</td></tr>
<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>
 
<tr><th>string</th>
<td>string<br/>This argument is optional; its default value is [[??]].</td></tr>
</table>
</table>
==Usage notes==
==Examples==


==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.
email 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.

See also