Utiliser les brouillons

Les brouillons représentent les 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 brouillon est simplement un conteneur qui fournit un ID stable, car les ID de message sous-jacents changent chaque fois que le message est remplacé.

Les ressources de message dans un brouillon se comportent de la même manière que les autres messages, à quelques différences près :

  • 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 drafts.send.

Sommaire

Créer des brouillons

Votre application peut créer des brouillons à l'aide de la méthode drafts.create. La procédure générale est la suivante :

  1. Créez un message MIME conforme à la norme RFC 2822.
  2. Convertissez le message en chaîne encodée en base64url.
  3. Créez un brouillon en définissant la valeur du champ drafts.message.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()

Modifier des brouillons

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

Vous pouvez récupérer le message MIME actuel contenu dans le brouillon en appelant drafts.get avec le paramètre format=raw.

Pour en savoir plus, consultez les sections sur drafts.update

Envoyer des brouillons

Lorsque vous envoyez un brouillon, vous pouvez choisir d'envoyer le message tel quel ou de le modifier. Si vous mettez à jour le contenu du brouillon avec un nouveau message, fournissez une ressource Draft dans le corps de la requête drafts.send, définissez le draft.id du brouillon à envoyer et définissez le champ draft.message.raw sur le nouveau message MIME encodé en tant que chaîne encodée en base64url. Pour en savoir plus, consultez drafts.send.