Partager via


Ajouter des fonctionnalités de messagerie aux applications PHP à l’aide de Microsoft Graph

Dans cet article, vous allez étendre l’application que vous avez créée dans Générer des applications PHP avec Microsoft Graph avec les API de messagerie Microsoft Graph. Vous utilisez Microsoft Graph pour répertorier la boîte de réception de l’utilisateur et envoyer un e-mail.

Lister la boîte de réception de l’utilisateur

Commencez par répertorier les messages dans la boîte de réception de l’utilisateur.

  1. Ajoutez ce code à la classe GraphHelper.

    public static function getInbox(): Models\MessageCollectionResponse {
        $configuration = new MessagesRequestBuilderGetRequestConfiguration();
        $configuration->queryParameters = new MessagesRequestBuilderGetQueryParameters();
        // Only request specific properties
        $configuration->queryParameters->select = ['from','isRead','receivedDateTime','subject'];
        // Sort by received time, newest first
        $configuration->queryParameters->orderby = ['receivedDateTime DESC'];
        // Get at most 25 results
        $configuration->queryParameters->top = 25;
        return GraphHelper::$userClient->me()
            ->mailFolders()
            ->byMailFolderId('inbox')
            ->messages()
            ->get($configuration)->wait();
    }
    
  2. Remplacez la fonction vide listInbox dans main.php par ce qui suit.

    function listInbox(): void {
        try {
            $messages = GraphHelper::getInbox();
    
            // Output each message's details
            foreach ($messages->getValue() as $message) {
                print('Message: '.$message->getSubject().PHP_EOL);
                print('  From: '.$message->getFrom()->getEmailAddress()->getName().PHP_EOL);
                $status = $message->getIsRead() ? "Read" : "Unread";
                print('  Status: '.$status.PHP_EOL);
                print('  Received: '.$message->getReceivedDateTime()->format(\DateTimeInterface::RFC2822).PHP_EOL);
            }
    
            $nextLink = $messages->getOdataNextLink();
            $moreAvailable = isset($nextLink) && $nextLink != '' ? 'True' : 'False';
            print(PHP_EOL.'More messages available? '.$moreAvailable.PHP_EOL.PHP_EOL);
        } catch (Exception $e) {
            print('Error getting user\'s inbox: '.$e->getMessage().PHP_EOL.PHP_EOL);
        }
    }
    
  3. Exécutez l’application, connectez-vous et choisissez l’option 2 pour répertorier votre boîte de réception.

    Please choose one of the following options:
    0. Exit
    1. Display access token
    2. List my inbox
    3. Send mail
    4. Make a Graph call
    2
    Message: Updates from Ask HR and other communities
      From: Contoso Demo on Yammer
      Status: Read
      Received: Mon, 18 Apr 2022 14:24:16 +0000
    Message: Employee Initiative Thoughts
      From: Patti Fernandez
      Status: Read
      Received: Mon, 18 Apr 2022 13:52:03 +0000
    Message: Voice Mail (11 seconds)
      From: Alex Wilber
      Status: Unread
      Received: Wed, 13 Apr 2022 02:30:27 +0000
    Message: Our Spring Blog Update
      From: Alex Wilber
      Status: Unread
      Received: Tue, 12 Apr 2022 16:46:01 +0000
    Message: Atlanta Flight Reservation
      From: Alex Wilber
      Status: Unread
      Received: Mon, 11 Apr 2022 13:39:10 +0000
    Message: Atlanta Trip Itinerary - down time
      From: Alex Wilber
      Status: Unread
      Received: Fri, 08 Apr 2022 18:36:01 +0000
    
    ...
    
    More messages available? True
    

getInbox expliqué

Considérez le code dans la getInbox fonction .

Accès aux dossiers de courrier connus

La fonction passe /me/mailFolders/inbox/messages au générateur de requêtes, qui génère une requête à l’API Répertorier les messages . Étant donné qu’elle inclut le /mailFolders/inbox segment, l’API retourne uniquement les messages dans le dossier de courrier demandé. Dans ce cas, étant donné que la boîte de réception est un dossier par défaut connu dans la boîte aux lettres d’un utilisateur, elle est accessible via son nom connu. Les dossiers non définis par défaut sont accessibles de la même façon, en remplaçant le nom connu par la propriété ID du dossier de messagerie. Pour plus d’informations sur les noms de dossiers connus disponibles, consultez Type de ressource mailFolder.

Accès à une collection

Contrairement à la getUser fonction de la section précédente, qui retourne un seul objet, cette méthode retourne une collection de messages. La plupart des API de Microsoft Graph qui retournent une collection ne retournent pas tous les résultats disponibles dans une seule réponse. Au lieu de cela, ils utilisent la pagination pour retourner une partie des résultats tout en fournissant une méthode permettant aux clients de demander la page suivante.

Tailles de page par défaut

Les API qui utilisent la pagination implémentent une taille de page par défaut. Pour les messages, la valeur par défaut est 10. Les clients peuvent demander plus (ou moins) à l’aide du paramètre de requête $top . Dans getInbox, l’ajout $top s’effectue avec la queryParameters->top propriété dans les paramètres de requête.

Remarque

La valeur passée queryParameters->top est une limite supérieure, et non un nombre explicite. L’API retourne un certain nombre de messages jusqu’à la valeur spécifiée.

Obtention des pages suivantes

Si d’autres résultats sont disponibles sur le serveur, les réponses de regroupement incluent une @odata.nextLink propriété avec une URL d’API pour accéder à la page suivante. Le Kit de développement logiciel (SDK) PHP fournit la méthode sur les getOdataNextLink objets de demande de collection. Si cette méthode retourne une chaîne non vide, d’autres résultats sont disponibles. Pour plus d’informations, consultez Page dans une collection à l’aide des Kits de développement logiciel (SDK) Microsoft Graph.

Tri des collections

La fonction utilise le paramètre de requête $orderby pour demander des résultats triés en fonction de la réception du message (receivedDateTime propriété ). Il inclut les DESC mot clé afin que les messages reçus plus récemment soient répertoriés en premier.

Envoyer un message

Ajoutez maintenant la possibilité d’envoyer un e-mail en tant qu’utilisateur authentifié.

  1. Ajoutez ce code à la classe GraphHelper.

    public static function sendMail(string $subject, string $body, string $recipient): void {
        $message = new Models\Message();
        $message->setSubject($subject);
    
        $itemBody = new Models\ItemBody();
        $itemBody->setContent($body);
        $itemBody->setContentType(new Models\BodyType(Models\BodyType::TEXT));
        $message->setBody($itemBody);
    
        $email = new Models\EmailAddress();
        $email->setAddress($recipient);
        $to = new Models\Recipient();
        $to->setEmailAddress($email);
        $message->setToRecipients([$to]);
    
        $sendMailBody = new SendMailPostRequestBody();
        $sendMailBody->setMessage($message);
    
        GraphHelper::$userClient->me()->sendMail()->post($sendMailBody)->wait();
    }
    
  2. Remplacez la fonction vide sendMail dans main.php par ce qui suit.

    function sendMail(): void {
        try {
            // Send mail to the signed-in user
            // Get the user for their email address
            $user = GraphHelper::getUser();
    
            // For Work/school accounts, email is in Mail property
            // Personal accounts, email is in UserPrincipalName
            $email = $user->getMail();
            if (empty($email)) {
                $email = $user->getUserPrincipalName();
            }
    
            GraphHelper::sendMail('Testing Microsoft Graph', 'Hello world!', $email);
    
            print(PHP_EOL.'Mail sent.'.PHP_EOL.PHP_EOL);
        } catch (Exception $e) {
            print('Error sending mail: '.$e->getMessage().PHP_EOL.PHP_EOL);
        }
    }
    
  3. Exécutez l’application, connectez-vous et choisissez l’option 3 pour vous envoyer un e-mail.

    Please choose one of the following options:
    0. Exit
    1. Display access token
    2. List my inbox
    3. Send mail
    4. Make a Graph call
    3
    
    Mail sent.
    

    Remarque

    Si vous effectuez des tests auprès d’un locataire développeur dans le cadre du Programme pour développeurs Microsoft 365, l’e-mail que vous envoyez risque de ne pas être remis et vous recevrez peut-être un rapport de non-remise. Si vous souhaitez débloquer l’envoi de courrier de votre locataire, contactez le support via le Centre d’administration Microsoft 365.

  4. Pour vérifier que le message a été reçu, choisissez l’option 2 pour répertorier votre boîte de réception.

sendMail expliqué

Considérez le code dans la sendMail fonction .

Envoi de messages

La fonction utilise le générateur de $userClient->me()->sendMail() requêtes, qui génère une requête à l’API Envoyer un courrier . Le générateur de demandes prend un corps de requête qui contient le message à envoyer.

Création d’objets

Contrairement aux appels précédents à Microsoft Graph qui ne lisent que les données, cet appel crée des données. Pour créer des éléments avec la bibliothèque cliente, vous créez un tableau associatif représentant les données, définissez les propriétés souhaitées, puis vous l’envoyez dans l’appel d’API. Étant donné que l’appel envoie des données, la POST méthode est utilisée à la place de GET.

Étape suivante