Notes
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
Dans cet article, vous allez étendre l’application que vous avez créée dans Générer des applications Python 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.
Ajoutez la fonction suivante à graph.py.
async def get_inbox(self): query_params = MessagesRequestBuilder.MessagesRequestBuilderGetQueryParameters( # Only request specific properties select=['from', 'isRead', 'receivedDateTime', 'subject'], # Get at most 25 results top=25, # Sort by received time, newest first orderby=['receivedDateTime DESC'] ) request_config = MessagesRequestBuilder.MessagesRequestBuilderGetRequestConfiguration( query_parameters= query_params ) messages = await self.user_client.me.mail_folders.by_mail_folder_id('inbox').messages.get( request_configuration=request_config) return messagesRemplacez la fonction vide
list_inboxdans main.py par ce qui suit.async def list_inbox(graph: Graph): message_page = await graph.get_inbox() if message_page and message_page.value: # Output each message's details for message in message_page.value: print('Message:', message.subject) if ( message.from_ and message.from_.email_address ): print(' From:', message.from_.email_address.name or 'NONE') else: print(' From: NONE') print(' Status:', 'Read' if message.is_read else 'Unread') print(' Received:', message.received_date_time) # If @odata.nextLink is present more_available = message_page.odata_next_link is not None print('\nMore messages available?', more_available, '\n')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: 2022-04-26T19:19:05Z Message: Employee Initiative Thoughts From: Patti Fernandez Status: Read Received: 2022-04-25T19:43:57Z Message: Voice Mail (11 seconds) From: Alex Wilber Status: Unread Received: 2022-04-22T19:43:23Z Message: Our Spring Blog Update From: Alex Wilber Status: Unread Received: 2022-04-19T22:19:02Z Message: Atlanta Flight Reservation From: Alex Wilber Status: Unread Received: 2022-04-19T15:15:56Z Message: Atlanta Trip Itinerary - down time From: Alex Wilber Status: Unread Received: 2022-04-18T14:24:16Z ... More messages available? True
get_inbox expliqué
Considérez le code dans la get_inbox fonction .
Accès aux dossiers de courrier connus
La fonction génère une requête à l’API Répertorier les messages . Étant donné qu’elle inclut le mail_folders.by_mail_folder_id('inbox') générateur de demandes, 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 get_user 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 get_inbox, l’ajout $top s’effectue avec le top paramètre dans l’objet MessagesRequestBuilderGetQueryParameters .
Remarque
La valeur passée $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) Python fournit la propriété sur les odata_next_link objets de page de collection. Si cette propriété est présente, d’autres résultats sont disponibles.
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. Dans get_inbox, l’ajout $orderby s’effectue avec le orderby paramètre dans l’objet MessagesRequestBuilderGetQueryParameters .
Envoyer un message
Ajoutez maintenant la possibilité d’envoyer un e-mail en tant qu’utilisateur authentifié.
Ajoutez la fonction suivante à graph.py.
async def send_mail(self, subject: str, body: str, recipient: str): message = Message() message.subject = subject message.body = ItemBody() message.body.content_type = BodyType.Text message.body.content = body to_recipient = Recipient() to_recipient.email_address = EmailAddress() to_recipient.email_address.address = recipient message.to_recipients = [] message.to_recipients.append(to_recipient) request_body = SendMailPostRequestBody() request_body.message = message await self.user_client.me.send_mail.post(body=request_body)Remplacez la fonction vide
send_maildans main.py par ce qui suit.async def send_mail(graph: Graph): # Send mail to the signed-in user # Get the user for their email address user = await graph.get_user() if user: user_email = user.mail or user.user_principal_name await graph.send_mail('Testing Microsoft Graph', 'Hello world!', user_email or '') print('Mail sent.\n')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.
Pour vérifier que le message a été reçu, choisissez l’option 2 pour répertorier votre boîte de réception.
send_mail expliqué
Considérez le code dans la send_mail fonction .
Envoi de messages
La fonction utilise le générateur de user_client.me.send_mail requêtes, qui génère une requête à l’API Envoyer un courrier .
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 dictionnaire représentant la charge utile de la requête, 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.