🔍 Code Extractor

class MailboxSettings

Maturity: 32

Settings for the primary mailbox of a user.

File:
/tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/outlook/mail/mailbox_settings.py
Lines:
7 - 38
Complexity:
moderate

Purpose

Settings for the primary mailbox of a user.

Source Code

class MailboxSettings(ClientValue):
    """Settings for the primary mailbox of a user."""

    def __init__(
        self,
        time_format=None,
        time_zone=None,
        automatic_replies_setting=AutomaticRepliesSetting(),
        archive_folder=None,
        date_format=None,
        language=LocaleInfo(),
        working_hours=WorkingHours(),
    ):
        """
        :param str time_format: The time format for the user's mailbox.
        :param str time_zone: The default time zone for the user's mailbox.
        :param AutomaticRepliesSetting automatic_replies_setting: 	Configuration settings to automatically notify
            the sender of an incoming email with a message from the signed-in user.
        :param str archive_folder: Folder ID of an archive folder for the user.
        :param str date_format: The date format for the user's mailbox.
        :param LocaleInfo language: The locale information for the user, including the preferred language
            and country/region.
        :param WorkingHours working_hours: The days of the week and hours in a specific time zone that the user works.
        """
        super(MailboxSettings, self).__init__()
        self.timeFormat = time_format
        self.timeZone = time_zone
        self.automaticRepliesSetting = automatic_replies_setting
        self.archiveFolder = archive_folder
        self.dateFormat = date_format
        self.language = language
        self.workingHours = working_hours

Parameters

Name Type Default Kind
bases ClientValue -

Parameter Details

bases: Parameter of type ClientValue

Return Value

Returns unspecified type

Class Interface

Methods

__init__(self, time_format, time_zone, automatic_replies_setting, archive_folder, date_format, language, working_hours)

Purpose: :param str time_format: The time format for the user's mailbox. :param str time_zone: The default time zone for the user's mailbox. :param AutomaticRepliesSetting automatic_replies_setting: Configuration settings to automatically notify the sender of an incoming email with a message from the signed-in user. :param str archive_folder: Folder ID of an archive folder for the user. :param str date_format: The date format for the user's mailbox. :param LocaleInfo language: The locale information for the user, including the preferred language and country/region. :param WorkingHours working_hours: The days of the week and hours in a specific time zone that the user works.

Parameters:

  • time_format: Parameter
  • time_zone: Parameter
  • automatic_replies_setting: Parameter
  • archive_folder: Parameter
  • date_format: Parameter
  • language: Parameter
  • working_hours: Parameter

Returns: None

Required Imports

from office365.outlook.calendar.working_hours import WorkingHours
from office365.outlook.locale_info import LocaleInfo
from office365.outlook.mail.automatic_replies_setting import AutomaticRepliesSetting
from office365.runtime.client_value import ClientValue

Usage Example

# Example usage:
# result = MailboxSettings(bases)

Tags

class mailboxsettings

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class SearchSettings 50.2% similar

    A class that collects and manages all configurable settings related to search operations over connector content in Office 365.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/search/external/search_settings.py

  • class UserSettings 50.0% similar

    A class representing user settings for content discovery in Microsoft Teams, specifically managing shift preferences for scheduling.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/users/settings.py

  • class SearchSetting 49.2% similar

    This object provides the REST operations defined under search settings.

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

  • class CollaborationMailbox 47.1% similar

    A SharePoint entity class representing a collaboration mailbox, which is a specialized mailbox type used for team collaboration in SharePoint Online.

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

  • class OutlookUser 46.5% similar

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

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/outlook/user.py
← Back to Browse