Tworzenie i wysyłanie kopii roboczych e-maili

Z tego dokumentu dowiesz się, jak tworzyć, aktualizować i wysyłać wersje robocze e-maili za pomocą interfejsu Gmail API.

Wersje robocze e-maili to niewysłane wiadomości z etykietą systemową DRAFT. Po utworzeniu wiadomości w wersji roboczej nie można jej edytować, ale można ją zastąpić. W tym sensie zasób drafts jest kontenerem, który zapewnia stały identyfikator, ponieważ identyfikatory wiadomości bazowych zmieniają się za każdym razem, gdy wiadomość jest zastępowana.

Zasób messages w wersji roboczej zachowuje się podobnie jak inne wiadomości, z wyjątkiem tych różnic:

  • Wersje robocze wiadomości nie mogą mieć żadnej etykiety poza etykietą systemową DRAFT.
  • Po wysłaniu wersji roboczej zostanie ona automatycznie usunięta, a zostanie utworzona nowa wiadomość ze zaktualizowanym identyfikatorem i etykietą systemową SENT. Ten komunikat jest zwracany w odpowiedzi metody drafts.send.

Tworzenie wersji roboczych

Aplikacja może tworzyć wersje robocze za pomocą metody drafts.create. Aby utworzyć wersję roboczą:

  1. Utwórz wiadomość MIME zgodną z RFC 2822.
  2. Przekonwertuj wiadomość na ciąg znaków zakodowany w formacie base64URL.
  3. Wywołaj metodę drafts.create, ustawiając wartość pola messages.raw na zakodowany ciąg znaków.

Poniższe przykłady kodu pokazują ten proces:

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

Zastąp następujące elementy:

  • ACCESS_TOKEN: token dostępu, który przyznaje dostęp do interfejsu API.
  • MESSAGE: wiadomość MIME w formacie RFC 2822 zakodowana jako base64URL.

Zaktualizuj wersje robocze

Podobnie jak w przypadku tworzenia wersji roboczej, aby ją zaktualizować, musisz podać w treści żądania zasób drafts, w którym pole messages.raw jest ustawione na ciąg zakodowany w base64URL zawierający wiadomość MIME. Ponieważ wiadomości nie można zaktualizować, wiadomość zawarta w wersji roboczej jest usuwana i zastępowana nową wiadomością MIME dostarczoną w żądaniu aktualizacji.

Aby pobrać bieżącą wiadomość MIME zawartą w wersji roboczej, wywołaj metodę drafts.get z parametrem zapytania format=raw.

Więcej informacji znajdziesz w sekcji dotyczącej metody drafts.update.

Wysyłanie wersji roboczych

Wersję roboczą możesz wysłać w takiej postaci, w jakiej jest, lub możesz podać aktualizacje w prośbie o wysłanie.

Aby zaktualizować wersję roboczą podczas wysyłania, podaj zasób drafts w treści żądania metody drafts.send. W zasobie drafts musisz określić wersję roboczą id, która ma zostać wysłana, i ustawić pole messages.raw na nową wiadomość MIME zakodowaną jako ciąg znaków base64URL.

Więcej informacji o wysyłaniu wiadomości w Gmailu znajdziesz w artykule Wysyłanie wiadomości.