Crear aplicaciones Java con Microsoft Graph

Artículo
Developer (Principiante)
Tiempo para finalizar: 28 minutos

En este tutorial se explica cómo crear una aplicación de consola de Java que use microsoft Graph API para acceder a los datos en nombre de un usuario.

Nota:

Para obtener información sobre cómo usar Microsoft Graph para acceder a los datos mediante la autenticación de solo aplicación, consulte este tutorial de autenticación de solo aplicación.

En este tutorial, aprenderá a:

Sugerencia

Como alternativa a seguir este tutorial, puede descargar el código completado a través de la herramienta de inicio rápido , que automatiza el registro y la configuración de aplicaciones. El código descargado funciona sin necesidad de realizar modificaciones.

También puede descargar o clonar el repositorio de GitHub y seguir las instrucciones del ARCHIVO LÉAME para registrar una aplicación y configurar el proyecto.

Requisitos previos

Antes de iniciar este tutorial, debe tener instalados java SE Development Kit (JDK) y Gradle en la máquina de desarrollo.

También debe tener una cuenta microsoft personal con un buzón en Outlook.com o una cuenta profesional o educativa de Microsoft. Si no tiene una cuenta microsoft, hay un par de opciones para obtener una cuenta gratuita:

Puede registrarse para obtener una nueva cuenta personal de Microsoft.
Puede registrarse en el Programa para desarrolladores de Microsoft 365 para obtener una suscripción gratuita a Microsoft 365.

Nota:

Este tutorial se escribió con OpenJDK versión 17.0.2 y Gradle 7.4.2. Los pasos de esta guía pueden funcionar con otras versiones, pero no se han probado.

Registrar la aplicación en el portal

27 minutos restantes

En este ejercicio registrará una nueva aplicación en Azure Active Directory para habilitar la autenticación de usuario. Puede registrar una aplicación mediante el Centro de administración de Azure Active Directory o mediante el SDK de PowerShell de Microsoft Graph.

Registro de la aplicación para la autenticación de usuario

En esta sección registrará una aplicación que admitirá la autenticación de usuario mediante el flujo de código de dispositivo.

Centro de administración de Azure AD
PowerShell

Abra un explorador y vaya al centro de administración de Azure Active Directory e inicie sesión con una cuenta personal (también conocida como: cuenta Microsoft) o una cuenta profesional o educativa.
Seleccione Azure Active Directory en el panel de navegación izquierdo y, a continuación, seleccione Registros de aplicaciones en Administrar.
Seleccione Nuevo registro. Escriba un nombre para la aplicación, por ejemplo, Java Graph Tutorial.

Establezca los tipos de cuenta admitidos como desee. Las opciones son:

Opción	¿Quién puede iniciar sesión?
Solo las cuentas de este directorio organizativo	Solo los usuarios de la organización de Microsoft 365
Cuentas en cualquier directorio organizativo	Usuarios de cualquier organización de Microsoft 365 (cuentas profesionales o educativas)
Cuentas en cualquier directorio organizativo... y cuentas personales de Microsoft	Usuarios de cualquier organización de Microsoft 365 (cuentas profesionales o educativas) y cuentas personales de Microsoft

Deje URI de redireccionamiento vacía.
Seleccione Registrar. En la página Información general de la aplicación, copie el valor del identificador de aplicación (cliente) y guárdelo, lo necesitará en el paso siguiente. Si eligió Cuentas en este directorio organizativo solo para los tipos de cuenta admitidos, copie también el identificador de directorio (inquilino) y guárdelo.
Seleccione Autenticación en Administrar. Busque la sección Configuración avanzada y cambie el botón de alternancia Permitir flujos de cliente público a Sí y, a continuación, elija Guardar.

Para usar PowerShell, necesitará el SDK de PowerShell de Microsoft Graph. Si no lo tiene, consulte Instalación del SDK de PowerShell de Microsoft Graph para obtener instrucciones de instalación.

Importante

El script de PowerShell requiere una cuenta profesional o educativa con el administrador de aplicaciones, el administrador de aplicaciones en la nube o Administrador global rol. Si la cuenta tiene el rol Desarrollador de aplicaciones, puede registrarse en el Centro de administración de Azure AD.

Cree un nuevo archivo denominado RegisterAppForUserAuth.ps1 y agregue el código siguiente.

param(
  [Parameter(Mandatory=$true,
  HelpMessage="The friendly name of the app registration")]
  [String]
  $AppName,

  [Parameter(Mandatory=$false,
  HelpMessage="The sign in audience for the app")]
  [ValidateSet("AzureADMyOrg", "AzureADMultipleOrgs", `
  "AzureADandPersonalMicrosoftAccount", "PersonalMicrosoftAccount")]
  [String]
  $SignInAudience = "AzureADandPersonalMicrosoftAccount",

  [Parameter(Mandatory=$false)]
  [Switch]
  $StayConnected = $false
)

# Tenant to use in authentication.
# See https://learn.microsoft.com/azure/active-directory/develop/v2-oauth2-device-code#device-authorization-request
$authTenant = switch ($SignInAudience)
{
  "AzureADMyOrg" { "tenantId" }
  "AzureADMultipleOrgs" { "organizations" }
  "AzureADandPersonalMicrosoftAccount" { "common" }
  "PersonalMicrosoftAccount" { "consumers" }
  default { "invalid" }
}

if ($authTenant -eq "invalid")
{
  Write-Host -ForegroundColor Red "Invalid sign in audience:" $SignInAudience
  Exit
}

# Requires an admin
Connect-MgGraph -Scopes "Application.ReadWrite.All User.Read" -UseDeviceAuthentication -ErrorAction Stop

# Get context for access to tenant ID
$context = Get-MgContext -ErrorAction Stop

if ($authTenant -eq "tenantId")
{
  $authTenant = $context.TenantId
}

# Create app registration
$appRegistration = New-MgApplication -DisplayName $AppName -SignInAudience $SignInAudience `
 -IsFallbackPublicClient -ErrorAction Stop
Write-Host -ForegroundColor Cyan "App registration created with app ID" $appRegistration.AppId

# Create corresponding service principal
if ($SignInAudience -ne "PersonalMicrosoftAccount")
{
  New-MgServicePrincipal -AppId $appRegistration.AppId -ErrorAction SilentlyContinue `
   -ErrorVariable SPError | Out-Null
  if ($SPError)
  {
    Write-Host -ForegroundColor Red "A service principal for the app could not be created."
    Write-Host -ForegroundColor Red $SPError
    Exit
  }

  Write-Host -ForegroundColor Cyan "Service principal created"
}

Write-Host
Write-Host -ForegroundColor Green "SUCCESS"
Write-Host -ForegroundColor Cyan -NoNewline "Client ID: "
Write-Host -ForegroundColor Yellow $appRegistration.AppId
Write-Host -ForegroundColor Cyan -NoNewline "Auth tenant: "
Write-Host -ForegroundColor Yellow $authTenant

if ($StayConnected -eq $false)
{
  Disconnect-MgGraph
  Write-Host "Disconnected from Microsoft Graph"
}
else
{
  Write-Host
  Write-Host -ForegroundColor Yellow `
   "The connection to Microsoft Graph is still active. To disconnect, use Disconnect-MgGraph"
}

Guarde el archivo.
Abra PowerShell y cambie el directorio actual a la ubicación de RegisterAppForUserAuth.ps1.

Ejecute el siguiente comando y reemplace <audience-value> por el valor deseado (consulte la tabla siguiente).

.\RegisterAppForUserAuth.ps1 -AppName "Java Graph Tutorial" -SignInAudience <audience-value>

Valor de SignInAudience	¿Quién puede iniciar sesión?
`AzureADMyOrg`	Solo los usuarios de la organización de Microsoft 365
`AzureADMultipleOrgs`	Usuarios de cualquier organización de Microsoft 365 (cuentas profesionales o educativas)
`AzureADandPersonalMicrosoftAccount`	Usuarios de cualquier organización de Microsoft 365 (cuentas profesionales o educativas) y cuentas personales de Microsoft
`PersonalMicrosoftAccount`	Solo cuentas personales de Microsoft

Siga el símbolo del sistema para abrir https://microsoft.com/devicelogin en un explorador, escriba el código proporcionado y complete el proceso de autenticación.
Copie los valores de id. de cliente y inquilino de autenticación de la salida del script. Necesitará estos valores en el paso siguiente.
```
SUCCESS
Client ID: 2fb1652f-a9a0-4db9-b220-b224b8d9d38b
Auth tenant: common
```

Nota:

Tenga en cuenta que no ha configurado ningún permiso de Microsoft Graph en el registro de la aplicación. Esto se debe a que el ejemplo usará el consentimiento dinámico para solicitar permisos específicos para la autenticación de usuarios.

Crear una aplicación de consola de Java

25 minutos restantes

En esta sección creará una aplicación de consola básica de Java.

Abra la interfaz de línea de comandos (CLI) en un directorio donde quiera crear el proyecto. Ejecute el siguiente comando para crear un nuevo proyecto de Gradle.
```
gradle init --dsl groovy --test-framework junit --type java-application --project-name graphtutorial --package graphtutorial
```
Una vez creado el proyecto, compruebe que funciona ejecutando el siguiente comando para ejecutar la aplicación en la CLI.
```
./gradlew --console plain run
```
Si funciona, la aplicación debe generar Hello World..

Instalar dependencias

Antes de continuar, agregue algunas dependencias adicionales que usará más adelante.

Biblioteca cliente de Identidad de Azure para Java para autenticar al usuario y adquirir tokens de acceso.
SDK de Microsoft Graph para Java para realizar llamadas a Microsoft Graph.

Abra ./app/build.gradle. Actualice la dependencies sección para agregar esas dependencias.

dependencies {
    // Use JUnit test framework.
    testImplementation 'junit:junit:4.13.2'

    // This dependency is used by the application.
    implementation 'com.google.guava:guava:31.1-jre'
    implementation 'com.azure:azure-identity:1.7.1'
    implementation 'com.microsoft.graph:microsoft-graph:5.42.0'
}

Agregue lo siguiente al final de ./app/build.gradle.
```
run {
    standardInput = System.in
}
```
La próxima vez que compile el proyecto, Gradle descargará esas dependencias.

Cargar la configuración de la aplicación

En esta sección agregará los detalles del registro de la aplicación al proyecto.

Cree un nuevo directorio denominado graphtutorial en el directorio ./app/src/main/resources .
Cree un nuevo archivo en el directorio ./app/src/main/resources/graphtutorial denominado oAuth.properties y agregue el texto siguiente en ese archivo.
```
app.clientId=YOUR_CLIENT_ID_HERE
app.tenantId=common
app.graphUserScopes=user.read,mail.read,mail.send
```

Actualice los valores según la tabla siguiente.

Configuración	Valor
`app.clientId`	El identificador de cliente del registro de la aplicación
`app.tenantId`	Si eligió la opción para permitir que solo los usuarios de su organización inicien sesión, cambie este valor por el identificador de inquilino. De lo contrario, deje como `common`.

Importante

Si usa el control de código fuente como git, ahora sería un buen momento para excluir el archivo oAuth.properties del control de código fuente para evitar la pérdida accidental del identificador de aplicación.

Diseñar la aplicación

En esta sección creará un menú simple basado en consola.

Abra ./app/src/main/java/graphtutorial/App.java y agregue las siguientes import instrucciones.

package graphtutorial;

import java.io.IOException;
import java.time.ZoneId;
import java.time.format.DateTimeFormatter;
import java.time.format.FormatStyle;
import java.util.InputMismatchException;
import java.util.Properties;
import java.util.Scanner;

import com.microsoft.graph.models.Message;
import com.microsoft.graph.models.User;
import com.microsoft.graph.requests.MessageCollectionPage;

Reemplace la función main existente por lo siguiente.

public static void main(String[] args) {
    System.out.println("Java Graph Tutorial");
    System.out.println();

    final Properties oAuthProperties = new Properties();
    try {
        oAuthProperties.load(App.class.getResourceAsStream("oAuth.properties"));
    } catch (IOException e) {
        System.out.println("Unable to read OAuth configuration. Make sure you have a properly formatted oAuth.properties file. See README for details.");
        return;
    }

    initializeGraph(oAuthProperties);

    greetUser();

    Scanner input = new Scanner(System.in);

    int choice = -1;

    while (choice != 0) {
        System.out.println("Please choose one of the following options:");
        System.out.println("0. Exit");
        System.out.println("1. Display access token");
        System.out.println("2. List my inbox");
        System.out.println("3. Send mail");
        System.out.println("4. Make a Graph call");

        try {
            choice = input.nextInt();
        } catch (InputMismatchException ex) {
            // Skip over non-integer input
        }

        input.nextLine();

        // Process user choice
        switch(choice) {
            case 0:
                // Exit the program
                System.out.println("Goodbye...");
                break;
            case 1:
                // Display access token
                displayAccessToken();
                break;
            case 2:
                // List emails from user's inbox
                listInbox();
                break;
            case 3:
                // Send an email message
                sendMail();
                break;
            case 4:
                // Run any Graph code
                makeGraphCall();
                break;
            default:
                System.out.println("Invalid choice");
        }
    }

    input.close();
}

Agregue los siguientes métodos de marcador de posición al final del archivo. Los implementará en pasos posteriores.

private static void initializeGraph(Properties properties) {
    // TODO
}

private static void greetUser() {
    // TODO
}

private static void displayAccessToken() {
    // TODO
}

private static void listInbox() {
    // TODO
}

private static void sendMail() {
    // TODO
}

private static void makeGraphCall() {
    // TODO
}

Esto implementa un menú básico y lee la elección del usuario desde la línea de comandos.

Elimine ./app/src/test/java/graphtutorial/AppTest.java.

Agregar autenticación de usuario

19 minutos restantes

En esta sección ampliará la aplicación del ejercicio anterior para admitir la autenticación con Azure AD. Esto es necesario para obtener el token de acceso de OAuth necesario para llamar a Microsoft Graph. En este paso, integrará la biblioteca cliente de Azure Identity para Java en la aplicación y configurará la autenticación para el SDK de Microsoft Graph para Java.

La biblioteca de identidades de Azure proporciona varias clases que implementan flujos de TokenCredential token de OAuth2. La biblioteca cliente de Microsoft Graph usa esas clases para autenticar llamadas a Microsoft Graph.

Configuración del cliente de Graph para la autenticación de usuario

En esta sección usará la DeviceCodeCredential clase para solicitar un token de acceso mediante el flujo de código del dispositivo.

Cree un nuevo archivo en el directorio ./app/src/main/java/graphtutorial denominado Graph.java y agregue el código siguiente a ese archivo.

package graphtutorial;

import java.util.Arrays;
import java.util.List;
import java.util.Properties;
import java.util.function.Consumer;

import com.azure.core.credential.AccessToken;
import com.azure.core.credential.TokenRequestContext;
import com.azure.identity.DeviceCodeCredential;
import com.azure.identity.DeviceCodeCredentialBuilder;
import com.azure.identity.DeviceCodeInfo;
import com.microsoft.graph.authentication.TokenCredentialAuthProvider;
import com.microsoft.graph.models.BodyType;
import com.microsoft.graph.models.EmailAddress;
import com.microsoft.graph.models.ItemBody;
import com.microsoft.graph.models.Message;
import com.microsoft.graph.models.Recipient;
import com.microsoft.graph.models.User;
import com.microsoft.graph.models.UserSendMailParameterSet;
import com.microsoft.graph.requests.GraphServiceClient;
import com.microsoft.graph.requests.MessageCollectionPage;

import okhttp3.Request;

Agregue una definición de clase graph vacía.
```
public class Graph {
}
```

Agregue el código siguiente a la clase Graph.

private static Properties _properties;
private static DeviceCodeCredential _deviceCodeCredential;
private static GraphServiceClient<Request> _userClient;

public static void initializeGraphForUserAuth(Properties properties, Consumer<DeviceCodeInfo> challenge) throws Exception {
    // Ensure properties isn't null
    if (properties == null) {
        throw new Exception("Properties cannot be null");
    }

    _properties = properties;

    final String clientId = properties.getProperty("app.clientId");
    final String tenantId = properties.getProperty("app.tenantId");
    final List<String> graphUserScopes = Arrays
        .asList(properties.getProperty("app.graphUserScopes").split(","));

    _deviceCodeCredential = new DeviceCodeCredentialBuilder()
        .clientId(clientId)
        .tenantId(tenantId)
        .challengeConsumer(challenge)
        .build();

    final TokenCredentialAuthProvider authProvider =
        new TokenCredentialAuthProvider(graphUserScopes, _deviceCodeCredential);

    _userClient = GraphServiceClient.builder()
        .authenticationProvider(authProvider)
        .buildClient();
}

Reemplace la función vacía initializeGraph en App.java por lo siguiente.

private static void initializeGraph(Properties properties) {
    try {
        Graph.initializeGraphForUserAuth(properties,
            challenge -> System.out.println(challenge.getMessage()));
    } catch (Exception e)
    {
        System.out.println("Error initializing Graph for user auth");
        System.out.println(e.getMessage());
    }
}

Este código declara dos propiedades privadas, un DeviceCodeCredential objeto y un GraphServiceClient objeto . La InitializeGraphForUserAuth función crea una nueva instancia de DeviceCodeCredentialy, a continuación, usa esa instancia para crear una nueva instancia de GraphServiceClient. Cada vez que se realiza una llamada API a Microsoft Graph a través de _userClient, usará la credencial proporcionada para obtener un token de acceso.

Prueba de DeviceCodeCredential

A continuación, agregue código para obtener un token de acceso de DeviceCodeCredential.

Agregue la siguiente función a la clase Graph.

public static String getUserToken() throws Exception {
    // Ensure credential isn't null
    if (_deviceCodeCredential == null) {
        throw new Exception("Graph has not been initialized for user auth");
    }

    final String[] graphUserScopes = _properties.getProperty("app.graphUserScopes").split(",");

    final TokenRequestContext context = new TokenRequestContext();
    context.addScopes(graphUserScopes);

    final AccessToken token = _deviceCodeCredential.getToken(context).block();
    return token.getToken();
}

Reemplace la función vacía displayAccessToken en App.java por lo siguiente.

private static void displayAccessToken() {
    try {
        final String accessToken = Graph.getUserToken();
        System.out.println("Access token: " + accessToken);
    } catch (Exception e) {
        System.out.println("Error getting access token");
        System.out.println(e.getMessage());
    }
}

Compile y ejecute la aplicación. Escriba 1 cuando se le solicite una opción. La aplicación muestra una dirección URL y un código de dispositivo.

Java Graph Tutorial

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
1
To sign in, use a web browser to open the page https://microsoft.com/devicelogin and
enter the code RB2RUD56D to authenticate.

Abra un explorador y vaya a la dirección URL que se muestra. Escriba el código proporcionado e inicie sesión.

Importante

Tenga en cuenta cualquier cuenta de Microsoft 365 existente que haya iniciado sesión en el explorador al navegar a https://microsoft.com/devicelogin. Use características del explorador como perfiles, modo invitado o modo privado para asegurarse de autenticarse como la cuenta que quiere usar para las pruebas.
Una vez completado, vuelva a la aplicación para ver el token de acceso.

Sugerencia

Solo con fines de validación y depuración, puede descodificar tokens de acceso de usuario (solo para cuentas profesionales o educativas) mediante el analizador de tokens en línea de Microsoft en https://jwt.ms. Esto puede ser útil si encuentra errores de token al llamar a Microsoft Graph. Por ejemplo, comprobar que la scp notificación del token contiene los ámbitos de permiso de Microsoft Graph esperados.

Obtener usuario

14 minutos restantes

En esta sección incorporará Microsoft Graph a la aplicación. Para esta aplicación, usará la biblioteca cliente java de Microsoft Graph para realizar llamadas a Microsoft Graph.

Abra Graph.java y agregue la siguiente función a la clase Graph .

public static User getUser() throws Exception {
    // Ensure client isn't null
    if (_userClient == null) {
        throw new Exception("Graph has not been initialized for user auth");
    }

    return _userClient.me()
        .buildRequest()
        .select("displayName,mail,userPrincipalName")
        .get();
}

Reemplace la función vacía greetUser en App.java por lo siguiente.

private static void greetUser() {
    try {
        final User user = Graph.getUser();
        // For Work/school accounts, email is in mail property
        // Personal accounts, email is in userPrincipalName
        final String email = user.mail == null ? user.userPrincipalName : user.mail;
        System.out.println("Hello, " + user.displayName + "!");
        System.out.println("Email: " + email);
    } catch (Exception e) {
        System.out.println("Error getting user");
        System.out.println(e.getMessage());
    }
}

Si ejecuta la aplicación ahora, después de iniciar sesión en la aplicación le da la bienvenida por nombre.

Hello, Megan Bowen!
Email: MeganB@contoso.com

Código explicado

Tenga en cuenta el código de la greetUser función . Son solo unas pocas líneas, pero hay algunos detalles clave que debe tener en cuenta.

Acceso a 'me'

La función usa el generador de _userClient.me solicitudes, que compila una solicitud para obtener la API de usuario . Esta API es accesible de dos maneras:

GET /me
GET /users/{user-id}

En este caso, el código llamará al punto de conexión de API GET /me . Se trata de un método abreviado para obtener el usuario autenticado sin conocer su identificador de usuario.

Nota:

Dado que el GET /me punto de conexión de API obtiene el usuario autenticado, solo está disponible para las aplicaciones que usan la autenticación de usuario. Las aplicaciones de autenticación de solo aplicación no pueden acceder a este punto de conexión.

Solicitud de propiedades específicas

La función usa el select método en la solicitud para especificar el conjunto de propiedades que necesita. Esto agrega el parámetro de consulta $select a la llamada API.

Tipo de valor devuelto fuertemente tipado

La función devuelve un com.microsoft.graph.models.User objeto deserializado a partir de la respuesta JSON de la API. Dado que el código usa select, solo las propiedades solicitadas tendrán valores en el objeto devuelto User . Todas las demás propiedades tendrán valores predeterminados.

Bandeja de entrada de lista

11 minutos restantes

En esta sección agregará la capacidad de enumerar los mensajes en la bandeja de entrada de correo electrónico del usuario.

Abra Graph.java y agregue la siguiente función a la clase Graph .

public static MessageCollectionPage getInbox() throws Exception {
    // Ensure client isn't null
    if (_userClient == null) {
        throw new Exception("Graph has not been initialized for user auth");
    }

    return _userClient.me()
        .mailFolders("inbox")
        .messages()
        .buildRequest()
        .select("from,isRead,receivedDateTime,subject")
        .top(25)
        .orderBy("receivedDateTime DESC")
        .get();
}

Reemplace la función vacía listInbox en App.java por lo siguiente.

private static void listInbox() {
    try {
        final MessageCollectionPage messages = Graph.getInbox();

        // Output each message's details
        for (Message message: messages.getCurrentPage()) {
            System.out.println("Message: " + message.subject);
            System.out.println("  From: " + message.from.emailAddress.name);
            System.out.println("  Status: " + (message.isRead ? "Read" : "Unread"));
            System.out.println("  Received: " + message.receivedDateTime
                // Values are returned in UTC, convert to local time zone
                .atZoneSameInstant(ZoneId.systemDefault()).toLocalDateTime()
                .format(DateTimeFormatter.ofLocalizedDateTime(FormatStyle.SHORT)));
        }

        final Boolean moreMessagesAvailable = messages.getNextPage() != null;
        System.out.println("\nMore messages available? " + moreMessagesAvailable);
    } catch (Exception e) {
        System.out.println("Error getting inbox");
        System.out.println(e.getMessage());
    }
}

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: 12/30/2021, 4:54:54 AM
Message: Employee Initiative Thoughts
  From: Patti Fernandez
  Status: Read
  Received: 12/28/2021, 5:01:10 PM
Message: Voice Mail (11 seconds)
  From: Alex Wilber
  Status: Unread
  Received: 12/28/2021, 5:00:46 PM
Message: Our Spring Blog Update
  From: Alex Wilber
  Status: Unread
  Received: 12/28/2021, 4:49:46 PM
Message: Atlanta Flight Reservation
  From: Alex Wilber
  Status: Unread
  Received: 12/28/2021, 4:35:42 PM
Message: Atlanta Trip Itinerary - down time
  From: Alex Wilber
  Status: Unread
  Received: 12/28/2021, 4:22:04 PM

...

More messages available? true

Código explicado

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

Acceso a carpetas de correo conocidas

La función usa el generador de _userClient.me().mailFolders("inbox").messages() solicitudes, que compila una solicitud para list messages API. Dado que incluye el mailFolders("inbox") generador de solicitudes, la API solo devolverá 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 getUser 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 sola 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 siguiente "página".

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 getInbox, esto se logra con el .top(25) método .

Nota:

El valor pasado a .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 la colección incluyen una @odata.nextLink propiedad con una dirección URL de API para acceder a la página siguiente. La biblioteca cliente de Java expone esto como el método en objetos getNextPage de página de colección. Si este método devuelve valores no NULL, hay más resultados disponibles.

Ordenar colecciones

La función usa el orderBy método en la solicitud 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. Esto agrega el parámetro de consulta $orderby a la llamada API.

Enviar correo

8 minutos restantes

En esta sección agregará la capacidad de enviar un mensaje de correo electrónico como usuario autenticado.

Abra Graph.java y agregue la siguiente función a la clase Graph .

public static void sendMail(String subject, String body, String recipient) throws Exception {
    // Ensure client isn't null
    if (_userClient == null) {
        throw new Exception("Graph has not been initialized for user auth");
    }

    // Create a new message
    final Message message = new Message();
    message.subject = subject;
    message.body = new ItemBody();
    message.body.content = body;
    message.body.contentType = BodyType.TEXT;

    final Recipient toRecipient = new Recipient();
    toRecipient.emailAddress = new EmailAddress();
    toRecipient.emailAddress.address = recipient;
    message.toRecipients = List.of(toRecipient);

    // Send the message
    _userClient.me()
        .sendMail(UserSendMailParameterSet.newBuilder()
            .withMessage(message)
            .build())
        .buildRequest()
        .post();
}

Reemplace la función vacía sendMail en App.java por lo siguiente.

private static void sendMail() {
    try {
        // Send mail to the signed-in user
        // Get the user for their email address
        final User user = Graph.getUser();
        final String email = user.mail == null ? user.userPrincipalName : user.mail;

        Graph.sendMail("Testing Microsoft Graph", "Hello world!", email);
        System.out.println("\nMail sent.");
    } catch (Exception e) {
        System.out.println("Error sending mail");
        System.out.println(e.getMessage());
    }
}

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 está realizando 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 esto le sucede, póngase en contacto con el soporte técnico a través de la Centro de administración de Microsoft 365.
Para comprobar que se ha recibido el mensaje, elija la opción 2 para mostrar la bandeja de entrada.

Código explicado

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

Envío de correo

La función usa el generador de _userClient.me().sendMail() solicitudes, que compila una solicitud a send mail API. El generador de solicitudes toma un UserSendMailParameterSet objeto que contiene el mensaje que se va a enviar.

Creación de objetos

A diferencia de las llamadas anteriores a Microsoft Graph que solo leen datos, esta llamada crea datos. Para ello con la biblioteca cliente, cree una instancia de la clase que representa los datos (en este caso, com.microsoft.graph.models.Message) mediante la new palabra clave , establezca las propiedades deseadas y, a continuación, envíelas en la llamada API. Dado que la llamada envía datos, se usa el post método en lugar de get.

Opcional: agregue su propio código

5 minutos restantes

En esta sección agregará sus propias funcionalidades de Microsoft Graph a la aplicación. Podría tratarse de un fragmento de código de la documentación de Microsoft Graph o del Explorador de Graph, o código que haya creado. Esta sección es opcional.

Actualizar la aplicación

Abra Graph.java y agregue la siguiente función a la clase Graph .

public static void makeGraphCall() {
    // INSERT YOUR CODE HERE
}

Reemplace la función vacía MakeGraphCallAsync en App.java por lo siguiente.

private static void makeGraphCall() {
    try {
        Graph.makeGraphCall();
    } catch (Exception e) {
        System.out.println("Error making Graph call");
        System.out.println(e.getMessage());
    }
}

Elección de una API

Busque una API en Microsoft Graph que le gustaría probar. Por ejemplo, create event API. Puede usar uno de los ejemplos de la documentación de la API, o puede personalizar una solicitud de API en el Explorador de Graph y usar el fragmento de código generado.

Configurar permisos

Compruebe la sección Permisos de la documentación de referencia de la API elegida para ver qué métodos de autenticación se admiten. Algunas API no admiten solo aplicaciones ni cuentas personales de Microsoft, por ejemplo.

Para llamar a una API con autenticación de usuario (si la API admite la autenticación de usuario (delegado), agregue el ámbito de permiso necesario en oAuth.properties.
Para llamar a una API con autenticación solo de aplicación, consulte el tutorial de autenticación de solo aplicación .

Agregar el código

Copie el código en la makeGraphCallAsync función de Graph.java. Si va a copiar un fragmento de código de la documentación o del Explorador de Graph, asegúrese de cambiar el GraphServiceClient nombre a _userClient.

Crear aplicaciones Java con Microsoft Graph

Requisitos previos

Registrar la aplicación en el portal

Registro de la aplicación para la autenticación de usuario

Crear una aplicación de consola de Java

Instalar dependencias

Cargar la configuración de la aplicación

Diseñar la aplicación

Agregar autenticación de usuario

Configuración del cliente de Graph para la autenticación de usuario

Prueba de DeviceCodeCredential

Obtener usuario

Código explicado

Acceso a 'me'

Solicitud de propiedades específicas

Tipo de valor devuelto fuertemente tipado

Bandeja de entrada de lista

Código explicado

Acceso a carpetas de correo conocidas

Acceso a una colección

Tamaños de página predeterminados

Obtención de páginas posteriores

Ordenar colecciones

Enviar correo

Código explicado

Envío de correo

Creación de objetos

Opcional: agregue su propio código

Actualizar la aplicación

Elección de una API

Configurar permisos

Agregar el código

¡Enhorabuena!

Ejemplos de Java