Créer et envoyer des brouillons d'e-mails

Ce document explique comment créer, modifier et envoyer des brouillons d'e-mails à l'aide de l'API Gmail.

Les brouillons d'e-mails représentent des messages non envoyés auxquels le libellé système DRAFT est appliqué. Une fois le brouillon créé, le message qu'il contient ne peut pas être modifié, mais il peut être remplacé. En ce sens, la ressource drafts est un conteneur qui fournit un ID stable, car les ID de message sous-jacents changent chaque fois que le message est remplacé.

La ressource messages dans un brouillon a un comportement semblable à celui des autres messages, à l'exception des différences suivantes :

  • Les messages en brouillon ne peuvent pas comporter d'étiquette autre que l'étiquette système DRAFT.
  • Lorsque le brouillon est envoyé, il est automatiquement supprimé et un nouveau message avec un ID mis à jour est créé avec le libellé système SENT. Ce message est renvoyé dans la réponse de la méthode drafts.send.

Créer des brouillons

Votre application peut créer des brouillons à l'aide de la méthode drafts.create. Pour créer un brouillon :

  1. Créez un message MIME conforme à la norme RFC 2822.
  2. Convertissez le message en chaîne encodée en base64URL.
  3. Appelez la méthode drafts.create en définissant la valeur du champ messages.raw sur la chaîne encodée.

Les exemples de code suivants illustrent ce processus :

Java

gmail/snippets/src/main/java/CreateDraft.java
import com.google.api.client.googleapis.json.GoogleJsonError;
import com.google.api.client.googleapis.json.GoogleJsonResponseException;
import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.services.gmail.Gmail;
import com.google.api.services.gmail.GmailScopes;
import com.google.api.services.gmail.model.Draft;
import com.google.api.services.gmail.model.Message;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.util.Properties;
import javax.mail.MessagingException;
import javax.mail.Session;
import javax.mail.internet.InternetAddress;
import javax.mail.internet.MimeMessage;
import org.apache.commons.codec.binary.Base64;

/* Class to demonstrate the use of Gmail Create Draft API */
public class CreateDraft {
  /**
   * Create a draft email.
   *
   * @param fromEmailAddress - Email address to appear in the from: header
   * @param toEmailAddress   - Email address of the recipient
   * @return the created draft, {@code null} otherwise.
   * @throws MessagingException - if a wrongly formatted address is encountered.
   * @throws IOException        - if service account credentials file not found.
   */
  public static Draft createDraftMessage(String fromEmailAddress,
                                         String toEmailAddress)
      throws MessagingException, IOException {
        /* Load pre-authorized user credentials from the environment.
        TODO(developer) - See https://developers.google.com/identity for
         guides on implementing OAuth2 for your application.*/
    GoogleCredentials credentials = GoogleCredentials.getApplicationDefault()
        .createScoped(GmailScopes.GMAIL_COMPOSE);
    HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(credentials);

    // Create the gmail API client
    Gmail service = new Gmail.Builder(new NetHttpTransport(),
        GsonFactory.getDefaultInstance(),
        requestInitializer)
        .setApplicationName("Gmail samples")
        .build();

    // Create the email content
    String messageSubject = "Test message";
    String bodyText = "lorem ipsum.";

    // Encode as MIME message
    Properties props = new Properties();
    Session session = Session.getDefaultInstance(props, null);
    MimeMessage email = new MimeMessage(session);
    email.setFrom(new InternetAddress(fromEmailAddress));
    email.addRecipient(javax.mail.Message.RecipientType.TO,
        new InternetAddress(toEmailAddress));
    email.setSubject(messageSubject);
    email.setText(bodyText);

    // Encode and wrap the MIME message into a gmail message
    ByteArrayOutputStream buffer = new ByteArrayOutputStream();
    email.writeTo(buffer);
    byte[] rawMessageBytes = buffer.toByteArray();
    String encodedEmail = Base64.encodeBase64URLSafeString(rawMessageBytes);
    Message message = new Message();
    message.setRaw(encodedEmail);

    try {
      // Create the draft message
      Draft draft = new Draft();
      draft.setMessage(message);
      draft = service.users().drafts().create("me", draft).execute();
      System.out.println("Draft id: " + draft.getId());
      System.out.println(draft.toPrettyString());
      return draft;
    } catch (GoogleJsonResponseException e) {
      // TODO(developer) - handle error appropriately
      GoogleJsonError error = e.getDetails();
      if (error.getCode() == 403) {
        System.err.println("Unable to create draft: " + e.getMessage());
      } else {
        throw e;
      }
    }
    return null;
  }
}

Python

gmail/snippet/send mail/create_draft.py
import base64
from email.message import EmailMessage

import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError


def gmail_create_draft():
  """Create and insert a draft email.
   Print the returned draft's message and id.
   Returns: Draft object, including draft id and message meta data.

  Load pre-authorized user credentials from the environment.
  TODO(developer) - See https://developers.google.com/identity
  for guides on implementing OAuth2 for the application.
  """
  creds, _ = google.auth.default()

  try:
    # create gmail api client
    service = build("gmail", "v1", credentials=creds)

    message = EmailMessage()

    message.set_content("This is automated draft mail")

    message["To"] = "gduser1@workspacesamples.dev"
    message["From"] = "gduser2@workspacesamples.dev"
    message["Subject"] = "Automated draft"

    # encoded message
    encoded_message = base64.urlsafe_b64encode(message.as_bytes()).decode()

    create_message = {"message": {"raw": encoded_message}}
    # pylint: disable=E1101
    draft = (
        service.users()
        .drafts()
        .create(userId="me", body=create_message)
        .execute()
    )

    print(f'Draft id: {draft["id"]}\nDraft message: {draft["message"]}')

  except HttpError as error:
    print(f"An error occurred: {error}")
    draft = None

  return draft


if __name__ == "__main__":
  gmail_create_draft()

cURL

curl --request POST \
  'https://gmail.googleapis.com/gmail/v1/users/me/drafts' \
  --header 'Authorization: Bearer ACCESS_TOKEN" \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"message":{"raw":"MESSAGE"}}'

Remplacez les éléments suivants :

  • ACCESS_TOKEN : jeton d'accès qui permet d'accéder à l'API.
  • MESSAGE : message MIME au format RFC 2822, encodé en base64URL.

Modifier un brouillon

Comme pour la création d'un brouillon, vous devez fournir une ressource drafts dans le corps de votre requête pour mettre à jour un brouillon, avec le champ messages.raw défini sur une chaîne encodée en base64URL contenant le message MIME. Étant donné que les messages ne peuvent pas être mis à jour, le message contenu dans le brouillon est détruit et remplacé par le nouveau message MIME fourni dans la demande de mise à jour.

Vous pouvez récupérer le message MIME actuel contenu dans le brouillon en appelant la méthode drafts.get avec le paramètre de requête format=raw.

Pour en savoir plus, consultez la page sur la méthode drafts.update.

Envoyer des brouillons

Lorsque vous envoyez un brouillon, vous pouvez l'envoyer tel quel ou fournir des informations dans la demande d'envoi.

Pour mettre à jour le brouillon lors de l'envoi, fournissez une ressource drafts dans le corps de la requête de la méthode drafts.send. Dans la ressource drafts, vous devez spécifier le id du brouillon à envoyer et définir le champ messages.raw sur le nouveau message MIME encodé en tant que chaîne base64URL.

Pour savoir comment envoyer un message Gmail, consultez Envoyer des messages.