کار با پیش نویس ها

پیش نویس ها پیام های ارسال نشده را با برچسب سیستم DRAFT نشان می دهند. پیام موجود در پیش نویس پس از ایجاد قابل ویرایش نیست، اما می توان آن را جایگزین کرد. از این نظر، منبع پیش نویس صرفاً محفظه ای است که شناسه پایداری را ارائه می دهد زیرا شناسه های پیام زیربنایی هر بار که پیام جایگزین می شود تغییر می کنند.

منابع پیام در یک پیش نویس رفتاری مشابه با پیام های دیگر دارند به جز تفاوت های زیر:

• پیام‌های پیش‌نویس نمی‌توانند برچسبی غیر از برچسب سیستم DRAFT داشته باشند.
• هنگامی که پیش نویس ارسال می شود، پیش نویس به طور خودکار حذف می شود و یک پیام جدید با شناسه به روز شده با برچسب سیستم SENT ایجاد می شود. این پیام در پاسخ drafts.send برگردانده شده است.

مطالب

ایجاد پیش نویس پیام ها

برنامه شما می تواند با استفاده از روش drafts.create پیش نویس ایجاد کند. روند کلی این است که:

1. یک پیام MIME ایجاد کنید که با RFC 2822 مطابقت داشته باشد.
2. پیام را به یک رشته رمزگذاری شده base64url تبدیل کنید.
3. یک پیش نویس ایجاد کنید و مقدار قسمت drafts.message.raw را روی رشته کدگذاری شده تنظیم کنید.

نمونه های کد زیر روند را نشان می دهد.

جاوا

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;
  }
}

پایتون

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 مراجعه کنید.