オープンソースRubyメール作成・処理ライブラリ

Mail の入門

Ruby-Gmail ライブラリをインストールする最も簡単な方法は RubyGems を使用することです。簡単にインストールできるよう、以下のコマンドをご利用ください。

gem install gmail

Ruby アプリ内のメール認証

オープンソースの Ruby-Gmail ライブラリは、OAuth2 やプレーンなユーザー名/パスワードなど、複数の認証方法をサポートしています。Gmail アドレスとパスワード、またはアプリ固有のパスワード（2FA アカウントに推奨）を使用したシンプルなログインが可能です。あるいは、OAuth を使用する必要がある場合や、スクリプト外でログインを処理したい場合は、Ruby-Gmail はブロックベースの接続をサポートしています。セキュリティ上、パスワードをハードコーディングしないで、環境変数やシークレット管理を使用してください。以下のコード例は、Ruby API を介したメール認証処理の両方の方法を示しています。

require 'gmail'

# Basic authentication (less secure)
gmail = Gmail.connect(username, password)

# OAuth2 authentication (recommended)
gmail = Gmail.connect(:oauth2, username, access_token)

Ruby API を使用したメールの検索とフィルタリング

Ruby-Gmail ライブラリは、Ruby アプリケーション内でメールメッセージを簡単に読み取り、検索するための完全な機能を提供しています。開発者は受信トレイや未読メッセージにアクセスしたり、件名、送信者、日付で簡単に検索できます。このライブラリは、Gmail の検索演算子と同様の強力な検索インターフェースを提供します。以下の例は、ソフトウェア開発者が Ruby アプリ内でメールメッセージを検索するさまざまな方法を適用できることを示しています。

# Search for unread emails from a specific sender
emails = gmail.inbox.emails(:unread, from: 'notifications@example.com')

# Search by subject
emails = gmail.inbox.emails(subject: 'Your monthly report')

# Complex searches
emails = gmail.inbox.emails(after: Date.parse('2023-01-01'), 
                           before: Date.parse('2023-01-31'),
                           has: 'attachment')

Ruby を使用したメールの作成と送信

オープンソースの Ruby-Gmail ライブラリは、数行の Ruby コードだけでメールメッセージの作成と送信を完全にサポートしています。このライブラリは、メールの作成と送信をシンプルにし、HTML コンテンツやファイル、画像の添付、バルクメールの送信、スタイルやフォーマットの適用などが可能です。以下の例は、ソフトウェア開発者が Ruby アプリ内でメールメッセージに HTML コンテンツと添付ファイルを追加する方法を示しています。

gmail.deliver do
  to "recipient@example.com"
  subject "Hello from Ruby-Gmail"
  text_part do
    body "This is a test email sent using Ruby-Gmail."
  end
end

# add HTML content and attachments
gmail.deliver do
  to "recipient@example.com"
  subject "Invoice Attached"
  text_part do
    body "Please see the attached invoice."
  end
  add_file "/path/to/invoice.pdf"
end

Ruby API を使用したメールのアーカイブ、削除、移動

Ruby-Gmail ライブラリは機能が豊富で、Ruby アプリケーション内でメールのライフサイクル操作をスムーズに処理できます。ソフトウェア開発者は、メールを移動、ラベル付け、既読/未読のマーク付けなどで簡単に管理でき、さらにメールをスター付きにしたり、未読にしたり、別のフォルダーに移動したりすることも容易です。以下の Ruby コード例は、メールにマークを付け、ラベルを追加し、フォルダーに移動する方法を Ruby アプリケーション内で示しています。

email = gmail.inbox.emails.first

# Mark as read/unread
email.read!
email.unread!

# Add/remove labels
email.label('Important')
email.remove_label('Important')

# Move to folder
email.move_to('Archive')