Crea y envía borradores de correos electrónicos

En este documento, se explica cómo crear, actualizar y enviar borradores de correos electrónicos con la API de Gmail.

Los borradores de correos electrónicos representan mensajes no enviados con la etiqueta del sistema DRAFT aplicada. El mensaje que contiene el borrador no se puede editar una vez que se crea, pero se puede reemplazar. En este sentido, el recurso drafts es un contenedor que proporciona un ID estable porque los IDs de los mensajes subyacentes cambian cada vez que se reemplaza el mensaje.

El recurso messages dentro de un borrador tiene 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, se borra automáticamente y se crea un mensaje nuevo con un ID actualizado y la etiqueta del sistema SENT. Este mensaje se devuelve en la respuesta del método drafts.send.

Crear borradores

Tu app puede crear borradores con el método drafts.create. Para crear un borrador, sigue estos pasos:

  1. Crea un mensaje MIME que cumpla con el RFC 2822.
  2. Convierte el mensaje en una cadena codificada en base64URL.
  3. Llama al método drafts.create y establece el valor del campo messages.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()

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"}}'

Reemplaza lo siguiente:

  • ACCESS_TOKEN: Es el token de acceso que otorga acceso a la API.
  • MESSAGE: Es el mensaje MIME con formato RFC 2822, codificado como base64URL.

Actualizar borradores

Al igual que cuando creas un borrador, para actualizarlo, debes proporcionar un recurso drafts en el cuerpo de la solicitud con el campo messages.raw establecido en una cadena codificada en base64URL que contenga el mensaje MIME. Como los mensajes no se pueden actualizar, el mensaje incluido en el borrador se destruye y se reemplaza por el nuevo mensaje MIME proporcionado en la solicitud de actualización.

Puedes recuperar el mensaje MIME actual que se incluye en el borrador llamando al método drafts.get con el parámetro de consulta format=raw.

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

Enviar borradores

Cuando envíes un borrador, puedes hacerlo tal como está o proporcionar actualizaciones en la solicitud de envío.

Para actualizar el borrador cuando lo envíes, proporciona un recurso drafts en el cuerpo de la solicitud del método drafts.send. En el recurso drafts, debes especificar el id borrador del borrador que se enviará y establecer el campo messages.raw en el nuevo mensaje MIME codificado como una cadena base64URL.

Para obtener información sobre cómo enviar un mensaje de Gmail, consulta Envía mensajes.