E-posta taslakları oluşturma ve gönderme

Bu belgede, Gmail API'yi kullanarak taslak e-postaların nasıl oluşturulacağı, güncelleneceği ve gönderileceği açıklanmaktadır.

E-posta taslakları, DRAFT sistem etiketi uygulanmış, gönderilmemiş iletileri temsil eder. Taslakta yer alan ileti, oluşturulduktan sonra düzenlenemez ancak değiştirilebilir. Bu anlamda, temel mesaj kimlikleri her mesaj değiştirildiğinde değiştiği için drafts kaynağı, sabit bir kimlik sağlayan bir kapsayıcıdır.

Taslak içindeki messages kaynağı, aşağıdaki farklar dışında diğer iletilerle benzer davranışlara sahiptir:

  • Taslak iletilerde DRAFT sistem etiketi dışında etiket bulunamaz.
  • Taslak gönderildiğinde otomatik olarak silinir ve SENT sistem etiketiyle güncellenmiş kimliğe sahip yeni bir ileti oluşturulur. Bu mesaj, drafts.send yöntemi yanıtında döndürülür.

Taslak oluşturma

Uygulamanız, drafts.create yöntemini kullanarak taslak oluşturabilir. Taslak oluşturmak için:

  1. RFC 2822 ile uyumlu bir MIME iletisi oluşturun.
  2. İletiyi Base64URL kodlu bir dizeye dönüştürün.
  3. drafts.create yöntemini çağırın ve messages.raw alanının değerini kodlanmış dize olarak ayarlayın.

Aşağıdaki kod örneklerinde bu işlem gösterilmektedir:

Java

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

Python

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

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"}}'

Aşağıdakini değiştirin:

  • ACCESS_TOKEN: API'ye erişim izni veren erişim jetonu.
  • MESSAGE: RFC 2822 biçiminde MIME mesajı, base64URL olarak kodlanmış.

Taslakları güncelle

Taslak oluşturmaya benzer şekilde, taslağı güncellemek için isteğinizin gövdesinde drafts kaynağını, messages.raw alanı MIME mesajını içeren bir base64URL kodlu dize olarak ayarlanmış şekilde sağlamanız gerekir. İletiler güncellenemediğinden taslakta bulunan ileti silinir ve güncelleme isteğinde sağlanan yeni MIME iletisiyle değiştirilir.

format=raw sorgu parametresiyle drafts.get yöntemini çağırarak taslakta bulunan mevcut MIME mesajını alabilirsiniz.

Daha fazla bilgi için drafts.update yöntemine bakın.

Taslakları gönderme

Taslak gönderirken olduğu gibi gönderebilir veya gönderme isteğinde güncellemeler sağlayabilirsiniz.

Gönderirken taslağı güncellemek için drafts.send yönteminin istek gövdesinde bir drafts kaynağı sağlayın. drafts kaynağında, gönderilecek taslağın id sürümünü belirtmeniz ve messages.raw alanını base64URL dizesi olarak kodlanmış yeni MIME mesajına ayarlamanız gerekir.

Gmail iletisi gönderme hakkında bilgi edinmek için İleti gönderme başlıklı makaleyi inceleyin.