🔍 Code Extractor

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

Purpose

This class models an attendee for Office 365 calendar events and meetings. It extends the Recipient class to add attendee-specific functionality, particularly the type of attendee (required, optional, or resource). It is used in meeting scheduling operations like findMeetingTimes to represent participants with their email addresses and participation requirements.

Source Code

class AttendeeBase(Recipient):
    """The type of attendees."""

    def __init__(self, email_address=None, attendee_type=None):
        """

        :param office365.mail.emailAddress.EmailAddress email_address: Includes the name and SMTP address of the
            attendees
        :param str attendee_type: The type of attendees. The possible values are: required, optional, resource.
            Currently if the attendees is a person, findMeetingTimes always considers the person is of the Required type.
        """
        super(AttendeeBase, self).__init__(email_address)
        self.type = attendee_type

Parameters

Parameter Details

email_address: An EmailAddress object from office365.mail.emailAddress.EmailAddress that contains the name and SMTP address of the attendee. This parameter is optional and can be None during initialization, allowing for later assignment. It is passed to the parent Recipient class constructor.

attendee_type: A string indicating the type of attendee participation. Valid values are 'required', 'optional', or 'resource'. This determines how the attendee's availability is considered in meeting scheduling. For person attendees, findMeetingTimes currently treats them as 'required' type by default. Can be None during initialization.

Return Value

The constructor returns an instance of AttendeeBase. The instance contains an email_address property (inherited from Recipient) and a type attribute representing the attendee type. No methods in this class return values as only the constructor is defined.

Class Interface

Methods

Attributes

Dependencies

• office365

Required Imports

from office365.outlook.mail.recipient import Recipient
from office365.mail.emailAddress import EmailAddress

Usage Example

from office365.outlook.mail.recipient import Recipient
from office365.mail.emailAddress import EmailAddress
from office365.outlook.calendar.attendee_base import AttendeeBase

# Create an email address object
email = EmailAddress()
email.address = 'john.doe@example.com'
email.name = 'John Doe'

# Create an attendee with required participation
attendee = AttendeeBase(email_address=email, attendee_type='required')

# Create an optional attendee
optional_attendee = AttendeeBase(email_address=email, attendee_type='optional')

# Create a resource attendee (e.g., conference room)
room_email = EmailAddress()
room_email.address = 'conference-room-a@example.com'
room_email.name = 'Conference Room A'
resource_attendee = AttendeeBase(email_address=room_email, attendee_type='resource')

# Access attendee properties
print(attendee.type)  # Output: 'required'
print(attendee.email_address.address)  # Output: 'john.doe@example.com'

Best Practices

• Always provide a valid EmailAddress object when creating an AttendeeBase instance for proper identification of the attendee
• Use one of the three valid attendee_type values: 'required', 'optional', or 'resource' to ensure proper meeting scheduling behavior
• Note that findMeetingTimes currently treats person attendees as 'required' type regardless of the specified type
• This class is typically used as part of a larger Office 365 calendar or meeting operation, not in isolation
• The class inherits from Recipient, so all Recipient properties and methods are available on AttendeeBase instances
• Consider the attendee type carefully when scheduling meetings as it affects availability calculations
• Resource attendees (like conference rooms) should be marked with attendee_type='resource' for proper handling

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class Attendee 82.5% similar

  Represents an event attendee in Microsoft Exchange/Office 365, which can be a person or a resource (meeting room, equipment) configured on the Exchange server.

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

• class AttendeeAvailability 69.7% similar

  A data class representing the availability status of an attendee for a calendar event in Microsoft Outlook.

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

• class Recipient 62.3% similar

  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.

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

• class AttachmentBase 61.9% similar

  An abstract base class representing an attachment that can be added to a todoTask, providing properties for attachment metadata such as content type, size, name, and modification timestamp.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/todo/attachments/base.py

• class BookingStaffMemberBase 61.5% similar

  BookingStaffMemberBase is a base class representing a staff member in a booking system, inheriting from Entity.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/booking/staff/member_base.py