E‑Mail-Entwürfe erstellen und senden

In diesem Dokument wird beschrieben, wie Sie mit der Gmail API E-Mail-Entwürfe erstellen, aktualisieren und senden.

E-Mail-Entwürfe sind nicht gesendete Nachrichten mit dem Systemlabel DRAFT. Die Nachricht im Entwurf kann nach der Erstellung nicht mehr bearbeitet, aber ersetzt werden. In diesem Sinne ist die drafts-Ressource ein Container, der eine stabile ID bereitstellt, da sich die zugrunde liegenden Nachrichten-IDs jedes Mal ändern, wenn die Nachricht ersetzt wird.

Die Ressource messages in einem Entwurf verhält sich ähnlich wie andere Nachrichten, mit den folgenden Unterschieden:

Entwürfe dürfen kein anderes Label als das Systemlabel DRAFT haben.
Wenn der Entwurf gesendet wird, wird er automatisch gelöscht und eine neue Nachricht mit einer aktualisierten ID und dem Systemlabel SENT erstellt. Diese Nachricht wird in der Antwort der Methode drafts.send zurückgegeben.

Entwürfe erstellen

Ihre App kann mit der Methode drafts.create Entwürfe erstellen. So erstellen Sie einen Entwurf:

Erstellen Sie eine MIME-Nachricht, die RFC 2822 entspricht.
Wandeln Sie die Nachricht in einen base64URL-codierten String um.
Rufen Sie die Methode drafts.create auf und legen Sie den Wert des Felds messages.raw auf den codierten String fest.

Die folgenden Codebeispiele veranschaulichen den Prozess:

Java

gmail/snippets/src/main/java/CreateDraft.java

Auf GitHub ansehen

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

Auf GitHub ansehen

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

Ersetzen Sie Folgendes:

ACCESS_TOKEN: Das Zugriffstoken, das den Zugriff auf die API gewährt.
MESSAGE: Die als base64URL codierte MIME-Nachricht im RFC 2822-Format.

Entwürfe aktualisieren

Ähnlich wie beim Erstellen eines Entwurfs müssen Sie zum Aktualisieren eines Entwurfs eine drafts-Ressource im Text Ihrer Anfrage angeben, wobei das Feld messages.raw auf einen base64URL-codierten String mit der MIME-Nachricht festgelegt sein muss. Da Nachrichten nicht aktualisiert werden können, wird die Nachricht im Entwurf gelöscht und durch die neue MIME-Nachricht ersetzt, die in der Aktualisierungsanfrage angegeben ist.

Sie können die aktuelle MIME-Nachricht im Entwurf abrufen, indem Sie die Methode drafts.get mit dem Abfrageparameter format=raw aufrufen.

Weitere Informationen finden Sie im Artikel zur Methode drafts.update.

Entwürfe senden

Wenn Sie einen Entwurf senden, können Sie ihn unverändert senden oder in der Sendanfrage Aktualisierungen vornehmen.

Wenn Sie den Entwurf beim Senden aktualisieren möchten, geben Sie im Anfragebody der Methode drafts.send eine drafts-Ressource an. In der drafts-Ressource müssen Sie den id des zu sendenden Entwurfs angeben und das Feld messages.raw auf die neue MIME-Nachricht setzen, die als base64URL-String codiert ist.

Informationen zum Senden einer Gmail-Nachricht finden Sie unter Nachrichten senden.

E‑Mail-Entwürfe erstellen und senden Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.