สร้างและส่งอีเมลฉบับร่าง

เอกสารนี้อธิบายวิธีสร้าง อัปเดต และส่งอีเมลฉบับร่างโดยใช้ Gmail API

อีเมลฉบับร่างแสดงถึงข้อความที่ยังไม่ได้ส่งซึ่งมีป้ายกำกับระบบ DRAFT เมื่อสร้างแล้ว คุณจะแก้ไขข้อความในฉบับร่างไม่ได้ แต่จะแทนที่ได้ ในแง่นี้ ทรัพยากร drafts เป็น คอนเทนเนอร์ที่มีรหัสที่เสถียร เนื่องจากรหัสข้อความพื้นฐานจะเปลี่ยนไป ทุกครั้งที่แทนที่ข้อความ

ทรัพยากร messagesภายในฉบับร่างมีลักษณะการทำงานคล้ายกับข้อความอื่นๆ ยกเว้นความแตกต่างต่อไปนี้

• ข้อความฉบับร่างต้องไม่มีป้ายกำกับอื่นนอกเหนือจากป้ายกำกับระบบ DRAFT
• เมื่อส่งฉบับร่าง ระบบจะลบฉบับร่างโดยอัตโนมัติและสร้างข้อความใหม่ที่มีรหัสอัปเดตพร้อมป้ายกำกับระบบ SENT ระบบจะแสดงข้อความนี้ ในการตอบกลับ drafts.send เมธอด

สร้างฉบับร่าง

แอปของคุณสามารถสร้างฉบับร่างได้โดยใช้ drafts.create เมธอด วิธีสร้างฉบับร่าง

1. สร้างข้อความ MIME ที่เป็นไปตาม RFC 2822
2. แปลงข้อความเป็นสตริงที่เข้ารหัส base64URL
3. เรียกใช้เมธอด drafts.create โดยตั้งค่าฟิลด์ messages.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()

cURL

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 เมธอด พร้อมพารามิเตอร์การค้นหา format=raw

ดูข้อมูลเพิ่มเติมได้ที่ drafts.update เมธอด

ส่งฉบับร่าง

เมื่อส่งฉบับร่าง คุณจะส่งฉบับร่างตามที่เป็นอยู่ หรือระบุการอัปเดตในคำขอส่งก็ได้

หากต้องการอัปเดตฉบับร่างเมื่อส่ง ให้ระบุทรัพยากร drafts ในเนื้อหาคำขอ ของเมธอด drafts.send ในทรัพยากร drafts คุณต้องระบุฉบับร่าง idของ ฉบับร่างที่จะส่งและตั้งค่าฟิลด์ messages.raw เป็นข้อความ MIME ใหม่ ที่เข้ารหัสเป็นสตริง base64URL

ดูข้อมูลเกี่ยวกับการส่งข้อความ Gmail ได้ที่หัวข้อส่ง ข้อความ