Laravel Microsoft Graph

https://github.com/dcblogdev/laravel-microsoft-graph
Admin
Laravel Microsoft Graph is a Laravel package that provides seamless integration with Microsoft Graph...
Tokens:60,835
Snippets:397
Trust Score:9.4
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Example of get() with custom options

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/emails.md

Shows how to pass an array of options to get() to override defaults, e.g., top=15 and skip=0.

```php
MsGraph::emails()->get('Inbox', [
    '$orderby' => "displayName",
    '$top' => 15,
    '$skip' => 0,
    '$count' => "true",
]);
```

--------------------------------

### Example call to get users

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraphadmin.md

Shows how to call the get method with the 'users' endpoint. The base URL https://graph.microsoft.com/beta/ is automatically prepended, so only the endpoint path is needed.

```php
MsGraphAdmin::get('users');
```

--------------------------------

### Install via Composer

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/install.md

Run this command to install the laravel-microsoft-graph package via Composer.

```php
composer require dcblogdev/laravel-microsoft-graph
```

--------------------------------

### Send email example with MsGraphAdmin::emails()->send()

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraphadmin/emails.md

Complete example of sending an email using the fluent interface. Requires user ID, recipient array, subject, and body.

```php
MsGraphAdmin::emails()
->userid($userId)
->to(['email@domains.com'])
->subject('the subject')
->body('the content')
->send();
```

--------------------------------

### Example endpoint call

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph.md

Shows an example of calling the 'me/messages' endpoint. The base URL https://graph.microsoft.com/beta/ is provided, so only the endpoint path is needed.

```php
MsGraph::get('me/messages')
```

--------------------------------

### Get contacts with custom options

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/contacts.md

Pass an array to the get() method to override the default options. This example requests 100 contacts starting from the beginning.

```php
MsGraph::contacts()->get([
    "\$orderby" => "displayName",
    "\$top" => 100,
    "\$skip" => 0,
    "\$count" => "true",
]);
```

--------------------------------

### Basic email call with userid

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraphadmin/emails.md

Starts an email query for a specific user. Must be followed by a method like get().

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

--------------------------------

### List Contacts with Custom Options

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraphadmin/contacts.md

Pass an array to get() to override default pagination options. This example requests 100 contacts, skipping 0, ordered by displayName.

```php
MsGraphAdmin::contacts()->userid($userId)->get([
    "\$orderby" => "displayName",
    "\$top" => 100,
    "\$skip" => 0,
    "\$count" => "true",
]);
```

--------------------------------

### Usage examples for msgraph disk

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/filesystem.md

Examples of using the msgraph disk for common file operations: make directory, upload, move, copy, download, list files, and list directories.

```php
//make folder
Storage::disk('msgraph')->makeDirectory('assets');

//upload file
Storage::disk('msgraph')->put('demo.txt', 'hello');

//move demo.txt from a test folder to the root
Storage::disk('msgraph')->move('test/demo.txt', 'demo.txt');

//copy demo.txt from the root to a test folder
Storage::disk('msgraph')->copy('demo.txt', 'test/demo.txt');

//download file
Storage::disk('msgraph')->download('demo2.txt');

//get a list of files from the root
Storage::disk('msgraph')->files();

//get a list of folders from the root
Storage::disk('msgraph')->directories();
```

--------------------------------

### Create a Contact

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraphadmin/contacts.md

Call store($data) with an array of contact details. The example shows creating a contact with displayName, givenName, and an email address.

```php
$data = [
    'displayName' => 'John Smith',
    'givenName' => 'John Smith',
    'emailAddresses' => [
        [
            'address' => 'j.smith@domain.com',
            'name' => 'John Smith'
        ]
    ]
];

MsGraphAdmin::contacts()->userid($userId)->store($data);
```

--------------------------------

### GET request with top and skip

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/contacts.md

Add top=50 to return 50 contacts and skip=2 to start from the 2nd set. These can be used together.

```http
?top=50&skip=2
```

--------------------------------

### List emails with get()

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraphadmin/emails.md

Returns a list of emails for the specified user. By default, only 10 emails are returned.

```php
MsGraphAdmin::emails()->userid($userId)->get();
```

--------------------------------

### Call contacts method

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/contacts.md

Start working with contacts by calling the contacts() method on MsGraph.

```php
MsGraph::contacts()
```

--------------------------------

### Access files methods

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/files.md

Starts a file operation by calling the files() method on the MsGraph facade.

```php
MsGraph::files();
```

--------------------------------

### Get emails with MsGraph::emails()->get()

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/emails.md

Returns a list of emails. By default, loads from the inbox folder. Accepts an optional folder name or ID and an optional array of parameters.

```php
MsGraph::emails()->get($folderIdOrName = 'Inbox', $params = []);
```

--------------------------------

### Get emails with custom options

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraphadmin/emails.md

Passes an array to get() to override default pagination options. Here, top is set to 15 and skip to 0.

```php
MsGraphAdmin::emails()->userid($userId)->get([
    "\$orderby" => "displayName",
    "\$top" => 15,
    "\$skip" => 0,
    "\$count" => "true",
]);
```

--------------------------------

### Default Options Array for get()

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraphadmin/contacts.md

The default array used internally by the get() method. You can override these options by passing an array to get().

```php
[
    "\$orderby" => "displayName",
    "\$top" => $top,
    "\$skip" => $skip,
    "\$count" => "true",
]
```

--------------------------------

### Call MsGraph::emails()

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/emails.md

Starts the email workflow by calling the emails() method on the MsGraph facade.

```php
MsGraph::emails();
```

--------------------------------

### MsGraphAdmin::emails()->userid($userId)->get()

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraphadmin/emails.md

Returns a list of emails for the specified user. By default, only 10 emails are returned, but this can be changed by passing an array of options to get() or using GET query parameters.

```APIDOC
## MsGraphAdmin::emails()->userid($userId)->get()

### Description
Returns a list of emails for the specified user. By default, only 10 emails are returned, but this can be changed by passing an array of options to get() or using GET query parameters.

### Method
GET

### Endpoint
MsGraphAdmin::emails()->userid($userId)->get()

### Parameters
#### Path Parameters
- **$userId** (string) - Required - The ID of the user whose emails to retrieve.

#### Query Parameters
- **top** (integer) - Optional - The number of emails to return (e.g., top=50).
- **skip** (integer) - Optional - The number of emails to skip before starting to collect the result set (e.g., skip=2).

#### Request Body
- **$orderby** (string) - Optional - Specifies the sort order (e.g., "displayName").
- **$top** (integer) - Optional - The number of emails to return.
- **$skip** (integer) - Optional - The number of emails to skip.
- **$count** (boolean) - Optional - Indicates whether to include the total count of emails.

### Request Example
```php
MsGraphAdmin::emails()->userid($userId)->get([
    "\$orderby" => "displayName",
    "\$top" => 15,
    "\$skip" => 0,
    "\$count" => "true",
]);
```

### Response
#### Success Response (200)
- **emails** (array) - Contains the list of email messages.
  - **@odata.context** (string) - The context URL.
  - **@odata.count** (integer) - The total number of emails.
  - **@odata.nextLink** (string) - The link for the next set of data.
  - **value** (array) - The email message objects.
- **total** (integer) - The total number of emails.
- **top** (string) - The number of emails requested.
- **skip** (string) - The number of emails skipped.

#### Response Example
```php
array:4 [
  "emails" => array:4 [
    "@odata.context" => "https://graph.microsoft.com/beta/$metadata#users('5b7f8791-03a1-4b68-9ff2-5bdca45563')/messages"
    "@odata.count" => 44177
    "@odata.nextLink" => "https://graph.microsoft.com/beta/users/5b7f8791-03a1-4b68-9ff2-5bdca45563/messages?$count=true&$orderby=sentDateTime+desc&$skip=15"
    "value" => [
        "@odata.etag" => "W/\"CQAAABYAAAC8b+tAO4nLRZCbkhud5CXFAASVGY/p\""
        "id" => "AAMkADdlZTBjNjQ4LWI0OGItNDFhZS05ZDNiLThiY2JkYzIzZWZkYwBGAAAAAABFX7lJCx7ZRLTJ6iI0yZK6BwC8b_tAO4nLRZCbkhud5CXFAAAAAAELAAC8b_tAO4nLRZCbkhud5CXFAASUuapzAAA="
        "createdDateTime" => "2019-05-29T08:58:09Z"
        "lastModifiedDateTime" => "2019-05-29T09:02:00Z"
        "changeKey" => "CQAAABYAAAC8b+tAO4nLRZCbkhud5CXFAASVGY/p"
        "categories" => []
        "receivedDateTime" => "2019-05-29T08:58:09Z"
        "sentDateTime" => "2019-05-29T08:58:04Z"
        "hasAttachments" => false
        "internetMessageId" => ""
        "subject" => "sent you a document to sign"
        "bodyPreview" => "You Have Been Sent A Document To Sign"
        "importance" => "normal"
        "parentFolderId" => "AQMkADdlZQAwYzY0OC1iNDhiLTQxYWUtOWQzYi04YmNiZGMyM2VmZGMALgAAA0VfuUkLHtlEtMnqIjTJkroBALxv60A7ictFkJuSG53kJcUAAAIBCwAAAA=="
        "conversationId" => "AAQkADdlZTBjNjQ4LWI0OGItNDFhZS05ZDNiLThiY2JkYzIzZWZkYwAQADNDbfE-oxVGsAHIKhk2vCE="
        "conversationIndex" => "AQHVFfyjM0Nt8T+jFUawAcgqGTa8IQ=="
        "isDeliveryReceiptRequested" => null
        "isReadReceiptRequested" => false
        "isRead" => true
        "isDraft" => false
        "webLink" => "https://outlook.office365.com/owa/?ItemID=jQ4LWI0OGItNDFhZS05ZDNiLThiY2JkYzIzZWZkYwBGAAAAAABFX7lJCx7ZRLTJ6iI0yZK6BwC8b%2BtAO4nLRZCbkhud5CXFAAAAAAEL ▶"
        "inferenceClassification" => "other"
        "unsubscribeData" => []
        "unsubscribeEnabled" => false
        "mentionsPreview" => null
        "body" => array:2 [▶]
        "sender" => array:1 [▼
          "emailAddress" => array:2 [▼
            "name" => "via Signable"
            "address" => "document@signable.co.uk"
          ]
        ]
        "from" => array:1 [▼
          "emailAddress" => array:2 [▼
            "name" => "via Signable"
            "address" => "document@signable.co.uk"
          ]
        ]
        "toRecipients" => array:1 [▼
          0 => array:1 [▼
            "emailAddress" => array:2 [▶]
          ]
        ]
        "ccRecipients" => []
        "bccRecipients" => []
        "replyTo" => array:1 [▼
          0 => array:1 [▼
            "emailAddress" => array:2 [▼
              "name" => "John Smith"
              "address" => "j.smith@domain.co.uk"
            ]
          ]
        ]
        "flag" => array:1 [▼
          "flagStatus" => "notFlagged"
        ]
    ]
  "total" => 44177
  "top" => "0"
  "skip" => "15"
]
```

### Error Handling
No error handling is documented in the source.
```

--------------------------------

### Send email with attachments using MsGraphAdmin::emails()->attachments()

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraphadmin/emails.md

Example of sending an email with attachments. Pass an array of file paths to the attachments() method.

```php
MsGraphAdmin::emails()
->userid($userId)
->to(['email@domains.com'])
->subject('the subject')
->body('the content')
->attachments([public_path('images/logo')])
->send();
```

--------------------------------

### Get Email Folder by Name

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/emails.md

Finds a folder by its name.

```php
MsGraph::emails()->folders()->findByName($name)
```

--------------------------------

### Get Folder by Name

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/emails.md

Retrieves an email folder by its name.

```APIDOC
## Get Folder by Name

### Description
Retrieves an email folder by its name.

### Method
folders()->findByName($name)

### Parameters
- **name** (string) - Required - The folder name.

### Request Example
```php
MsGraph::emails()->folders()->findByName($name)
```
```

--------------------------------

### Response format from get()

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/emails.md

The response returned is an array containing emails, total, top, and skip. The @odata.nextLink provides the link for the next set of data.

```php
array:4 [
  "emails" => array:4 [
    "@odata.context" => "https://graph.microsoft.com/beta/$metadata#users('5b7f8791-03a1-4b68-9ff2-5bdca45563')/messages"
    "@odata.count" => 44177
    "@odata.nextLink" => "https://graph.microsoft.com/beta/users/5b7f8791-03a1-4b68-9ff2-5bdca45563/messages?$count=true&$orderby=sentDateTime+desc&$skip=15"
    "value" => [
        "@odata.etag" => "W/"CQAAABYAAAC8b+tAO4nLRZCbkhud5CXFAASVGY/p""
        "id" => "AAMkADdlZTBjNjQ4LWI0OGItNDFhZS05ZDNiLThiY2JkYzIzZWZkYwBGAAAAAABFX7lJCx7ZRLTJ6iI0yZK6BwC8b_tAO4nLRZCbkhud5CXFAAAAAAELAAC8b_tAO4nLRZCbkhud5CXFAASUuapzAAA="
        "createdDateTime" => "2019-05-29T08:58:09Z"
        "lastModifiedDateTime" => "2019-05-29T09:02:00Z"
        "changeKey" => "CQAAABYAAAC8b+tAO4nLRZCbkhud5CXFAASVGY/p"
        "categories" => []
        "receivedDateTime" => "2019-05-29T08:58:09Z"
        "sentDateTime" => "2019-05-29T08:58:04Z"
        "hasAttachments" => false
        "internetMessageId" => ""
        "subject" => "sent you a document to sign"
        "bodyPreview" => You Have Been Sent A Document To Sign
        "importance" => "normal"
        "parentFolderId" => "AQMkADdlZQAwYzY0OC1iNDhiLTQxYWUtOWQzYi04YmNiZGMyM2VmZGMALgAAA0VfuUkLHtlEtMnqIjTJkroBALxv60A7ictFkJuSG53kJcUAAAIBCwAAAA=="
        "conversationId" => "AAQkADdlZTBjNjQ4LWI0OGItNDFhZS05ZDNiLThiY2JkYzIzZWZkYwAQADNDbfE-oxVGsAHIKhk2vCE="
        "conversationIndex" => "AQHVFfyjM0Nt8T+jFUawAcgqGTa8IQ=="
        "isDeliveryReceiptRequested" => null
        "isReadReceiptRequested" => false
        "isRead" => true
        "isDraft" => false
        "webLink" => "https://outlook.office365.com/owa/?ItemID=jQ4LWI0OGItNDFhZS05ZDNiLThiY2JkYzIzZWZkYwBGAAAAAABFX7lJCx7ZRLTJ6iI0yZK6BwC8b%2BtAO4nLRZCbkhud5CXFAAAAAAEL ▶"
        "inferenceClassification" => "other"
        "unsubscribeData" => []
        "unsubscribeEnabled" => false
        "mentionsPreview" => null
        "body" => array:2 [▶]
        "sender" => array:1 [▼
          "emailAddress" => array:2 [▼
            "name" => "via Signable"
            "address" => "document@signable.co.uk"
          ]
        ]
        "from" => array:1 [▼
          "emailAddress" => array:2 [▼
            "name" => "via Signable"
            "address" => "document@signable.co.uk"
          ]
        ]
        "toRecipients" => array:1 [▼
          0 => array:1 [▼
            "emailAddress" => array:2 [▶]
          ]
        ]
        "ccRecipients" => []
        "bccRecipients" => []
        "replyTo" => array:1 [▼
          0 => array:1 [▼
            "emailAddress" => array:2 [▼
              "name" => "John Smith"
              "address" => "j.smith@domain.co.uk"
            ]
          ]
        ]
        "flag" => array:1 [▼
          "flagStatus" => "notFlagged"
        ]
    ]
  "total" => 44177
  "top" => "0"
  "skip" => "15"
]
```

--------------------------------

### Example response array

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/contacts.md

The response returned is an array in this format. The @odata.nextLink is the link for the next set of data that can be used directly or make use of the top and skip that are returned.

```php
array:4 [
  "contacts" => array:4 [
    "@odata.context" => "https://graph.microsoft.com/beta/$metadata#users('5b7f8791-03a1-4b68-9ff2-5bdca45563')/contacts"
    "@odata.count" => 1112
    "@odata.nextLink" => "https://graph.microsoft.com/beta/users/5b7f8791-03a1-4b68-9ff2-5bdca45563/contacts?$orderby=displayName&$top=50&$skip=52&$count=true"
    "value" => array:50 [
        0 => array:38 [
        "@odata.etag" => "W/"BYAAAALc1XGBA2GTZfCUzLE1FjyAAKvR6Gl"
        "id" => "hhOTJlODA2LTUwYTQtNGNmMS1hZWQ2LWVjZjU1OTZiYzY4OQBGAAAAAAAbbv6dt9gvS71-sGvg9qUVBwALc1XGBA2GTZfCUzLE1FjyAAAAui-HAAALc1XGBA2GTZfCUzLE1FjyAAEEO4cvAAA="
        "createdDateTime" => "2017-06-15T21:47:53Z"
        "lastModifiedDateTime" => "2019-04-04T21:26:50Z"
        "changeKey" => "EQAAABYAAAALc1XGBA2GTZfCUzLE1FjyAAKvR6Gl"
        "categories" => []
        "parentFolderId" => "TJlODA2LTUwYTQtNGNmMS1hZWQ2LWVjZjU1OTZiYzY4OQAuAAAAAAAbbv6dt9gvS71-sGvg9qUVAQALc1XGBA2GTZfCUzLE1FjyAAAAui-HAAA="
        "birthday" => null
        "fileAs" => ""
        "displayName" => "John Smith"
        "givenName" => null
        "initials" => null
        "middleName" => null
        "nickName" => null
        "surname" => null
        "title" => null
        "yomiGivenName" => null
        "yomiSurname" => null
        "yomiCompanyName" => null
        "generation" => null
        "imAddresses" => []
        "jobTitle" => null
        "companyName" => null
        "department" => null
        "officeLocation" => null
        "profession" => null
        "assistantName" => null
        "manager" => null
        "spouseName" => null
        "personalNotes" => ""
        "children" => []
        "gender" => null
        "isFavorite" => null
        "emailAddresses" => array:1 [
             0 => array:3 [
                "type" => "unknown"
                "name" => "John Smith"
                "address" => "j.smith@domain.co.uk"
              ]
            ]
        ]
        "websites" => []
        "phones" => []
        "postalAddresses" => []
        "flag" => array:1 [
          "flagStatus" => "notFlagged"
        ]
      ]
    ]
  ]
  "total" => 1112
  "top" => "50"
  "skip" => "52"
]
```

--------------------------------

### Get Email Folder by ID

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/emails.md

Finds a folder by its ID.

```php
MsGraph::emails()->folders()->find($id)
```

--------------------------------

### Get Folders

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/emails.md

Retrieves email folders. Optionally sorts folders into a custom priority order.

```APIDOC
## Get Folders

### Description
Retrieves email folders. Optionally sorts folders into a custom priority order.

### Method
folders()->get()

### Parameters
- **params** (array) - Optional - Additional query parameters.
- **sort** (bool) - Optional - Whether to sort folders into a custom list. Default false.
- **priorityOrder** (array) - Optional - Custom priority order for sorting. Default order: Inbox, Archive, Drafts, Sent Items, Deleted Items, Conversation History, Junk Email.

### Request Example
```php
$priorityOrder = [
    'Inbox' => 1,
    'Archive' => 2,
    'Drafts' => 3,
    'Sent Items' => 4,
    'Deleted Items' => 5,
    'Conversation History' => 6,
    'Junk Email' => 7,
];

MsGraph::emails()->folders()->get(array $params = [], bool $sort = false, array $priorityOrder = [])
```
```

--------------------------------

### Get file/folder item by id

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/files.md

Retrieves a file or folder item using its unique identifier.

```php
MsGraph::files()->getItem($id);
```

--------------------------------

### Update a Contact

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraphadmin/contacts.md

Call update($data) with the contact ID and an array of details to change. This example updates only the email address.

```php
$data = [
    'emailAddresses' => [
        [
            'address' => 'j.agent@domain.com',
            'name' => 'John Agent'
        ]
    ]
];

MsGraphAdmin::contacts()->userid($userId)->update($id, $data);
```

--------------------------------

### MsGraphAdmin::get($endpoint, $array = [])

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraphadmin.md

Sends a GET request to the specified Microsoft Graph endpoint. The base URL https://graph.microsoft.com/beta/ is prepended automatically.

```APIDOC
## MsGraphAdmin::get($endpoint, $array = [])

### Description
Sends a GET request to the specified Microsoft Graph endpoint. The base URL https://graph.microsoft.com/beta/ is prepended automatically.

### Method
get

### Endpoint
N/A (SDK method)

### Parameters
- **$endpoint** (string) - Required - The API endpoint path after the base URL, e.g., 'users'.
- **$array** (array) - Optional - Additional parameters for the request, requirement depends on the endpoint.

### Request Example
```php
MsGraphAdmin::get('users');
```

### Response
#### Success Response
Returns the response from the Microsoft Graph API.

#### Response Example
Depends on the endpoint.
```

--------------------------------

### Get Email Folders with Sorting and Priority Order

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/emails.md

Retrieves folders. By default, folders are not sorted; set $sort to true to sort into a custom list specified in $priorityOrder. The default priority order is shown.

```php
$priorityOrder = [
    'Inbox' => 1,
    'Archive' => 2,
    'Drafts' => 3,
    'Sent Items' => 4,
    'Deleted Items' => 5,
    'Conversation History' => 6,
    'Junk Email' => 7,
];

MsGraph::emails()->folders()->get(array $params = [], bool $sort = false, array $priorityOrder = [])
```

--------------------------------

### Get all files from OneDrive

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/files.md

Retrieves files from the authenticated user's OneDrive. The $type parameter defaults to 'me'.

```php
MsGraph::files()->getFiles($path = null, $type = 'me');
```

--------------------------------

### Available HTTP verbs for MsGraphAdmin

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraphadmin.md

Lists the supported HTTP verbs: get, post, put, patch, and delete. Each method takes an endpoint and an optional array parameter, whose requirement depends on the endpoint.

```php
MsGraphAdmin::get($endpoint, $array = [])
MsGraphAdmin::post($endpoint, $array = [])
MsGraphAdmin::put($endpoint, $array = [])
MsGraphAdmin::patch($endpoint, $array = [])
MsGraphAdmin::delete($endpoint, $array = [])
```

--------------------------------

### MsGraph::emails()->get()

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/emails.md

Returns a list of emails from a specified folder. By default, emails are loaded from the Inbox folder. Options can be passed as an array to control ordering, pagination, and count.

```APIDOC
## MsGraph::emails()->get()

### Description
Returns a list of emails from a specified folder. By default, emails are loaded from the Inbox folder. Options can be passed as an array to control ordering, pagination, and count.

### Method
GET

### Endpoint
MsGraph::emails()->get($folderIdOrName = 'Inbox', $params = [])

### Parameters
#### Path Parameters
- **folderIdOrName** (string) - Optional - The folder ID or name to retrieve emails from. Defaults to 'Inbox'.

#### Query Parameters
- **$orderby** (string) - Optional - Specifies the property to sort by. Default is 'displayName'.
- **$top** (integer) - Optional - The number of emails to return. Default is 25.
- **$skip** (integer) - Optional - The number of emails to skip before starting to collect the result set.
- **$count** (string) - Optional - Indicates whether to include the total count of emails. Default is 'true'.

### Request Example
```php
MsGraph::emails()->get('Inbox', [
    '$orderby' => "displayName",
    '$top' => 15,
    '$skip' => 0,
    '$count' => "true",
]);
```

### Response
#### Success Response (200)
- **emails** (array) - Contains the email data including @odata.context, @odata.count, @odata.nextLink, and value array.
- **total** (integer) - The total number of emails.
- **top** (string) - The number of emails requested.
- **skip** (string) - The number of emails skipped.

#### Response Example
```php
array:4 [
  "emails" => array:4 [
    "@odata.context" => "https://graph.microsoft.com/beta/$metadata#users('5b7f8791-03a1-4b68-9ff2-5bdca45563')/messages"
    "@odata.count" => 44177
    "@odata.nextLink" => "https://graph.microsoft.com/beta/users/5b7f8791-03a1-4b68-9ff2-5bdca45563/messages?$count=true&$orderby=sentDateTime+desc&$skip=15"
    "value" => [
        "@odata.etag" => "W/\"CQAAABYAAAC8b+tAO4nLRZCbkhud5CXFAASVGY/p\""
        "id" => "AAMkADdlZTBjNjQ4LWI0OGItNDFhZS05ZDNiLThiY2JkYzIzZWZkYwBGAAAAAABFX7lJCx7ZRLTJ6iI0yZK6BwC8b_tAO4nLRZCbkhud5CXFAAAAAAELAAC8b_tAO4nLRZCbkhud5CXFAASUuapzAAA="
        "createdDateTime" => "2019-05-29T08:58:09Z"
        "lastModifiedDateTime" => "2019-05-29T09:02:00Z"
        "changeKey" => "CQAAABYAAAC8b+tAO4nLRZCbkhud5CXFAASVGY/p"
        "categories" => []
        "receivedDateTime" => "2019-05-29T08:58:09Z"
        "sentDateTime" => "2019-05-29T08:58:04Z"
        "hasAttachments" => false
        "internetMessageId" => ""
        "subject" => "sent you a document to sign"
        "bodyPreview" => "You Have Been Sent A Document To Sign"
        "importance" => "normal"
        "parentFolderId" => "AQMkADdlZQAwYzY0OC1iNDhiLTQxYWUtOWQzYi04YmNiZGMyM2VmZGMALgAAA0VfuUkLHtlEtMnqIjTJkroBALxv60A7ictFkJuSG53kJcUAAAIBCwAAAA=="
        "conversationId" => "AAQkADdlZTBjNjQ4LWI0OGItNDFhZS05ZDNiLThiY2JkYzIzZWZkYwAQADNDbfE-oxVGsAHIKhk2vCE="
        "conversationIndex" => "AQHVFfyjM0Nt8T+jFUawAcgqGTa8IQ=="
        "isDeliveryReceiptRequested" => null
        "isReadReceiptRequested" => false
        "isRead" => true
        "isDraft" => false
        "webLink" => "https://outlook.office365.com/owa/?ItemID=jQ4LWI0OGItNDFhZS05ZDNiLThiY2JkYzIzZWZkYwBGAAAAAABFX7lJCx7ZRLTJ6iI0yZK6BwC8b%2BtAO4nLRZCbkhud5CXFAAAAAAEL ▶"
        "inferenceClassification" => "other"
        "unsubscribeData" => []
        "unsubscribeEnabled" => false
        "mentionsPreview" => null
        "body" => array:2 [▶]
        "sender" => array:1 [▼
          "emailAddress" => array:2 [▼
            "name" => "via Signable"
            "address" => "document@signable.co.uk"
          ]
        ]
        "from" => array:1 [▼
          "emailAddress" => array:2 [▼
            "name" => "via Signable"
            "address" => "document@signable.co.uk"
          ]
        ]
        "toRecipients" => array:1 [▼
          0 => array:1 [▼
            "emailAddress" => array:2 [▶]
          ]
        ]
        "ccRecipients" => []
        "bccRecipients" => []
        "replyTo" => array:1 [▼
          0 => array:1 [▼
            "emailAddress" => array:2 [▼
              "name" => "John Smith"
              "address" => "j.smith@domain.co.uk"
            ]
          ]
        ]
        "flag" => array:1 [▼
          "flagStatus" => "notFlagged"
        ]
    ]
  "total" => 44177
  "top" => "0"
  "skip" => "15"
]
```

```

--------------------------------

### Response Format for List Contacts

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraphadmin/contacts.md

The response returned by get() is an array containing a 'contacts' key with the contact data, plus 'total', 'top', and 'skip' keys. The @odata.nextLink provides the link for the next set of data.

```php
array:4 [
  "contacts" => array:4 [
    "@odata.context" => "https://graph.microsoft.com/beta/$metadata#users('5b7f8791-03a1-4b68-9ff2-5bdca45563')/contacts"
    "@odata.count" => 1112
    "@odata.nextLink" => "https://graph.microsoft.com/beta/users/5b7f8791-03a1-4b68-9ff2-5bdca45563/contacts?$orderby=displayName&$top=50&$skip=52&$count=true"
    "value" => array:50 [
        0 => array:38 [
        "@odata.etag" => "W/"BYAAAALc1XGBA2GTZfCUzLE1FjyAAKvR6Gl""
        "id" => "hhOTJlODA2LTUwYTQtNGNmMS1hZWQ2LWVjZjU1OTZiYzY4OQBGAAAAAAAbbv6dt9gvS71-sGvg9qUVBwALc1XGBA2GTZfCUzLE1FjyAAAAui-HAAALc1XGBA2GTZfCUzLE1FjyAAEEO4cvAAA="
        "createdDateTime" => "2017-06-15T21:47:53Z"
        "lastModifiedDateTime" => "2019-04-04T21:26:50Z"
        "changeKey" => "EQAAABYAAAALc1XGBA2GTZfCUzLE1FjyAAKvR6Gl"
        "categories" => []
        "parentFolderId" => "TJlODA2LTUwYTQtNGNmMS1hZWQ2LWVjZjU1OTZiYzY4OQAuAAAAAAAbbv6dt9gvS71-sGvg9qUVAQALc1XGBA2GTZfCUzLE1FjyAAAAui-HAAA="
        "birthday" => null
        "fileAs" => ""
        "displayName" => "John Smith"
        "givenName" => null
        "initials" => null
        "middleName" => null
        "nickName" => null
        "surname" => null
        "title" => null
        "yomiGivenName" => null
        "yomiSurname" => null
        "yomiCompanyName" => null
        "generation" => null
        "imAddresses" => []
        "jobTitle" => null
        "companyName" => null
        "department" => null
        "officeLocation" => null
        "profession" => null
        "assistantName" => null
        "manager" => null
        "spouseName" => null
        "personalNotes" => ""
        "children" => []
        "gender" => null
        "isFavorite" => null
        "emailAddresses" => array:1 [
             0 => array:3 [
                "type" => "unknown"
                "name" => "John Smith"
                "address" => "j.smith@domain.co.uk"
              ]
            ]
        ]
        "websites" => []
        "phones" => []
        "postalAddresses" => []
        "flag" => array:1 [
          "flagStatus" => "notFlagged"
        ]
      ]
    ]
  ]
  "total" => 1112
  "top" => "50"
  "skip" => "52"
]
```

--------------------------------

### MsGraph HTTP verb methods

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph.md

Lists the available MsGraph methods for API calls: get, post, put, patch, delete. The second parameter is optional depending on the endpoint. The third parameter is for headers. The fourth parameter is optional and used to retrieve an access token based on id.

```php
MsGraph::get($endpoint, $array = [], $headers, $id = null)
MsGraph::post($endpoint, $array = [], $headers, $id = null)
MsGraph::put($endpoint, $array = [], $headers, $id = null)
MsGraph::patch($endpoint, $array = [], $headers, $id = null)
MsGraph::delete($endpoint, $array = [], $headers, $id = null)
```

--------------------------------

### Run migrations

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/install.md

After publishing the migration, run this command to create the tokens tables.

```php
php artisan migrate
```

--------------------------------

### Dispatch ExampleMsGraphJob with a user instance

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/queues.md

Dispatch the job using ExampleMsGraphJob::dispatch($user) to run the Microsoft Graph API calls in the background with the correct user context.

```php
ExampleMsGraphJob::dispatch($user);
```

--------------------------------

### Create folder

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/files.md

Creates a folder with the given name at the specified path. If no path is provided, the root is used.

```php
MsGraph::files()->createFolder($name, $path = null);
```

--------------------------------

### Instantiate Microsoft Graph client

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/filesystem.md

Create a new Microsoft Graph client instance using the official SDK.

```php
$graph = new \Microsoft\Graph\Graph;
```

--------------------------------

### Routes for login and connect

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/login-with-msgraph.md

Define routes in routes/web.php. The first group uses guest middleware for login and connect routes. The second group uses MsGraphAuthenticated middleware and a prefix 'app' for authenticated routes.

```php
Route::redirect('/', 'login');

Route::group(['middleware' => ['web', 'guest']], function(){
    Route::get('login', AuthController::class, 'login')->name('login');
    Route::get('connect', AuthController::class, 'connect')->name('connect');
});

Route::group(['middleware' => ['web', 'MsGraphAuthenticated'], 'prefix' => 'app'], function(){
    Route::get('/', PagesController::class, 'app')->name('app');
    Route::get('logout', AuthController::class, 'logout')->name('logout');
});
```

--------------------------------

### NewMicrosoft365SignInListener handle method

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/login-with-msgraph.md

This listener runs on successful login from the package. It creates a user if not existing, stores the MsGraph token linked to the user, and logs in using Auth::login($user). The code is published to app/Listeners/NewMicrosoft365SignInListener.php.

```php
<?php

namespace App\Listeners;

use App\Models\User;
use Dcblogdev\MsGraph\MsGraph;
use Illuminate\Support\Facades\Auth;

class NewMicrosoft365SignInListener
{
    public function handle($event)
    {
        $user  = User::firstOrCreate([
            'email' => $event->token['info']['mail'],
        ], [
            'name'     => $event->token['info']['displayName'],
            'email'    => $event->token['info']['mail'] ?? $event->token['info']['userPrincipalName'],
            'password' => '',
        ]);

        (new MsGraph())->storeToken(
            $event->token['accessToken'],
            $event->token['refreshToken'],
            $event->token['expires'],
            $user->id,
            $user->email
        );

        Auth::login($user);
    }
}
```

--------------------------------

### Publish MsGraph migrations

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/login-with-msgraph.md

Run this artisan command to publish the package migrations.

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

--------------------------------

### Publish MsGraph listener

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/login-with-msgraph.md

Run this artisan command to publish the listener, which is required for logging in.

```php
php artisan vendor:publish --provider="Dcblogdev\MsGraph\MsGraphServiceProvider" --tag="Listeners"
```

--------------------------------

### Optional database connection

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/install.md

Optionally set a preferred database connection for the package.

```php
MSGRAPH_DB_CONNECTION=sqlite
```

--------------------------------

### Required .env configuration

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/install.md

Set these environment variables for the package to work. The OAuth and landing URLs should point to your application's routes.

```php
MSGRAPH_CLIENT_ID=
MSGRAPH_SECRET_ID=

MSGRAPH_OAUTH_URL=https://domain.com/msgraph/oauth
MSGRAPH_LANDING_URL=https://domain.com/msgraph
```

--------------------------------

### Get Folder

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/emails.md

Retrieves a specific email folder by its ID.

```APIDOC
## Get Folder

### Description
Retrieves a specific email folder by its ID.

### Method
folders()->find($id)

### Parameters
- **id** (string) - Required - The folder ID.

### Request Example
```php
MsGraph::emails()->folders()->find($id)
```
```

--------------------------------

### Register listener in boot method

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/login-with-msgraph.md

Add this code to the boot method of EventServiceProvider to listen for the NewMicrosoft365SignInEvent and call the listener's handle method.

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

--------------------------------

### Publish MsGraph config

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/login-with-msgraph.md

Run this artisan command to publish the package configuration file.

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

--------------------------------

### MsGraph::emails()->findAttachment($id)

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/emails.md

Gets all attachments for a given email.

```APIDOC
## MsGraph::emails()->findAttachment($id)

### Description
Gets all attachments for a given email.

### Method
findAttachment

### Parameters
- **$id** (string) - Required - The email ID.

### Request Example
```php
MsGraph::emails()->findAttachment($id);
```

### Response
Returns a collection of attachments.
```

--------------------------------

### Import events in EventServiceProvider

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/login-with-msgraph.md

Import the listener and event classes in the EventServiceProvider to register the event listener.

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

--------------------------------

### List drives

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/files.md

Retrieves all drives available to the authenticated user.

```php
MsGraph::files()->getDrives();
```

--------------------------------

### List drive

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/files.md

Retrieves the default drive for the authenticated user.

```php
MsGraph::files()->getDrive();
```

--------------------------------

### List all contacts

Source: https://github.com/dcblogdev/laravel-microsoft-graph/blob/master/docs/v4/msgraph/contacts.md

Returns a list of all contacts. By default, only 10 contacts are returned.

```php
MsGraph::contacts()->get()
```
Tokens:
Raw