Cómo trabajar con borradores

Los borradores representan mensajes no enviados con la etiqueta del sistema DRAFT aplicada. Una vez creado, el mensaje que contiene el borrador no se puede editar, pero sí reemplazar. En este sentido, el recurso de borrador es simplemente un contenedor que proporciona un ID estable, ya que los IDs de mensaje subyacentes cambian cada vez que se reemplaza el mensaje.

Los recursos de mensajes dentro de un borrador tienen un comportamiento similar al de otros mensajes, excepto por las siguientes diferencias:

  • Los mensajes de borrador no pueden tener ninguna etiqueta que no sea la etiqueta del sistema DRAFT.
  • Cuando se envía el borrador, este se borra automáticamente y se crea un mensaje nuevo con un ID actualizado con la etiqueta del sistema SENT. Este mensaje se muestra en la respuesta drafts.send.

Contenido

Cómo crear borradores de mensajes

Tu aplicación puede crear borradores con el método drafts.create. El proceso general es el siguiente:

  1. Crea un mensaje MIME que cumpla con la RFC 2822.
  2. Convierte el mensaje en una cadena codificada en base64url.
  3. Crea un borrador y establece el valor del campo drafts.message.raw en la cadena codificada.

En los siguientes ejemplos de código, se demuestra el proceso.

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

Actualiza los borradores

De manera similar a la creación de un borrador, para actualizarlo, debes proporcionar un recurso Draft en el cuerpo de la solicitud con el campo draft.message.raw establecido en una cadena codificada en base64url que contenga el mensaje MIME. Debido a que los mensajes no se pueden actualizar, el mensaje contenido en el borrador se destruye y se reemplaza por el nuevo mensaje MIME proporcionado en la solicitud de actualización.

Para recuperar el mensaje MIME actual que se incluye en el borrador, llama a drafts.get con el parámetro format=raw.

Para obtener más información, consulta drafts.update

Cómo enviar borradores

Cuando envíes un borrador, puedes elegir enviarlo tal como está o como un mensaje actualizado. Si actualizas el contenido del borrador con un mensaje nuevo, proporciona un recurso Draft en el cuerpo de la solicitud drafts.send, establece el draft.id del borrador que se enviará y establece el campo draft.message.raw en el nuevo mensaje MIME codificado como una cadena codificada en base64url. Para obtener más información, consulta drafts.send.