Mit Entwürfen arbeiten

Entwürfe stellen nicht gesendete Nachrichten mit dem Systemlabel „DRAFT“ dar. Die im Entwurf enthaltene Nachricht kann nach dem Erstellen nicht mehr bearbeitet werden. ersetzt werden können. In diesem Sinne Ressourcenentwurf ist einfach ein Container eine stabile ID, da sich die zugrunde liegenden Nachrichten-IDs jedes Mal ändern. wird die Nachricht ersetzt.

Nachrichtenressourcen in einem Entwurf verhalten sich ähnlich wie andere Nachrichten, mit Ausnahme der folgenden Unterschiede:

  • Nachrichtenentwürfe dürfen nur das Systemlabel „DRAFT“ haben.
  • Wenn der Entwurf gesendet wird, wird er automatisch gelöscht und es gibt eine neue Nachricht mit einer aktualisierten ID wird mit dem Systemlabel SENT erstellt. Diese Nachricht ist zurückgegeben im drafts.send Antwort.

Inhalt

Nachrichtenentwürfe erstellen

Ihre Anwendung kann Entwürfe mithilfe der drafts.create. Die lautet der allgemeine Prozess:

  1. Erstellen Sie eine MIME-Nachricht, die den RFC 2822.
  2. Konvertieren Sie die Nachricht in einen base64url-codierten String.
  3. Erstellen Sie einen Entwurf, indem Sie des Felds drafts.message.raw in den codierten String um.

Die folgenden Codebeispiele veranschaulichen den Prozess.

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

Entwürfe aktualisieren

Ähnlich wie beim Erstellen eines Entwurfs müssen Sie beim Aktualisieren eines Entwurfs Draft angeben. Ressource im Text Ihrer Anfrage mit dem Feld draft.message.raw. auf einen base64url-codierten String festgelegt, der die MIME-Nachricht enthält. Weil Nachrichten können nicht aktualisiert werden, die im Entwurf enthaltene Nachricht wird gelöscht und durch die neue MIME-Nachricht aus der Aktualisierungsanfrage ersetzt.

Sie können die aktuelle MIME-Nachricht im Entwurf abrufen, indem Sie folgenden Befehl aufrufen: drafts.get mit dem Parameter format=raw.

Weitere Informationen finden Sie unter drafts.update.

Entwürfe werden gesendet

Beim Senden eines Entwurfs können Sie auswählen, ob die Nachricht unverändert oder mit einem aktualisierte Nachricht. Wenn Sie den Inhalt des Entwurfs mit einer neuen Nachricht aktualisieren, eine Draft-Ressource im Text des drafts.send-Anfrage leg fest, draft.id des zu sendenden Entwurfs; und setzen Sie das Feld draft.message.raw auf neue MIME-Nachricht, codiert als base64url-codierter String. Weitere Informationen Weitere Informationen finden Sie unter drafts.send.