استخدام المسودات

تمثل المسودات الرسائل غير المُرسَلة والتي تم تطبيق تصنيف النظام DRAFT عليها. لا يمكن تعديل الرسالة المضمَّنة في المسودة بعد إنشائها، ولكن يمكن استبداله. في هذا المعنى، مسودة الموارد هي ببساطة حاوية توفّر معرّفًا ثابتًا لأن معرّفات الرسالة الأساسية تتغير في كل مرة يتم استبدال الرسالة.

موارد الرسائل داخل مسودة يكون لهما سلوك مشابه للرسائل الأخرى، باستثناء الاختلافات التالية:

• لا يمكن أن تحتوي مسودات الرسائل على أي تصنيف غير تصنيف النظام DRAFT.
• عند إرسال المسودة، يتم حذف المسودة تلقائيًا ورسالة جديدة ذو رقم التعريف المعدَّل، يتم إنشاؤه باستخدام تصنيف النظام SENT. هذه الرسالة تم إرجاعه في drafts.send الاستجابة.

المحتويات

جارٍ إنشاء مسودات الرسائل

يمكن لتطبيقك إنشاء مسودات باستخدام 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.