Menangani Draf

Draf mewakili pesan yang belum terkirim dengan label sistem DRAFT yang diterapkan. Pesan yang ada dalam draf tidak dapat diedit setelah dibuat, tetapi dapat diganti. Dalam hal ini, resource draf hanyalah penampung yang menyediakan ID stabil karena ID pesan yang mendasarinya berubah setiap kali pesan diganti.

Resource pesan di dalam draf memiliki perilaku yang serupa dengan pesan lain, kecuali untuk perbedaan berikut:

  • Pesan draf tidak boleh memiliki label selain label sistem DRAFT.
  • Saat draf dikirim, draf akan otomatis dihapus dan pesan baru dengan ID yang diperbarui akan dibuat dengan label sistem SENT. Pesan ini ditampilkan dalam respons drafts.send.

Daftar Isi

Membuat draf pesan

Aplikasi Anda dapat membuat draf menggunakan metode drafts.create. Proses umumnya adalah:

  1. Buat pesan MIME yang sesuai dengan RFC 2822.
  2. Konversi pesan ke string berenkode base64url.
  3. Buat draf, tetapkan nilai kolom drafts.message.raw ke string yang dienkode.

Contoh kode berikut menunjukkan prosesnya.

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

Memperbarui draf

Mirip dengan pembuatan draf, untuk memperbarui draf, Anda harus menyediakan resource Draft dalam isi permintaan dengan kolom draft.message.raw disetel ke string berenkode base64url yang berisi pesan MIME. Karena pesan tidak dapat diperbarui, pesan yang ada dalam draf akan dihapus dan diganti dengan pesan MIME baru yang diberikan dalam permintaan pembaruan.

Anda dapat mengambil pesan MIME saat ini yang ada dalam draf dengan memanggil drafts.get dengan parameter format=raw.

Untuk mengetahui informasi selengkapnya, lihat drafts.update.

Mengirim draf

Saat mengirim draf, Anda dapat memilih untuk mengirim pesan sebagaimana adanya atau dengan pesan yang diperbarui. Jika Anda memperbarui konten draf dengan pesan baru, berikan resource Draft dalam isi permintaan drafts.send; tetapkan draft.id draf yang akan dikirim; dan tetapkan kolom draft.message.raw ke pesan MIME baru yang dienkode sebagai string berenkode base64url. Untuk mengetahui informasi selengkapnya, lihat drafts.send.