🔍 Code Extractor

A utility class for SharePoint sharing operations that provides static methods to retrieve user directory information and validate user email addresses.

Purpose

SharingUtility is a specialized Entity class that encapsulates SharePoint sharing-related operations. It provides static utility methods for querying user directory information by email and validating that multiple email addresses belong to the same user. This class is designed to work within the Office365 SharePoint client context and uses service operation queries to interact with SharePoint's sharing APIs.

Source Code

class SharingUtility(Entity):
    """Provides sharing related utility methods."""

    def __init__(self, context):
        super(SharingUtility, self).__init__(context, ResourcePath("SharingUtility"))

    @staticmethod
    def get_user_directory_info_by_email(context, email):
        """
        Get user information by the user’s email address in directory.

        :param str email: The email address of a user.
        :param office365.sharepoint.client_context.ClientContext context: SharePoint client context
        """
        return_type = ClientResult(context, UserDirectoryInfo())
        payload = {"email": email}
        utility = SharingUtility(context)
        qry = ServiceOperationQuery(
            utility, "GetUserDirectoryInfoByEmail", None, payload, None, return_type
        )
        qry.static = True
        context.add_query(qry)
        return return_type

    @staticmethod
    def validate_same_user_emails(context, primary_email, other_email, principal_name):
        """
        Validate the primary email/principal name and other email are of the same user.

        :param str primary_email: User’s primary email address
        :param str other_email: Another email address.
        :param str principal_name: User’s principal name.
        :param office365.sharepoint.client_context.ClientContext context: SharePoint client context
        """
        utility = SharingUtility(context)
        payload = {
            "primaryEmail": primary_email,
            "otherEmail": other_email,
            "principalName": principal_name,
        }
        result = ClientResult(context)
        qry = ServiceOperationQuery(
            utility, "ValidateSameUserEmails", None, payload, None, result
        )
        qry.static = True
        context.add_query(qry)
        return result

Parameters

Parameter Details

context: An instance of office365.sharepoint.client_context.ClientContext that provides the connection and authentication context for SharePoint operations. This is required for all SharePoint API interactions and manages the communication with the SharePoint server.

Return Value

The constructor returns a SharingUtility instance initialized with the provided context and a ResourcePath of 'SharingUtility'. The static methods return ClientResult objects that will contain the query results after execution: get_user_directory_info_by_email returns a ClientResult containing UserDirectoryInfo, and validate_same_user_emails returns a ClientResult with validation results.

Class Interface

Methods

Attributes

Dependencies

• office365

Required Imports

from office365.runtime.client_result import ClientResult
from office365.runtime.paths.resource_path import ResourcePath
from office365.runtime.queries.service_operation import ServiceOperationQuery
from office365.sharepoint.entity import Entity
from office365.sharepoint.sharing.user_directory_info import UserDirectoryInfo

Usage Example

from office365.sharepoint.client_context import ClientContext
from office365.sharepoint.sharing.utilities.sharing_utility import SharingUtility

# Initialize SharePoint context with credentials
ctx = ClientContext('https://yourtenant.sharepoint.com/sites/yoursite').with_credentials(user_credentials)

# Get user directory information by email
user_info_result = SharingUtility.get_user_directory_info_by_email(ctx, 'user@example.com')
ctx.execute_query()
user_info = user_info_result.value
print(f"User display name: {user_info.display_name}")

# Validate that two emails belong to the same user
validation_result = SharingUtility.validate_same_user_emails(
    ctx,
    primary_email='user@example.com',
    other_email='user.alias@example.com',
    principal_name='user@example.com'
)
ctx.execute_query()
is_same_user = validation_result.value
print(f"Emails belong to same user: {is_same_user}")

Best Practices

• Always call ctx.execute_query() after invoking static methods to execute the queued service operations and retrieve results
• The static methods add queries to the context but do not execute them immediately - results are available only after execute_query() is called
• Ensure the ClientContext has appropriate permissions to access user directory information before calling these methods
• Handle potential exceptions that may occur during query execution, such as authentication failures or permission errors
• The class itself is rarely instantiated directly by users - the static methods create temporary instances internally
• ClientResult objects returned by methods will have their 'value' property populated only after execute_query() completes successfully
• Both static methods are thread-safe as they create new utility instances for each call

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class Utility 79.4% similar

  A utility class for SharePoint operations including email management, user information retrieval, principal search, wiki page creation, and various administrative tasks.

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

• class Utility_v1 74.5% similar

  A SharePoint utility class that extends Entity to provide access to SharePoint utility operations and services.

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

• class UserDirectoryInfo 68.6% similar

  A data class representing user information retrieved from a directory service, such as Active Directory or Azure AD, used in SharePoint sharing operations.

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

• class ObjectSharingInformationUser 68.5% similar

  A class representing information about a principal (user or group) with whom a SharePoint securable object is shared, providing access to their email, SIP address, login name, and related principal/user objects.

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

• class SPHelper 67.7% similar

  SPHelper is a utility class for SharePoint directory operations, providing static methods to check group membership, site availability, retrieve group members/owners, and manage external members.

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