Создавайте и отправляйте черновики электронных писем.

В этом документе объясняется, как создавать, обновлять и отправлять черновики электронных писем с помощью API Gmail.

Черновики электронных писем представляют собой неотправленные сообщения с системной меткой 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
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"}}'

Замените следующее:

  • 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 см. раздел «Отправка сообщений» .