עבודה עם טיוטות

טיוטות מייצגות הודעות שלא נשלחו, עם תווית המערכת DRAFT. אחרי שיוצרים את ההודעה בטיוטה, אי אפשר לערוך אותה, אבל אפשר להחליף אותה. במובן הזה, משאב הטיוטה הוא פשוט מאגר שמספק מזהה יציב, כי מזהי ההודעות הבסיסיים משתנים בכל פעם שההודעה מוחלפת.

משאבי הודעות בתוך טיוטה מתנהגים באופן דומה להודעות אחרות, למעט ההבדלים הבאים:

• הודעות בטיוטה לא יכולות להיות מסומנות בתווית כלשהי מלבד תווית המערכת DRAFT.
• כששולחים את הטיוטה, היא נמחקת אוטומטית ונוצרת הודעה חדשה עם מזהה מעודכן ותווית המערכת SENT. ההודעה הזו מוחזרת בתגובה drafts.send.

תוכן עניינים

יצירת טיוטות של הודעות

אפשר ליצור טיוטות באפליקציה באמצעות ה-method‏ drafts.create. התהליך הכללי הוא:

1. יוצרים הודעת MIME שתואמת ל-RFC 2822.
2. ממירים את ההודעה למחרוזת בקידוד base64url.
3. יוצרים טיוטה ומגדירים את הערך של השדה drafts.message.raw למחרוזת המקודדת.

בדוגמאות הקוד הבאות מוצג התהליך.

Java

gmail/snippets/src/main/java/CreateDraft.java

הצגת הקוד ב-GitHub

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

הצגת הקוד ב-GitHub

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"] = "[e-mail]"
    message["From"] = "[e-mail]"
    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()

עדכון טיוטות

בדומה ליצירת טיוטה, כדי לעדכן טיוטה צריך לספק משאב Draft בגוף הבקשה, כשהשדה draft.message.raw מוגדר כמחרוזת בקידוד base64url שמכילה את הודעת ה-MIME. מכיוון שלא ניתן לעדכן הודעות, ההודעה שנכללת בטיוטה נמחקת ומוחלפת בהודעת ה-MIME החדשה שסופקה בבקשת העדכון.

אפשר לאחזר את הודעת ה-MIME הנוכחית שנמצאת בטיוטה באמצעות הקריאה ל-drafts.get עם הפרמטר format=raw.

מידע נוסף זמין במאמר drafts.update.

שליחת טיוטות

כששולחים טיוטה, אפשר לשלוח את ההודעה כמו שהיא או לעדכן אותה. אם מעדכנים את תוכן הטיוטה בהודעה חדשה, צריך לספק משאב Draft בגוף הבקשה drafts.send, להגדיר את draft.id של הטיוטה שתישלח ולהגדיר את השדה draft.message.raw להודעת MIME החדשה שמקודדת כמחרוזת מקודדת של base64url. מידע נוסף זמין במאמר drafts.send.