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

تمثّل المسودات الرسائل غير المُرسَلة التي تم تطبيق تصنيف النظام 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.