Criar aplicativos Java com o Microsoft Graph

Artigo
Developer (Iniciante)
28 minutos para concluir

Este tutorial ensina-o a criar uma aplicação de consola Java que utiliza a Microsoft Graph API para aceder a dados em nome de um utilizador.

Observação

Para saber como utilizar o Microsoft Graph para aceder a dados através da autenticação apenas de aplicações, veja este tutorial de autenticação apenas de aplicações.

Neste tutorial, você vai:

Dica

Como alternativa a seguir este tutorial, pode transferir o código concluído através da ferramenta de início rápido , que automatiza o registo e a configuração de aplicações. O código transferido funciona sem quaisquer modificações necessárias.

Também pode transferir ou clonar o repositório do GitHub e seguir as instruções no README para registar uma aplicação e configurar o projeto.

Pré-requisitos

Antes de iniciar este tutorial, deve ter o Java SE Development Kit (JDK) e o Gradle instalados no seu computador de desenvolvimento.

Também deve ter uma conta escolar ou profissional da Microsoft com uma caixa de correio do Exchange Online. Se não tiver um inquilino do Microsoft 365, poderá qualificar-se para um através do Programa para Programadores do Microsoft 365; para obter detalhes, veja as FAQ. Em alternativa, pode inscrever-se numa avaliação gratuita de um mês ou comprar um plano do Microsoft 365.

Observação

Este tutorial foi escrito com a versão 17.0.2 e Gradle 7.4.2 do OpenJDK. Os passos neste guia podem funcionar com outras versões, mas isso não foi testado.

Registrar o aplicativo no portal

27 minutos restantes

Neste exercício, irá registar uma nova aplicação no Azure Active Directory para ativar a autenticação de utilizadores. Pode registar uma aplicação através do centro de administração do Microsoft Entra ou através do SDK do PowerShell do Microsoft Graph.

Registar aplicação para autenticação de utilizador

Nesta secção, irá registar uma aplicação que suporta a autenticação de utilizador através do fluxo de código do dispositivo.

Centro de administração do Microsoft Entra
PowerShell

Abra um browser e navegue para o centro de administração do Microsoft Entra e inicie sessão com uma conta de Administrador global.
Selecione Microsoft Entra ID no painel de navegação esquerdo, expanda Identidade, expanda Aplicações e, em seguida, selecione Registos de aplicações.
Selecione Novo registro. Introduza um nome para a sua aplicação, por exemplo, Graph User Auth Tutorial.

Defina Tipos de conta suportados conforme pretendido. As opções são:

Opção	Quem pode iniciar sessão?
Contas apenas neste diretório organizacional	Apenas utilizadores na sua organização do Microsoft 365
Contas em qualquer diretório organizacional	Utilizadores em qualquer organização do Microsoft 365 (contas escolares ou profissionais)
Contas em qualquer diretório organizacional... e contas Microsoft pessoais	Utilizadores em qualquer organização do Microsoft 365 (contas escolares ou profissionais) e contas Microsoft pessoais

Deixe o URI de Redirecionamento vazio.
Selecione Registrar. Na página Descrição Geral da aplicação, copie o valor do ID da Aplicação (cliente) e guarde-o, irá precisar dele no próximo passo. Se escolheu Contas neste diretório organizacional apenas para Tipos de conta suportados, copie também o ID do Diretório (inquilino) e guarde-o.
Selecione Autenticação em Gerenciar. Localize a secção Definições avançadas e altere o botão de alternar Permitir fluxos de cliente públicos para Sim e, em seguida, selecione Guardar.

Para utilizar o PowerShell, precisará do SDK do PowerShell do Microsoft Graph. Se não o tiver, veja Instalar o SDK do PowerShell do Microsoft Graph para obter instruções de instalação.

Importante

O script do PowerShell requer uma conta escolar/profissional com o Administrador da aplicação, o administrador da aplicação na cloud ou a função de Administrador global. Se a sua conta tiver a função de Programador de aplicações, pode registar-se no centro de administração do Microsoft Entra.

Crie um novo ficheiro com o nomeRegisterAppForUserAuth.ps1 e adicione o seguinte código.

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 | Out-Null
  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"
}

Salve o arquivo.
Abra o PowerShell e altere o diretório atual para a localização de RegisterAppForUserAuth.ps1.

Execute o seguinte comando, substituindo <audience-value> pelo valor pretendido (veja a tabela abaixo).

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

Valor SignInAudience	Quem pode iniciar sessão?
`AzureADMyOrg`	Apenas utilizadores na sua organização do Microsoft 365
`AzureADMultipleOrgs`	Utilizadores em qualquer organização do Microsoft 365 (contas escolares ou profissionais)
`AzureADandPersonalMicrosoftAccount`	Utilizadores em qualquer organização do Microsoft 365 (contas escolares ou profissionais) e contas Microsoft pessoais
`PersonalMicrosoftAccount`	Apenas contas Microsoft pessoais

Siga o pedido para abrir https://microsoft.com/devicelogin num browser, introduza o código fornecido e conclua o processo de autenticação.
Copie os valores do ID de Cliente e do inquilino de Autenticação a partir da saída do script. Irá precisar destes valores no próximo passo.
```
SUCCESS
Client ID: 2fb1652f-a9a0-4db9-b220-b224b8d9d38b
Auth tenant: common
```

Observação

Repare que não configurou quaisquer permissões do Microsoft Graph no registo de aplicações. Isto deve-se ao facto de o exemplo utilizar o consentimento dinâmico para pedir permissões específicas para a autenticação do utilizador.

Criar um aplicativo de console Java

25 minutos restantes

Nesta secção, irá criar uma aplicação de consola Java básica.

Abra a interface de linha de comandos (CLI) num diretório onde pretende criar o projeto. Execute o seguinte comando para criar um novo projeto gradle.
```
gradle init --dsl groovy --test-framework junit --type java-application --project-name graphtutorial --package graphtutorial
```
Assim que o projeto for criado, verifique se funciona ao executar o seguinte comando para executar a aplicação na CLI.
```
./gradlew --console plain run
```
Se funcionar, a aplicação deverá produzir Hello World..

Instalar dependências

Antes de continuar, adicione algumas dependências adicionais que irá utilizar mais tarde.

Biblioteca de cliente da Identidade do Azure para Java para autenticar o utilizador e adquirir tokens de acesso.
SDK do Microsoft Graph para Java para fazer chamadas para o Microsoft Graph.

Abra ./app/build.gradle. Atualize a dependencies secção para adicionar essas dependências.

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

    // This dependency is used by the application.
    implementation 'com.google.guava:guava:33.2.1-jre'
    implementation 'com.azure:azure-identity:1.13.0'
    implementation 'com.microsoft.graph:microsoft-graph:6.13.0'
}

Adicione o seguinte ao fim de ./app/build.gradle.
```
run {
    standardInput = System.in
}
```
Da próxima vez que criar o projeto, o Gradle irá transferir essas dependências.

Carregar as definições da aplicação

Nesta secção, irá adicionar os detalhes do registo da aplicação ao projeto.

Crie um novo diretório com o nome graphtutorial no diretório ./app/src/main/resources .
Crie um novo ficheiro no diretório ./app/src/main/resources/graphtutorial com o nome oAuth.properties e adicione o seguinte texto nesse ficheiro.
```
app.clientId=YOUR_CLIENT_ID_HERE
app.tenantId=common
app.graphUserScopes=user.read,mail.read,mail.send
```

Atualize os valores de acordo com a tabela seguinte.

Configuração	Valor
`app.clientId`	O ID de cliente do registo de aplicações
`app.tenantId`	Se escolheu a opção para permitir que apenas os utilizadores na sua organização iniciem sessão, altere este valor para o ID de inquilino. Caso contrário, deixe como `common`.

Importante

Se estiver a utilizar o controlo de origem, como o git, agora seria uma boa altura para excluir o ficheiro oAuth.properties do controlo de origem para evitar fugas inadvertidas do ID da aplicação.

Design do aplicativo

Nesta secção, irá criar um menu simples baseado na consola.

Abra ./app/src/main/java/graphtutorial/App.java e adicione as seguintes import instruções.

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.MessageCollectionResponse;
import com.microsoft.graph.models.User;

Substitua a função main existente pela seguinte.

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();
}

Adicione os seguintes métodos de marcador de posição no final do ficheiro. Irá implementá-los em passos 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
}

Esta ação implementa um menu básico e lê a escolha do utilizador a partir da linha de comandos.

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

Adicionar autenticação de utilizador

19 minutos restantes

Nesta secção, irá expandir a aplicação do exercício anterior para suportar a autenticação com o Azure AD. Isto é necessário para obter o token de acesso OAuth necessário para chamar o Microsoft Graph. Neste passo, irá integrar a biblioteca de cliente da Identidade do Azure para Java na aplicação e configurar a autenticação para o SDK do Microsoft Graph para Java.

A biblioteca de Identidade do Azure fornece várias classes que implementam fluxos de TokenCredential tokens OAuth2. A biblioteca de cliente do Microsoft Graph utiliza essas classes para autenticar chamadas para o Microsoft Graph.

Configurar o cliente do Graph para autenticação de utilizador

Nesta secção, irá utilizar a DeviceCodeCredential classe para pedir um token de acesso através do fluxo de código do dispositivo.

Crie um novo ficheiro no diretório ./app/src/main/java/graphtutorial denominado Graph.java e adicione o seguinte código a esse ficheiro.

package graphtutorial;

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.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.MessageCollectionResponse;
import com.microsoft.graph.models.Recipient;
import com.microsoft.graph.models.User;
import com.microsoft.graph.serviceclient.GraphServiceClient;
import com.microsoft.graph.users.item.sendmail.SendMailPostRequestBody;

Adicione uma definição de classe Graph vazia.
```
public class Graph {
}
```

Adicione o seguinte código à classe Graph.

private static Properties _properties;
private static DeviceCodeCredential _deviceCodeCredential;
private static GraphServiceClient _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 String[] graphUserScopes = properties.getProperty("app.graphUserScopes").split(",");

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

    _userClient = new GraphServiceClient(_deviceCodeCredential, graphUserScopes);
}

Substitua a função empty initializeGraph no App.java pelo seguinte.

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 duas propriedades privadas, um DeviceCodeCredential objeto e um GraphServiceClient objeto. A InitializeGraphForUserAuth função cria uma nova instância de DeviceCodeCredentiale, em seguida, utiliza essa instância para criar uma nova instância de GraphServiceClient. Sempre que for efetuada uma chamada à API para o Microsoft Graph através do _userClient, utilizará a credencial fornecida para obter um token de acesso.

Testar o DeviceCodeCredential

Em seguida, adicione código para obter um token de acesso a DeviceCodeCredentialpartir do .

Adicione a função a seguir à classe 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.getTokenSync(context);
    return token.getToken();
}

Substitua a função empty displayAccessToken no App.java pelo seguinte.

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());
    }
}

Crie e execute a aplicação. Introduza 1 quando lhe for pedida uma opção. A aplicação apresenta um URL e um 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 um browser e navegue para o URL apresentado. Introduza o código fornecido e inicie sessão.

Importante

Tenha em atenção todas as contas existentes do Microsoft 365 com sessão iniciada no browser ao navegar para https://microsoft.com/devicelogino . Utilize funcionalidades do browser, como perfis, modo de convidado ou modo privado para garantir que se autentica como a conta que pretende utilizar para testes.
Depois de concluído, regresse à aplicação para ver o token de acesso.

Dica

Apenas para fins de validação e depuração, pode descodificar tokens de acesso de utilizador (apenas para contas escolares ou profissionais) com o analisador de tokens online da Microsoft em https://jwt.ms. Isto pode ser útil se encontrar erros de token ao chamar o Microsoft Graph. Por exemplo, verificar se a scp afirmação no token contém os âmbitos de permissão esperados do Microsoft Graph.

Obter usuário

14 minutos restantes

Nesta secção, irá incorporar o Microsoft Graph na aplicação. Para esta aplicação, irá utilizar a Biblioteca de Cliente Java do Microsoft Graph para fazer chamadas para o Microsoft Graph.

Abra Graph.java e adicione a seguinte função à classe 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().get(requestConfig -> {
        requestConfig.queryParameters.select = new String[] {"displayName", "mail", "userPrincipalName"};
    });
}

Substitua a função empty greetUser no App.java pelo seguinte.

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.getMail() == null ? user.getUserPrincipalName() : user.getMail();
        System.out.println("Hello, " + user.getDisplayName() + "!");
        System.out.println("Email: " + email);
    } catch (Exception e) {
        System.out.println("Error getting user");
        System.out.println(e.getMessage());
    }
}

Se executar a aplicação agora, depois de iniciar sessão na aplicação dá-lhe as boas-vindas pelo nome.

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

Código explicado

Considere o código na greetUser função . São apenas algumas linhas, mas há alguns detalhes importantes a notar.

Aceder a 'eu'

A função utiliza o _userClient.me construtor de pedidos, que cria um pedido para a API Obter utilizador . Esta API está acessível de duas formas:

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

Neste caso, o código chamará o ponto final da GET /me API. Este é um método de atalho para obter o utilizador autenticado sem saber o respetivo ID de utilizador.

Observação

Uma vez que o ponto final da GET /me API obtém o utilizador autenticado, só está disponível para aplicações que utilizem a autenticação de utilizador. As aplicações de autenticação apenas de aplicações não podem aceder a este ponto final.

Pedir propriedades específicas

A função utiliza a select propriedade na configuração do pedido para especificar o conjunto de propriedades de que precisa. Esta ação adiciona o parâmetro de consulta $select à chamada à API.

Tipo de retorno fortemente escrito

A função devolve um com.microsoft.graph.models.User objeto serializado da resposta JSON da API. Uma vez que o código utiliza select, apenas as propriedades pedidas terão valores no objeto devolvido User . Todas as outras propriedades terão valores predefinidos.

Listar caixa de entrada

11 minutos restantes

Nesta secção, irá adicionar a capacidade de listar mensagens na caixa de entrada do e-mail do utilizador.

Abra Graph.java e adicione a seguinte função à classe Graph .

public static MessageCollectionResponse 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()
        .byMailFolderId("inbox")
        .messages()
        .get(requestConfig -> {
            requestConfig.queryParameters.select = new String[] { "from", "isRead", "receivedDateTime", "subject" };
            requestConfig.queryParameters.top = 25;
            requestConfig.queryParameters.orderby = new String[] { "receivedDateTime DESC" };
        });
}

Substitua a função empty listInbox no App.java pelo seguinte.

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

        // Output each message's details
        for (Message message: messages.getValue()) {
            System.out.println("Message: " + message.getSubject());
            System.out.println("  From: " + message.getFrom().getEmailAddress().getName());
            System.out.println("  Status: " + (message.getIsRead() ? "Read" : "Unread"));
            System.out.println("  Received: " + message.getReceivedDateTime()
                // Values are returned in UTC, convert to local time zone
                .atZoneSameInstant(ZoneId.systemDefault()).toLocalDateTime()
                .format(DateTimeFormatter.ofLocalizedDateTime(FormatStyle.SHORT)));
        }

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

Execute a aplicação, inicie sessão e selecione a opção 2 para listar a sua caixa 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

Considere o código na getInbox função .

Aceder a pastas de correio conhecidas

A função utiliza o _userClient.me().mailFolders().byMailFolderId("inbox").messages() construtor de pedidos, que cria um pedido para a API Listar mensagens . Uma vez que inclui o byMailFolderId("inbox") construtor de pedidos, a API só irá devolver mensagens na pasta de correio pedida. Neste caso, uma vez que a caixa de entrada é uma pasta predefinida e conhecida dentro da caixa de correio de um utilizador, é acessível através do nome conhecido. As pastas não predefinidas são acedidas da mesma forma ao substituir o nome conhecido pela propriedade ID da pasta de correio. Para obter detalhes sobre os nomes de pastas conhecidos disponíveis, consulte mailFolder resource type (Tipo de recurso mailFolder).

Aceder a uma coleção

Ao contrário da getUser função da secção anterior, que devolve um único objeto, este método devolve uma coleção de mensagens. A maioria das APIs no Microsoft Graph que devolvem uma coleção não devolvem todos os resultados disponíveis numa única resposta. Em vez disso, utilizam a paginação para devolver uma parte dos resultados, ao mesmo tempo que fornecem um método para os clientes solicitarem a "página" seguinte.

Tamanhos de página predefinidos

As APIs que utilizam a paginação implementam um tamanho de página predefinido. Para mensagens, o valor predefinido é 10. Os clientes podem pedir mais (ou menos) através do parâmetro de consulta $top . No getInbox, isto é conseguido com a top propriedade na configuração do pedido.

Observação

O valor definido em top é um limite superior e não um número explícito. A API devolve um número de mensagens até ao valor especificado.

Obter páginas subsequentes

Se existirem mais resultados disponíveis no servidor, as respostas da coleção incluem uma @odata.nextLink propriedade com um URL de API para aceder à página seguinte. A biblioteca de cliente Java expõe-no como o getOdataNextLink método nos objetos de resposta da coleção. Se este método devolver não nulo, existem mais resultados disponíveis.

Classificando coleções

A função utiliza a orderBy propriedade na configuração do pedido para pedir resultados ordenados quando a mensagem é recebida (receivedDateTime propriedade). Inclui a palavra-chave para que as DESC mensagens recebidas mais recentemente sejam listadas primeiro. Esta ação adiciona o parâmetro de consulta $orderby à chamada à API.

Enviar email

8 minutos restantes

Nesta secção, irá adicionar a capacidade de enviar uma mensagem de e-mail como utilizador autenticado.

Abra Graph.java e adicione a seguinte função à classe 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.setSubject(subject);
    final ItemBody itemBody = new ItemBody();
    itemBody.setContent(body);
    itemBody.setContentType(BodyType.Text);
    message.setBody(itemBody);

    final EmailAddress emailAddress = new EmailAddress();
    emailAddress.setAddress(recipient);
    final Recipient toRecipient = new Recipient();
    toRecipient.setEmailAddress(emailAddress);
    message.setToRecipients(List.of(toRecipient));

    final SendMailPostRequestBody postRequest = new SendMailPostRequestBody();
    postRequest.setMessage(message);

    // Send the message
    _userClient.me()
        .sendMail()
        .post(postRequest);
}

Substitua a função empty sendMail no App.java pelo seguinte.

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.getMail() == null ? user.getUserPrincipalName() : user.getMail();

        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());
    }
}

Execute a aplicação, inicie sessão e selecione a opção 3 para enviar um e-mail para si próprio.
```
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.
```
Observação

Se estiver a testar com um inquilino de programador do Programa para Programadores do Microsoft 365, o e-mail que enviar poderá não ser entregue e poderá receber um relatório de entrega sem fins lucrativos. Se isto lhe acontecer, contacte o suporte através do centro de administração do Microsoft 365.
Para verificar se a mensagem foi recebida, selecione a opção 2 para listar a sua caixa de entrada.

Código explicado

Considere o código na sendMail função .

Enviar correio

A função utiliza o _userClient.me().sendMail() construtor de pedidos, que cria um pedido para a API enviar correio . O construtor de pedidos utiliza um SendMailPostRequestBody objeto que contém a mensagem a enviar.

Criar objetos

Ao contrário das chamadas anteriores para o Microsoft Graph que só leem dados, esta chamada cria dados. Para tal, crie uma instância da classe que representa os dados (neste caso, com.microsoft.graph.models.Message) com a new palavra-chave , defina as propriedades pretendidas e, em seguida, envie-a na chamada à API. Uma vez que a chamada está a enviar dados, o post método é utilizado em vez de get.

Opcional: adicionar o seu próprio código

5 minutos restantes

Nesta secção, irá adicionar as suas próprias capacidades do Microsoft Graph à aplicação. Pode ser um fragmento de código da documentação do Microsoft Graph ou do Graph Explorer ou código que criou. Esta secção é opcional.

Atualizar o aplicativo

Abra Graph.java e adicione a seguinte função à classe Graph .

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

Substitua a função empty MakeGraphCallAsync no App.java pelo seguinte.

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

Escolher uma API

Localize uma API no Microsoft Graph que gostaria de experimentar. Por exemplo, a API Criar evento . Pode utilizar um dos exemplos na documentação da API ou personalizar um pedido de API no Graph Explorer e utilizar o fragmento gerado.

Configurar as permissões

Verifique a secção Permissões da documentação de referência da API escolhida para ver que métodos de autenticação são suportados. Algumas APIs não suportam apenas aplicações ou contas Microsoft pessoais, por exemplo.

Para chamar uma API com autenticação de utilizador (se a API suportar a autenticação de utilizador (delegado), adicione o âmbito de permissão necessário em oAuth.properties.
Para chamar uma API com autenticação apenas de aplicação, veja o tutorial de autenticação apenas de aplicação .

Adicionar o código

Copie o código para a makeGraphCallAsync função no Graph.java. Se estiver a copiar um fragmento da documentação ou do Graph Explorer, certifique-se de que muda o GraphServiceClient nome para _userClient.

Compartilhar via

Criar aplicativos Java com o Microsoft Graph

Pré-requisitos

Registrar o aplicativo no portal

Registar aplicação para autenticação de utilizador

Criar um aplicativo de console Java

Instalar dependências

Carregar as definições da aplicação

Design do aplicativo

Adicionar autenticação de utilizador

Configurar o cliente do Graph para autenticação de utilizador

Testar o DeviceCodeCredential

Obter usuário

Código explicado

Aceder a 'eu'

Pedir propriedades específicas

Tipo de retorno fortemente escrito

Listar caixa de entrada

Código explicado

Aceder a pastas de correio conhecidas

Aceder a uma coleção

Tamanhos de página predefinidos

Obter páginas subsequentes

Classificando coleções

Enviar email

Código explicado

Enviar correio

Criar objetos

Opcional: adicionar o seu próprio código

Atualizar o aplicativo

Escolher uma API

Configurar as permissões

Adicionar o código

Parabéns!

Exemplos de Java