Laravel Microsoft Graph

To interact with a user's emails using MsGraphAdmin, you must first initialize the email context by calling MsGraphAdmin::emails() and then specifying the target user with ->userid($userId). All subsequent email operations (listing, sending, reading, etc.) must be chained after these two calls.

MsGraphAdmin::emails()->userid($userId);

To interact with a user's emails using MsGraph, you must first initialize the email context by calling MsGraph::emails(). All subsequent email-related methods must be chained to this call.

MsGraph::emails();

To interact with a user's contacts using MsGraphAdmin, you must first initialize the contact context using MsGraphAdmin::contacts() and then specify the target user using ->userid($userId). All subsequent contact operations (listing, creating, viewing, updating, or deleting) must be chained after these two calls.

MsGraphAdmin::contacts()->userid($userId);

The package provides two distinct ways to interact with the Microsoft Graph API depending on your application's requirements:

1. MsGraph: Used for user-centric flows where you log in as an individual user (Delegated permissions).
2. MsGraphAdmin: Used for tenant-level or administrator flows, which is ideal for running background tasks, scheduled jobs, or accessing data across the entire tenant (Application permissions).

The package provides two distinct modes of operation depending on your authentication requirements:

• MsGraph: Used when you need to log in as an individual user (delegated permissions).
• MsGraphAdmin: Used when you need to log in as a tenant administrator (application permissions). This mode is particularly useful for running background tasks or automated processes that do not require a user's interactive presence.

To interact with files, you must first call MsGraph::files(). By default, all file operations target the authenticated user's OneDrive using the 'me' prefix.

To target a different storage location, pass a $type argument to the files() call (or methods that accept it) using the appropriate prefix. For example, to access files within a specific Microsoft Group, use the prefix groups/$groupId.

// Access default OneDrive
MsGraph::files();

// Access files from a specific group
MsGraph::files()->getFiles(null, "groups/$groupId");

To interact with a user's emails, you must first initialize the email service using MsGraphAdmin::emails() and specify the target user with the ->userid($userId) method. All subsequent email operations (listing, reading, sending, etc.) must be chained after these two calls.

MsGraphAdmin::emails()->userid($userId);

In your app/Providers/EventServiceProvider.php, you must register the NewMicrosoft365SignInEvent to trigger your custom listener.

// In EventServiceProvider.php

use App\\Listeners\\NewMicrosoft365SignInListener;
use Dcblogdev\\MsGraph\\Events\\NewMicrosoft365SignInEvent;

public function boot()
{
    Event::listen(
        NewMicrosoft365SignInEvent::class,
        [NewMicrosoft365SignInListener::class, 'handle']
    );
}

Use the following Artisan commands to publish the necessary package assets to your application:

• Config: Publishes config/msgraph.php.
• Migrations: Publishes the database migrations required for token storage.
• Listeners: Publishes a listener for handling Microsoft 365 sign-ins (useful if using Graph as a login system).

After publishing migrations, run php artisan migrate to create the required tables.

# Publish config
php artisan vendor:publish --provider="Dcblogdev\MsGraph\MsGraphServiceProvider" --tag="config"

# Publish migrations
php artisan vendor:publish --provider="Dcblogdev\MsGraph\MsGraphServiceProvider" --tag="migrations"

# Publish listeners (optional for login systems)
php artisan vendor:publish --provider="Dcblogdev\MsGraph\MsGraphServiceProvider" --tag="Listeners"

# Run migrations
php artisan migrate

Laravel Microsoft Graph is a package designed to integrate Microsoft Graph API capabilities into Laravel applications.

Detailed installation instructions and full documentation can be found at the official documentation site: https://dcblog.dev/docs/laravel-microsoft-graph

To interact with a user's contacts using MsGraph, you must first initialize the contact context by calling MsGraph::contacts(). This returns a contact-specific object that allows you to perform CRUD operations.

MsGraph::contacts()

To use Sharepoint or OneDrive as a filesystem disk, add a new configuration entry to config/filesystems.php using the msgraph driver. You must provide a driveId which identifies the specific SharePoint drive or OneDrive instance to interact with.

To find your driveId:

1. Use the Microsoft Graph Explorer.
2. Authenticate and call the endpoint: https://graph.microsoft.com/v1.0/drives.
3. Locate the id property in the JSON response (e.g., "id": "b!zMM792FbNkq...").
4. Add this ID to your .env file using the MSGRAPH_DRIVEID key.

// config/filesystems.php
'msgraph' => [
    'driver' => 'msgraph',
    'driveId' => env('MSGRAPH_DRIVEID', ''),
],

# .env
MSGRAPH_DRIVEID='your-drive-id-here'