ड्राफ़्ट के साथ काम करना

ड्राफ़्ट में, ऐसे मैसेज दिखते हैं जिन्हें भेजा नहीं गया है. इन पर DRAFT सिस्टम लेबल लागू होता है. ड्राफ़्ट में मौजूद मैसेज बनाने के बाद, उसमें बदलाव नहीं किया जा सकता. हालांकि, उसे बदला जा सकता है. इस लिहाज़ से, ड्राफ़्ट रिसॉर्स सिर्फ़ एक कंटेनर है, जो एक स्थिर आईडी उपलब्ध कराता है. ऐसा इसलिए होता है, क्योंकि मैसेज बदलने पर, मैसेज के आईडी हर बार बदल जाते हैं.

ड्राफ़्ट में मौजूद मैसेज के संसाधन, दूसरे मैसेज की तरह ही काम करते हैं. हालांकि, इनमें ये अंतर होते हैं:

  • ड्राफ़्ट किए गए मैसेज पर, DRAFT सिस्टम लेबल के अलावा कोई दूसरा लेबल नहीं हो सकता.
  • ड्राफ़्ट भेजे जाने के बाद, वह अपने-आप मिट जाता है. साथ ही, SENT सिस्टम लेबल के साथ अपडेट किए गए आईडी वाला एक नया मैसेज बन जाता है. यह मैसेज, drafts.send रिस्पॉन्स में दिखाया जाता है.

कॉन्टेंट

मैसेज का ड्राफ़्ट बनाना

आपका ऐप्लिकेशन, drafts.create तरीके का इस्तेमाल करके ड्राफ़्ट बना सकता है. आम तौर पर, यह प्रोसेस इस तरह होती है:

  1. आरएफ़सी 2822 के मुताबिक एमआईएम मैसेज बनाएं.
  2. मैसेज को base64url कोड में बदली गई स्ट्रिंग में बदलें.
  3. drafts.message.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()

ड्राफ़्ट अपडेट करना

ड्राफ़्ट बनाने की तरह ही, ड्राफ़्ट को अपडेट करने के लिए, आपको अपने अनुरोध के मुख्य हिस्से में Draft संसाधन देना होगा. साथ ही, draft.message.raw फ़ील्ड को MIME मैसेज वाली Base64url एन्कोड की गई स्ट्रिंग पर सेट करना होगा. मैसेज को अपडेट नहीं किया जा सकता. इसलिए, ड्राफ़्ट में मौजूद मैसेज को मिटा दिया जाता है और अपडेट के अनुरोध में दिए गए नए एमआईएम मैसेज से बदल दिया जाता है.

पैरामीटर format=raw के साथ drafts.get को कॉल करके, ड्राफ़्ट में मौजूद मौजूदा एमआईएम मैसेज को वापस पाया जा सकता है.

ज़्यादा जानकारी के लिए, drafts.update देखें.

ड्राफ़्ट भेजना

ड्राफ़्ट भेजते समय, आपके पास मैसेज को उसी तरह भेजने या अपडेट किए गए मैसेज के तौर पर भेजने का विकल्प होता है. अगर ड्राफ़्ट के कॉन्टेंट को नए मैसेज से अपडेट किया जा रहा है, तो drafts.send अनुरोध के बॉडी में Draft संसाधन दें. साथ ही, भेजे जाने वाले ड्राफ़्ट का draft.id सेट करें और draft.message.raw फ़ील्ड को base64url एन्कोड की गई स्ट्रिंग के तौर पर एन्कोड किए गए नए एमआईएम मैसेज पर सेट करें. ज़्यादा जानकारी के लिए, drafts.send देखें.