Compartir a través de


Adición de funcionalidades de correo electrónico a aplicaciones de Python mediante Microsoft Graph

En este artículo, ampliará la aplicación que creó en Compilación de aplicaciones de Python con Microsoft Graph con las API de correo de Microsoft Graph. Use Microsoft Graph para enumerar la bandeja de entrada del usuario y enviar un correo electrónico.

Bandeja de entrada del usuario de lista

Empiece enumerando los mensajes en la bandeja de entrada de correo electrónico del usuario.

  1. Agregue la siguiente función a 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 messages
    
  2. Reemplace la función vacía list_inbox de main.py por lo siguiente.

    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')
    
  3. Ejecute la aplicación, inicie sesión y elija la opción 2 para mostrar la bandeja de entrada.

    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 explicado

Tenga en cuenta el código de la get_inbox función .

Acceso a carpetas de correo conocidas

La función compila una solicitud a list messages API. Dado que incluye el mail_folders.by_mail_folder_id('inbox') generador de solicitudes, la API solo devuelve mensajes en la carpeta de correo solicitada. En este caso, dado que la bandeja de entrada es una carpeta predeterminada y conocida dentro del buzón de un usuario, es accesible a través de su nombre conocido. Se obtiene acceso a las carpetas no predeterminadas de la misma manera, reemplazando el nombre conocido por la propiedad ID de la carpeta de correo. Para obtener más información sobre los nombres de carpeta conocidos disponibles, consulte tipo de recurso mailFolder.

Acceso a una colección

A diferencia de la get_user función de la sección anterior, que devuelve un único objeto, este método devuelve una colección de mensajes. La mayoría de las API de Microsoft Graph que devuelven una colección no devuelven todos los resultados disponibles en una única respuesta. En su lugar, usan la paginación para devolver una parte de los resultados al tiempo que proporcionan un método para que los clientes soliciten la página siguiente.

Tamaños de página predeterminados

Las API que usan la paginación implementan un tamaño de página predeterminado. En el caso de los mensajes, el valor predeterminado es 10. Los clientes pueden solicitar más (o menos) mediante el parámetro de consulta $top . En get_inbox, la adición $top se realiza con el top parámetro en el MessagesRequestBuilderGetQueryParameters objeto .

Nota:

El valor pasado en $top es un límite superior, no un número explícito. La API devuelve una serie de mensajes hasta el valor especificado.

Obtención de páginas posteriores

Si hay más resultados disponibles en el servidor, las respuestas de colección incluyen una @odata.nextLink propiedad con una dirección URL de API para acceder a la página siguiente. El SDK de Python proporciona la odata_next_link propiedad en objetos de página de colección. Si esta propiedad está presente, hay más resultados disponibles.

Ordenar colecciones

La función usa el parámetro de consulta $orderby para solicitar resultados ordenados por el momento en que se recibe el mensaje (receivedDateTime propiedad). Incluye la DESC palabra clave para que los mensajes recibidos más recientemente aparezcan primero. En get_inbox, la adición $orderby se realiza con el orderby parámetro en el MessagesRequestBuilderGetQueryParameters objeto .

Enviar correo

Ahora agregue la capacidad de enviar un mensaje de correo electrónico como usuario autenticado.

  1. Agregue la siguiente función a 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)
    
  2. Reemplace la función vacía send_mail de main.py por lo siguiente.

    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')
    
  3. Ejecute la aplicación, inicie sesión y elija la opción 3 para enviarse un correo electrónico.

    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.
    

    Nota:

    Si va a realizar pruebas con un inquilino para desarrolladores del Programa para desarrolladores de Microsoft 365, es posible que el correo electrónico que envíe no se entregue y que reciba un informe de no entrega. Si desea desbloquear el envío de correo desde el inquilino, póngase en contacto con el soporte técnico a través de la Centro de administración de Microsoft 365.

  4. Para comprobar que se ha recibido el mensaje, elija la opción 2 para mostrar la bandeja de entrada.

send_mail explicado

Tenga en cuenta el código de la send_mail función .

Envío de correo

La función usa el generador de user_client.me.send_mail solicitudes, que compila una solicitud a send mail API.

Creación de objetos

A diferencia de las llamadas anteriores a Microsoft Graph que solo leen datos, esta llamada crea datos. Para crear elementos con la biblioteca cliente, cree un diccionario que represente la carga de la solicitud, establezca las propiedades deseadas y, a continuación, envíela en la llamada API. Dado que la llamada envía datos, se usa el post método en lugar de get.

Paso siguiente