RemoveMailRecipient()

Syntax

RemoveMailRecipient(#Mail [, Address$ [, Flags])
Description
Remove a recipient from the specified mail.

Parameters

#Mail The mail to use.
Address$ (optional) The address to remove. It must match an address from a call to AddMailRecipient(). If not specified, all the recipients are removed from the mail.
Flags (optional) The categories from which to remove the recipient. It can be a combination of the following values:
  #PB_Mail_To : Main(s) recipient(s) of the mail
  #PB_Mail_Cc : Recipient(s) which are in copy of the mail (and everybody see it)
  #PB_Mail_Bcc: Recipient(s) which are in copy of the mail (but nobody see it)
If not specified, all the categories are removed for the specified address.

Return value

None.

Example

  If CreateMail(0, "test@purebasic.com", "Hello")
    AddMailRecipient(0, "andre@purebasic.com", #PB_Mail_To) ; Andre is the main recipient
    AddMailRecipient(0, "fred@purebasic.com", #PB_Mail_Cc)  ; Fred is in copy
    AddMailRecipient(0, "timo@purebasic.com", #PB_Mail_Bcc) ; Timo is in copy as well, but Andre and Fred are not aware of it

    ; Ensure Fred is removed from every destination :-)
    RemoveMailRecipient(0, "fred@purebasic.com")
  EndIf

See Also

AddMailRecipient()

Supported OS

All

<- MailProgress() - Mail Index - SendMail() ->