Delete Method (Recipient Object)
Delete Method (Recipient Object)
The Delete method removes the Recipient object from the Recipients collection.
Syntax
objRecipient.Delete( )
Remarks
The Delete method performs an irreversible operation on the collection. It calls Release on the collections reference to the Recipient object. If you have another reference to the recipient, you can still access its properties and methods, but you can never again associate it with any collection because the Add method always creates a new object. You should Set your reference variable either to Nothing or to another recipient.
The final Release on the Recipient object takes place when you assign your reference variable to Nothing, or when you call Delete if you had no other reference. At this point the object is removed from memory. Attempted access to a released object results in an error return of CdoE_INVALID_OBJECT.
When you delete a member of a collection, the collection is immediately refreshed, meaning that its Count property is reduced by one and its members are reindexed. To access a member following the deleted member, you must use its new index value. For more information, see Looping Through a Collection.
The effect of the Delete operation is not permanent until you use the Update, Send, or Delete method on the Message object to which this recipient belongs.
The immediate parent of this Recipient object is a Recipients collection, which is a child of the message. You can delete all the messages recipients by calling the collections Delete method.
Example
This code fragment illustrates the two situations previously explained. The Set statement calls AddRef on the first Recipient object. That reference survives the call to Delete and has to be reassigned. The second Recipient object is deleted without creating another reference, and no other action is necessary.
' assume valid Message object
Set objRecipient = objMessage.Recipients.Item(1)
objRecipient.Delete ' still have a reference from Set statement
' ... other operations on objRecipient possible but pointless ...
Set objRecipient = Nothing ' necessary to remove reference
' ...
objMessage.Recipients.Item(2).Delete ' no reference to remove