ایجاد و ارسال ایمیل‌های پیش‌نویس

این سند نحوه ایجاد، به‌روزرسانی و ارسال ایمیل‌های پیش‌نویس با استفاده از Gmail API را توضیح می‌دهد.

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

منبع messages در داخل یک پیش‌نویس، رفتاری مشابه سایر پیام‌ها دارد، به جز تفاوت‌های زیر:

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

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

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

  1. یک پیام MIME ایجاد کنید که با RFC 2822 مطابقت داشته باشد.
  2. پیام را به یک رشته کدگذاری شده با base64URL تبدیل کنید.
  3. متد drafts.create را فراخوانی کنید و مقدار فیلد messages.raw را برابر با رشته کدگذاری شده قرار دهید.

نمونه‌های کد زیر روند کار را نشان می‌دهند:

جاوا

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

پایتون

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

حلقه

curl --request POST \
  'https://gmail.googleapis.com/gmail/v1/users/me/drafts' \
  --header 'Authorization: Bearer ACCESS_TOKEN" \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"message":{"raw":"MESSAGE"}}'

موارد زیر را جایگزین کنید:

  • ACCESS_TOKEN : توکن دسترسی که دسترسی به API را اعطا می‌کند.
  • MESSAGE : پیام MIME با فرمت RFC 2822 که به صورت base64URL کدگذاری شده است.

پیش‌نویس‌ها را به‌روزرسانی کنید

مشابه ایجاد یک پیش‌نویس، برای به‌روزرسانی یک پیش‌نویس، باید منبعی drafts را در بدنه درخواست خود ارائه دهید که فیلد messages.raw روی یک رشته کدگذاری شده base64URL حاوی پیام MIME تنظیم شده باشد. از آنجا که پیام‌ها قابل به‌روزرسانی نیستند، پیام موجود در پیش‌نویس از بین می‌رود و با پیام MIME جدید ارائه شده در درخواست به‌روزرسانی جایگزین می‌شود.

شما می‌توانید پیام MIME فعلی موجود در پیش‌نویس را با فراخوانی متد drafts.get به همراه پارامتر query format=raw بازیابی کنید.

برای اطلاعات بیشتر، به متد drafts.update مراجعه کنید.

ارسال پیش‌نویس‌ها

هنگام ارسال پیش‌نویس، می‌توانید آن را به همان صورت ارسال کنید، یا می‌توانید در درخواست ارسال، به‌روزرسانی‌هایی را ارائه دهید.

برای به‌روزرسانی پیش‌نویس هنگام ارسال، یک منبع drafts در بدنه درخواست متد drafts.send ارائه دهید. در منبع drafts ، باید id پیش‌نویس ارسالی را مشخص کنید و فیلد messages.raw را روی پیام MIME جدید که به صورت رشته base64URL کدگذاری شده است، تنظیم کنید.

برای اطلاعات بیشتر در مورد ارسال پیام از طریق Gmail، به بخش ارسال پیام مراجعه کنید.