vbMAPI Outlook/MAPI Code Library
(v1.16.0)

ref: vbMAPI_Recipient

On this page you'll find:

Overview

Equivalent MAPI object: ADRENTRY structure
Equivalent Outlook Redemption object: Redemption.RDORecipient
Equivalent Outlook Object Model object: Outlook.Recipient
Parent: vbMAPI_Recipients

Class Description

This object represents a recipient of a message.


Property Get Name() As String

Property Let Name(ByVal RetVal As String)

Returns/sets the value of MAPI property PR_DISPLAY_NAME for this recipient.

Property Get EmailAddress() As String

Property Let EmailAddress(ByVal RetVal As String)

Returns/sets the value of MAPI property PR_EMAIL_ADDRESS for this recipient.

Property Get EntryID() As String

Property Let EntryID(ByVal RetVal As String)

Returns the value of MAPI property PR_ENTRYID for this recipient.

Property Get RecipientType() As EnumRecipientType

Property Let RecipientType(ByVal RetVal As EnumRecipientType)

Returns/sets the value of MAPI property PR_RECIPIENT_TYPE for this recipient.

Property Get AddressType() As String

Property Let AddressType(ByVal RetVal As String)

Returns/sets the value of MAPI property PR_ADDRTYPE for this recipient.

Property Get Flags() As Long

Property Let Flags(ByVal RetVal As Long)

Returns/sets the value of MAPI property PR_RECIPIENT_FLAGS for this recipient.

Property Get ObjectType() As Long

Property Let ObjectType(ByVal RetVal As Long)

Returns the value of the MAPI property PR_OBJECT_TYPE from this address entry.

Property Get SearchKey() As String

Returns the value of MAPI property PR_SEARCH_KEY for this recipient.

Property Get DisplayType() As EnumAddressDisplayType

Property Let DisplayType(ByVal RetVal As EnumAddressDisplayType)

Returns the value of the MAPI property PR_DISPLAY_TYPE from this recipient.

Property Get SendRichInfo() As Boolean

Property Let SendRichInfo(ByVal Value As Boolean)

Returns/sets the value of MAPI property PR_SEND_RICH_INFO (and MAPI_ONE_OFF_NO_RICH_INFO) for this recipient.

Sub Delete()

Deletes this recipient from the parent recipients collection.  Further access to this object after deletion will throw an exception.

Property Get IsResolved() As Boolean

Determines whether this recipient is resolved or not.  Resolved recipients have a valid EntryID.

Messages cannot be sent to unresolved recipients, although vbMAPI will attempt to auto-resolve recipients based on your global vbMAPI_Session::Options (vbMAPI_Options) settings.

Function Resolve(Optional ByVal ShowDialog As Boolean = True, _
              Optional ByVal ParentWndHandle As Long) As Boolean

Manually attempts to resolve a recipient.  Returns True only if this recipient resolved successfully.

ShowDialog: determines whether you want to allow MAPI/Outlook to prompt for user input to help resolve a recipient.

Sub ResolveOneOff()

For SMTP Email addresses only.  Manually resolves the recipient to a MAPI one-off SMTP address without using the address book.

Property Get Session() As vbMAPI_Session

Returns the session object associated with this object.

Property Get AddressEntry() As vbMAPI_AddressEntry

Returns the vbMAPI_AddressEntry object that this recipient has been resolved to.