🔍 Code Extractor

A class representing information about a user in the sending or receiving end of an event, message or group post in Microsoft Office 365 Outlook.

Purpose

The Recipient class encapsulates user information for Office 365 Outlook operations, specifically wrapping an EmailAddress object to represent participants in email communications, calendar events, or group posts. It inherits from ClientValue, making it compatible with the Office 365 API client framework. The class provides convenient instantiation methods and ensures that every recipient has an associated email address.

Source Code

class Recipient(ClientValue):
    """Represents information about a user in the sending or receiving end of an event, message or group post."""

    def __init__(self, email_address=None):
        """
        :param EmailAddress email_address: The recipient's email address.
        """
        if email_address is None:
            email_address = EmailAddress()
        super(Recipient, self).__init__()
        self.emailAddress = email_address

    def __repr__(self):
        return repr(self.emailAddress)

    @staticmethod
    def from_email(value):
        """
        :type value: str or EmailAddress
        """
        if isinstance(value, EmailAddress):
            return Recipient(value)
        else:
            return Recipient(EmailAddress(value))

Parameters

Parameter Details

email_address: An EmailAddress object representing the recipient's email address. If None is provided, a new empty EmailAddress object is automatically created. This parameter allows initialization with an existing EmailAddress instance or defaults to creating a new one.

Return Value

Instantiation returns a Recipient object with an emailAddress attribute. The from_email static method returns a new Recipient instance created from either a string email address or an EmailAddress object. The __repr__ method returns the string representation of the underlying EmailAddress object.

Class Interface

Methods

Attributes

Dependencies

• office365

Required Imports

from office365.outlook.calendar.email_address import EmailAddress
from office365.runtime.client_value import ClientValue

Usage Example

from office365.outlook.calendar.email_address import EmailAddress
from office365.runtime.client_value import ClientValue

# Create a Recipient with a new EmailAddress
recipient1 = Recipient()

# Create a Recipient with an existing EmailAddress object
email_addr = EmailAddress('user@example.com')
recipient2 = Recipient(email_addr)

# Create a Recipient from a string email using the static factory method
recipient3 = Recipient.from_email('another@example.com')

# Create a Recipient from an EmailAddress object using the static factory method
email_obj = EmailAddress('third@example.com')
recipient4 = Recipient.from_email(email_obj)

# Access the email address
print(recipient3.emailAddress)
print(repr(recipient3))

Best Practices

• Use the from_email static method for convenient creation from string email addresses or EmailAddress objects
• The class automatically creates an empty EmailAddress if none is provided, ensuring the emailAddress attribute is always initialized
• This class is designed to work within the Office 365 API framework and inherits from ClientValue for proper serialization
• The __repr__ method delegates to the EmailAddress object, so string representation depends on EmailAddress implementation
• When creating multiple recipients, consider using the from_email factory method for cleaner code
• The class is immutable after construction - to change the email address, create a new Recipient instance

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class EmailAddress 72.7% similar

  A data class representing an email address with an associated display name, inheriting from ClientValue for use in Office 365 API operations.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/outlook/calendar/email_address.py

• class TranslationNotificationRecipient 68.8% similar

  A data class representing a recipient for translation notifications in Office 365, storing the login name of the user who should receive notifications.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/translation/notification_recipient.py

• class AttendeeBase 62.3% similar

  AttendeeBase is a class representing an attendee in a meeting or calendar event, extending the Recipient class with attendee-specific type information.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/outlook/calendar/attendees/base.py

• class TranslationNotificationRecipientCollection 60.3% similar

  A data container class that represents a collection of translation notification recipients grouped by language code.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/translation/notification_recipient.py

• class EventReceiverDefinitionCreationInformation 60.0% similar

  A data class that encapsulates the properties required to create a client-side event receiver definition in SharePoint/Office365.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/eventreceivers/creation_information.py