Compartir a través de

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

En este artículo, ampliará la aplicación que creó en Compilación de aplicaciones PHP 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 el código siguiente a la clase 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. Reemplace la función vacía listInbox en main.php por lo siguiente.

    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. 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: 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 explicado

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

Acceso a carpetas de correo conocidas

La función pasa /me/mailFolders/inbox/messages al generador de solicitudes, que compila una solicitud a la API De lista de mensajes . Dado que incluye el /mailFolders/inbox segmento, 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 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 ú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 getInbox, la adición $top se realiza con la queryParameters->top propiedad en los parámetros de consulta.

Nota:

El valor pasado en queryParameters->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 PHP proporciona el getOdataNextLink método en objetos de solicitud de recopilación. Si este método devuelve una cadena no vacía, hay más resultados disponibles. Para obtener más información, consulte Página a través de una colección mediante los SDK de Microsoft Graph.

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.

Enviar correo

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

  1. Agregue el código siguiente a la clase 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. Reemplace la función vacía sendMail en main.php por lo siguiente.

    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. 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.

sendMail 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 cuerpo de solicitud 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 crear elementos con la biblioteca cliente, cree una matriz asociativa que represente los datos, 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

Incorporación de API adicionales de Microsoft Graph