🔍 Code Extractor

Represents the Outlook services available to a user, providing access to user-specific Outlook settings, categories, supported languages, and time zones.

Purpose

This class serves as a wrapper for Microsoft Outlook user-related operations within the Office365 API. It extends the Entity base class and provides methods to query supported languages and time zones configured on the user's mailbox server, as well as access to the user's master categories. The class is designed to work within a context-based query system where operations are added to a query queue and executed by the underlying framework.

Source Code

class OutlookUser(Entity):
    """Represents the Outlook services available to a user."""

    def supported_languages(self):
        """
        Get the list of locales and languages that are supported for the user, as configured on the user's
        mailbox server. When setting up an Outlook client, the user selects the preferred language from this supported
        list. You can subsequently get the preferred language by getting the user's mailbox settings.
        """
        return_type = ClientResult(self.context, ClientValueCollection(LocaleInfo))
        qry = FunctionQuery(self, "supportedLanguages", None, return_type)
        self.context.add_query(qry)
        return return_type

    def supported_time_zones(self):
        """
        Get the list of time zones that are supported for the user, as configured on the user's mailbox server.
        You can explicitly specify to have time zones returned in the Windows time zone format or
        Internet Assigned Numbers Authority (IANA) time zone (also known as Olson time zone) format.
        The Windows format is the default.
        When setting up an Outlook client, the user selects the preferred time zone from this supported list.
        You can subsequently get the preferred time zone by getting the user's mailbox settings.
        """
        return_type = ClientResult(
            self.context, ClientValueCollection(TimeZoneInformation)
        )
        qry = FunctionQuery(self, "supportedTimeZones", None, return_type)
        self.context.add_query(qry)
        return return_type

    @property
    def master_categories(self):
        # type: () -> EntityCollection[OutlookCategory]
        """A list of categories defined for the user."""
        return self.properties.get(
            "masterCategories",
            EntityCollection(
                self.context,
                OutlookCategory,
                ResourcePath("masterCategories", self.resource_path),
            ),
        )

    def get_property(self, name, default_value=None):
        if default_value is None:
            property_mapping = {"masterCategories": self.master_categories}
            default_value = property_mapping.get(name, None)
        return super(OutlookUser, self).get_property(name, default_value)

Parameters

Parameter Details

context: The execution context inherited from Entity base class, used for managing API requests and maintaining connection state with the Office365 service

resource_path: The resource path inherited from Entity base class that identifies the specific user resource in the Office365 API hierarchy

Return Value

Instantiation returns an OutlookUser object that represents a specific user's Outlook services. The supported_languages() method returns a ClientResult containing a ClientValueCollection of LocaleInfo objects. The supported_time_zones() method returns a ClientResult containing a ClientValueCollection of TimeZoneInformation objects. The master_categories property returns an EntityCollection of OutlookCategory objects representing the user's defined categories.

Class Interface

Methods

Attributes

Dependencies

• office365

Required Imports

from office365.entity import Entity
from office365.entity_collection import EntityCollection
from office365.outlook.category import OutlookCategory
from office365.outlook.locale_info import LocaleInfo
from office365.outlook.timezone_information import TimeZoneInformation
from office365.runtime.client_result import ClientResult
from office365.runtime.client_value_collection import ClientValueCollection
from office365.runtime.paths.resource_path import ResourcePath
from office365.runtime.queries.function import FunctionQuery

Usage Example

from office365.graph_client import GraphClient
from office365.outlook.user import OutlookUser

# Authenticate and get client
client = GraphClient.with_token(lambda: 'your_access_token')

# Get the current user's Outlook services
outlook_user = client.me.outlook

# Get supported languages
languages_result = outlook_user.supported_languages()
client.execute_query()
for locale in languages_result.value:
    print(f"Language: {locale.display_name}")

# Get supported time zones
timezones_result = outlook_user.supported_time_zones()
client.execute_query()
for tz in timezones_result.value:
    print(f"Time Zone: {tz.display_name}")

# Access master categories
categories = outlook_user.master_categories
client.load(categories)
client.execute_query()
for category in categories:
    print(f"Category: {category.display_name}")

Best Practices

• Always call execute_query() on the context after invoking methods that return ClientResult to actually execute the queued operations
• The class uses lazy loading for properties like master_categories - ensure you load them explicitly if needed
• Methods like supported_languages() and supported_time_zones() add queries to the context queue but don't execute immediately
• The class is designed to be obtained through the Office365 client hierarchy (e.g., client.me.outlook) rather than instantiated directly
• Handle authentication and token refresh appropriately as all operations require valid Office365 credentials
• The get_property method provides a property mapping mechanism - use it when accessing properties dynamically
• Time zones can be returned in Windows or IANA format - Windows format is the default
• Results are wrapped in ClientResult objects which contain the actual data in their 'value' property after query execution

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class OutlookCategory 71.5% similar

  Represents an Outlook category used to group and organize Outlook items such as messages and events in a user's mailbox.

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

• class OutlookItem 67.7% similar

  OutlookItem is a base class representing a Microsoft Outlook item entity with common properties like change tracking, categories, and timestamps.

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

• class WorkingHours 66.5% similar

  Represents a user's working hours configuration including days of the week, start/end times, and timezone for activity and resource planning in Outlook/Microsoft 365.

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

• class MailFolder 59.5% similar

  Represents a mail folder in a user's mailbox (e.g., Inbox, Drafts) that can contain messages, Outlook items, and child folders. Provides methods for folder operations like copying, emptying, and marking messages as read/unread.

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

• class Recipient 58.7% 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