Praca z wersjami roboczymi

Wersje robocze to niewysłane wiadomości z zastosowaną etykietą systemową DRAFT. Utworzonej wiadomości w wersji roboczej nie można edytować, ale można ją zastąpić. W tym sensie zasób wersji roboczej jest po prostu kontenerem, który zapewnia stabilny identyfikator, ponieważ identyfikatory wiadomości bazowych zmieniają się za każdym razem, gdy wiadomość jest zastępowana.

Zasoby wiadomości w wersji roboczej zachowują się podobnie jak inne wiadomości, z wyjątkiem tych różnic:

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

Spis treści

Tworzenie wersji roboczych wiadomości

Aplikacja może tworzyć wersje robocze za pomocą metody drafts.create. Ogólny proces wygląda następująco:

  1. Utwórz wiadomość MIME zgodną z RFC 2822.
  2. Przekonwertuj wiadomość na ciąg znaków zakodowany w formacie base64url.
  3. Utwórz wersję roboczą, ustawiając wartość pola drafts.message.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()

Aktualizowanie wersji roboczych

Podobnie jak w przypadku tworzenia wersji roboczej, aby ją zaktualizować, musisz podać Draftzasób w treści żądania z polem draft.message.raw ustawionym na ciąg znaków 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 funkcję drafts.get z parametrem format=raw.

Więcej informacji znajdziesz w sekcji drafts.update.

Wysyłanie wersji roboczych

Podczas wysyłania wersji roboczej możesz wysłać wiadomość w obecnej postaci lub zaktualizowaną. Jeśli aktualizujesz wersję roboczą treści nową wiadomością, podaj zasób Draft w treści żądania drafts.send, ustaw draft.id wersji roboczej do wysłania i ustaw pole draft.message.raw na nową wiadomość MIME zakodowaną jako ciąg zakodowany w base64url. Więcej informacji znajdziesz w sekcji drafts.send.