Utilizzo delle bozze

Le bozze rappresentano i messaggi non inviati a cui è stata applicata l'etichetta di sistema DRAFT. Il messaggio contenuto nella bozza non può essere modificato una volta creato, ma può essere sostituito. In questo senso, la risorsa bozza è semplicemente un contenitore che fornisce un ID stabile perché gli ID messaggio sottostanti cambiano ogni volta che il messaggio viene sostituito.

Le risorse dei messaggi all'interno di una bozza hanno un comportamento simile a quello degli altri messaggi, ad eccezione delle seguenti differenze:

  • Le bozze dei messaggi non possono avere etichette diverse da quella di sistema DRAFT.
  • Quando la bozza viene inviata, viene eliminata automaticamente e viene creato un nuovo messaggio con un ID aggiornato e l'etichetta di sistema SENT. Questo messaggio viene restituito nella risposta drafts.send.

Sommario

Creazione di bozze di messaggi

La tua applicazione può creare bozze utilizzando il metodo drafts.create. La procedura generale è la seguente:

  1. Crea un messaggio MIME conforme a RFC 2822.
  2. Converti il messaggio in una stringa codificata in base64url.
  3. Crea una bozza, impostando il valore del campo drafts.message.raw sulla stringa codificata.

I seguenti esempi di codice mostrano la procedura.

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

Aggiornamento delle bozze

Analogamente alla creazione di una bozza, per aggiornarla devi fornire una risorsa Draft nel corpo della richiesta con il campo draft.message.raw impostato su una stringa codificata base64url contenente il messaggio MIME. Poiché i messaggi non possono essere aggiornati, il messaggio contenuto nella bozza viene eliminato e sostituito dal nuovo messaggio MIME fornito nella richiesta di aggiornamento.

Puoi recuperare il messaggio MIME corrente contenuto nella bozza chiamando drafts.get con il parametro format=raw.

Per ulteriori informazioni, vedi drafts.update.

Invio di bozze

Quando invii una bozza, puoi scegliere di inviare il messaggio così com'è o con un messaggio aggiornato. Se stai aggiornando i contenuti della bozza con un nuovo messaggio, fornisci una risorsa Draft nel corpo della richiesta drafts.send; imposta draft.id della bozza da inviare e imposta il campo draft.message.raw sul nuovo messaggio MIME codificato come stringa codificata base64url. Per ulteriori informazioni, vedi drafts.send.