Gmail API を使用してメールを送信するには、次の 2 つの方法があります。
- これは、
messages.send
メソッドを使用して直接送信できます。 - 下書きから送信するには、
drafts.send
メソッドを使用します。
メールは、メッセージ リソースの raw
プロパティ内で、base64url でエンコードされた文字列として送信されます。メールを送信する大まかなワークフローは次のとおりです。
- メール コンテンツを任意の方法で作成し、base64url 文字列としてエンコードします。
- 新しいメッセージ リソースを作成し、その
raw
プロパティを先ほど作成した base64url 文字列に設定します。 messages.send
を呼び出すか、下書きを送信する場合はdrafts.send
を呼び出してメッセージを送信します。
このワークフローの詳細は、選択したクライアント ライブラリとプログラミング言語によって異なります。
メッセージの作成
Gmail API では、RFC 2822 を遵守し、base64url 文字列としてエンコードされた MIME メール メッセージが必要です。多くのプログラミング言語には、MIME メッセージの作成とエンコードのプロセスを簡素化するライブラリやユーティリティがあります。次のコード例は、さまざまな言語の Google API クライアント ライブラリを使用して MIME メッセージを作成する方法を示しています。
Java
メール メッセージの作成は、javax.mail.internet
パッケージの MimeMessage
クラスを使用して大幅に簡素化できます。次の例は、ヘッダーを含むメール メッセージを作成する方法を示しています。
import java.util.Properties; import javax.mail.MessagingException; import javax.mail.Session; import javax.mail.internet.InternetAddress; import javax.mail.internet.MimeMessage; /* Class to demonstrate the use of Gmail Create Email API */ public class CreateEmail { /** * Create a MimeMessage using the parameters provided. * * @param toEmailAddress email address of the receiver * @param fromEmailAddress email address of the sender, the mailbox account * @param subject subject of the email * @param bodyText body text of the email * @return the MimeMessage to be used to send email * @throws MessagingException - if a wrongly formatted address is encountered. */ public static MimeMessage createEmail(String toEmailAddress, String fromEmailAddress, String subject, String bodyText) throws MessagingException { 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(subject); email.setText(bodyText); return email; } }
次のステップでは、MimeMessage
をエンコードして Message
オブジェクトをインスタンス化し、base64url でエンコードされたメッセージ文字列を raw
プロパティの値として設定します。
import com.google.api.services.gmail.model.Message; import java.io.ByteArrayOutputStream; import java.io.IOException; import javax.mail.MessagingException; import javax.mail.internet.MimeMessage; import org.apache.commons.codec.binary.Base64; /* Class to demonstrate the use of Gmail Create Message API */ public class CreateMessage { /** * Create a message from an email. * * @param emailContent Email to be set to raw of message * @return a message containing a base64url encoded email * @throws IOException - if service account credentials file not found. * @throws MessagingException - if a wrongly formatted address is encountered. */ public static Message createMessageWithEmail(MimeMessage emailContent) throws MessagingException, IOException { ByteArrayOutputStream buffer = new ByteArrayOutputStream(); emailContent.writeTo(buffer); byte[] bytes = buffer.toByteArray(); String encodedEmail = Base64.encodeBase64URLSafeString(bytes); Message message = new Message(); message.setRaw(encodedEmail); return message; } }
Python
次のコードサンプルは、MIME メッセージを作成して base64url 文字列にエンコードし、Message
リソースの raw
フィールドに割り当てる方法を示しています。
from __future__ import print_function 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()
添付ファイル付きのメッセージの作成
添付ファイル付きのメッセージの作成は他のメッセージの作成と同様ですが、ファイルをマルチパート MIME メッセージとしてアップロードするプロセスは、プログラミング言語によって異なります。次のコード例は、添付ファイル付きのマルチパート MIME メッセージを作成する方法を示しています。
Java
次の例は、マルチパート MIME メッセージの作成方法を示しています。エンコードと割り当ての手順は上記と同じです。
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.File; import java.io.IOException; import java.util.Properties; import javax.activation.DataHandler; import javax.activation.DataSource; import javax.activation.FileDataSource; import javax.mail.MessagingException; import javax.mail.Multipart; import javax.mail.Session; import javax.mail.internet.InternetAddress; import javax.mail.internet.MimeBodyPart; import javax.mail.internet.MimeMessage; import javax.mail.internet.MimeMultipart; import org.apache.commons.codec.binary.Base64; /* Class to demonstrate the use of Gmail Create Draft with attachment API */ public class CreateDraftWithAttachment { /** * Create a draft email with attachment. * * @param fromEmailAddress - Email address to appear in the from: header. * @param toEmailAddress - Email address of the recipient. * @param file - Path to the file to be attached. * @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 createDraftMessageWithAttachment(String fromEmailAddress, String toEmailAddress, File file) 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); MimeBodyPart mimeBodyPart = new MimeBodyPart(); mimeBodyPart.setContent(bodyText, "text/plain"); Multipart multipart = new MimeMultipart(); multipart.addBodyPart(mimeBodyPart); mimeBodyPart = new MimeBodyPart(); DataSource source = new FileDataSource(file); mimeBodyPart.setDataHandler(new DataHandler(source)); mimeBodyPart.setFileName(file.getName()); multipart.addBodyPart(mimeBodyPart); email.setContent(multipart); // 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.getDetails()); } else { throw e; } } return null; } }
Python
上記の例と同様に、この例では、メッセージの base64url のエンコードを処理し、Message
リソースの raw
フィールドに割り当てます。
from __future__ import print_function import base64 import mimetypes import os from email.message import EmailMessage from email.mime.audio import MIMEAudio from email.mime.base import MIMEBase from email.mime.image import MIMEImage from email.mime.text import MIMEText import google.auth from googleapiclient.discovery import build from googleapiclient.errors import HttpError def gmail_create_draft_with_attachment(): """Create and insert a draft email with attachment. 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) mime_message = EmailMessage() # headers mime_message['To'] = 'gduser1@workspacesamples.dev' mime_message['From'] = 'gduser2@workspacesamples.dev' mime_message['Subject'] = 'sample with attachment' # text mime_message.set_content( 'Hi, this is automated mail with attachment.' 'Please do not reply.' ) # attachment attachment_filename = 'photo.jpg' # guessing the MIME type type_subtype, _ = mimetypes.guess_type(attachment_filename) maintype, subtype = type_subtype.split('/') with open(attachment_filename, 'rb') as fp: attachment_data = fp.read() mime_message.add_attachment(attachment_data, maintype, subtype) encoded_message = base64.urlsafe_b64encode(mime_message.as_bytes()).decode() create_draft_request_body = { 'message': { 'raw': encoded_message } } # pylint: disable=E1101 draft = service.users().drafts().create(userId="me", body=create_draft_request_body)\ .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 def build_file_part(file): """Creates a MIME part for a file. Args: file: The path to the file to be attached. Returns: A MIME part that can be attached to a message. """ content_type, encoding = mimetypes.guess_type(file) if content_type is None or encoding is not None: content_type = 'application/octet-stream' main_type, sub_type = content_type.split('/', 1) if main_type == 'text': with open(file, 'rb'): msg = MIMEText('r', _subtype=sub_type) elif main_type == 'image': with open(file, 'rb'): msg = MIMEImage('r', _subtype=sub_type) elif main_type == 'audio': with open(file, 'rb'): msg = MIMEAudio('r', _subtype=sub_type) else: with open(file, 'rb'): msg = MIMEBase(main_type, sub_type) msg.set_payload(file.read()) filename = os.path.basename(file) msg.add_header('Content-Disposition', 'attachment', filename=filename) return msg if __name__ == '__main__': gmail_create_draft_with_attachment()
メッセージの送信
メッセージを作成したら、次の例に示すように、messages.send
呼び出しのリクエスト本文でそのメッセージを送信できます。
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.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 Send Message API */ public class SendMessage { /** * Send an email from the user's mailbox to its recipient. * * @param fromEmailAddress - Email address to appear in the from: header * @param toEmailAddress - Email address of the recipient * @return the sent message, {@code null} otherwise. * @throws MessagingException - if a wrongly formatted address is encountered. * @throws IOException - if service account credentials file not found. */ public static Message sendEmail(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_SEND); 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 send message message = service.users().messages().send("me", message).execute(); System.out.println("Message id: " + message.getId()); System.out.println(message.toPrettyString()); return message; } catch (GoogleJsonResponseException e) { // TODO(developer) - handle error appropriately GoogleJsonError error = e.getDetails(); if (error.getCode() == 403) { System.err.println("Unable to send message: " + e.getDetails()); } else { throw e; } } return null; } }
Python
from __future__ import print_function import base64 from email.message import EmailMessage import google.auth from googleapiclient.discovery import build from googleapiclient.errors import HttpError def gmail_send_message(): """Create and send an email message Print the returned message id Returns: Message object, including message id 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: 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 = { 'raw': encoded_message } # pylint: disable=E1101 send_message = (service.users().messages().send (userId="me", body=create_message).execute()) print(F'Message Id: {send_message["id"]}') except HttpError as error: print(F'An error occurred: {error}') send_message = None return send_message if __name__ == '__main__': gmail_send_message()
メールを返信する際、スレッドに返信するには、以下のことを確認してください。
Subject
ヘッダーが一致References
ヘッダーとIn-Reply-To
ヘッダーは、RFC 2822 標準に準拠しています。
下書きからメッセージを送信する方法については、下書きの作成をご覧ください。