質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

89.96%

[rails] メールのencodeについて教えてください。

受付中

回答 1

投稿

  • 評価
  • クリップ 0
  • VIEW 127

pikkerukun

score 1

前提・実現したいこと

当方、プログラミングを始めて3か月の初心者です。

現在、rails 5.2.3でメールの自動送信機能を実装しようとしております。
production環境はheroku&sendgridを利用しています。

rails チュートリアルを参考にメール本文を日本語にして、
下記のようなテストコードを書いたところ、
エンコードに関するエラーが発生しており、困っております。
どのようにテストコードを書き換えるべきか、またはエンコードの設定をすべきか
ご教示のほど、よろしくお願いします。

class UserMailerTest < ActionMailer::TestCase

  test "アカウント開設用URLのご案内" do
    user = users(:michael)
    user.activation_token = User.new_token
    mail = UserMailer.account_activation(user)
    assert_equal "アカウント開設用URLのご案内", mail.subject
    assert_equal [user.email], mail.to
    assert_equal ["noreply@yoursite.com"], mail.from
    assert_equal [ENV['YAHOOMAIL_ADRESS']], mail.bcc
    assert_match user.email,              mail.body.encoded
    assert_match user.activation_token,   mail.body.encoded
    assert_match CGI.escape(user.email),  mail.body.encoded
  end
end

発生している問題・エラーメッセージ

Failure:
UserMailerTest#test_アカウント開設用URLのご案内 [/home/vagrant/workspace/app/test/mailers/user_mailer_test.rb:13]:
Expected /michael@example\.com/ to match # encoding: US-ASCII
#    valid: true
"\r\n----==_mimepart_5dc16b84311c1_e422b0a01ce39946426b\r\nContent-Type: text/plain;\r\n charset=UTF-8\r\nContent-Transfer-Encoding: 
base64\r\n\r\(省略)==\r\n\r\n----
==_mimepart_5dc16b84311c1_e422b0a01ce39946426b\r\nContent-Type: text/html;\r\n charset=UTF-8\r\nContent-Transfer-Encoding: 
base64\r\n\r\(省略)==\r\n\r\n----
==_mimepart_5dc16b84311c1_e422b0a01ce39946426b--\r\n".


bin/rails test test/mailers/user_mailer_test.rb:5

現在の対応

railsにはdefaultでhtmlとtextの2種類のメール本文がありますが、
htmlは<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />と設定されているようですので、対策として現在は下記のようなコードを書いています。

class UserMailerTest < ActionMailer::TestCase

  test "アカウント開設用URLのご案内" do
    user = users(:michael)
    user.activation_token = User.new_token
    mail = UserMailer.account_activation(user)
    assert_equal "アカウント開設用URLのご案内", mail.subject
    assert_equal [user.email], mail.to
    assert_equal ["noreply@yoursite.com"], mail.from
    assert_equal [ENV['YAHOOMAIL_ADRESS']], mail.bcc
    assert_match user.email,               
    mail.text_part.body.to_s.encode("UTF-8")
    assert_match user.email,mail.html_part.body.encoded
    assert_match user.activation_token,   
    mail.text_part.body.to_s.encode("UTF-8")
    assert_match user.activation_token,mail.html_part.body.encoded
    assert_match CGI.escape(user.email),  
    mail.text_part.body.to_s.encode("UTF-8")
    assert_match CGI.escape(user.email),mail.html_part.body.encoded
  end
end

疑問点・補足

①railsの ApplicationMailerはdefaultでcharset=UTF-8と
設定されているようですが、送信時に
UTF-8を一端ASCII文字(7bit文字)のbase64にエンコードして、
再度、受信側でデコードするのでしょうか?
②なぜtext形式のみこのようになっているのでしょうか?
③どのようにテストコードを書き換えるべきでしょうか。
assert_equrlの期待値をbase64に変換する?

なお、gmailやyahooメールで受信したところ、文字化け等はありませんでした。

以上よろしくお願いいたします。

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 1

+1

送信時に
UTF-8を一端ASCII文字(7bit文字)のbase64にエンコードして、
再度、受信側でデコードするのでしょうか?

昔はSMTPで7ビットしか転送できることが保証されていなかった(そして現在もそのようなメールサーバが残っている危険がある)ため、8ビット目のあるデータについては、Base64やQuoted-printableでエンコードして、7ビット以下に落とすこととなります。

②なぜtext形式のみこのようになっているのでしょうか?

HTMLメールも同様にエンコードされますが、中身にアクセスしようとした段階でデコードされます。

③どのようにテストコードを書き換えるべきでしょうか。
assert_equrlの期待値をbase64に変換する?

テストコードで、わざわざmail.body.encodedを取得しているのが原因かと思われます。mail.body.decodedとしてはどうでしょうか。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2019/11/06 17:07 編集

    ご返信ありがとうございます。色々調べており、返信が遅くなりました。
    申し訳ございません。以下の2つ質問があります。
    ①メール本文はもともと8bitデータ(utf-8等)で構成され、送信時に7bitデータ(ASCII文字)へ変換、開封時に8bitデータに戻ると理解しました。そうなると、
    `mail.body.decoded` : UTF-8へ変換?
    `mail.body.encoded `: ASCII文字へ変換
    となるのでしょうか。


    `assert_match user.email,mail.body.decoded`のようにコードを変えて、再度`メールアドレスが、メール本文に含まれているかどうかをテスト`をしたのですが、以下のエラーが発生しました。

    ```
    UserMailerTest#test_アカウント開設用URLのご案内 [/home/vagrant/workspace/app/test/mailers/user_mailer_test.rb:13]:
    Expected /michael@example\.com/ to match "".
    ```
    mail.bodyだけでUTF-8になるのかと考え、
    `assert_match user.email,mail.body`
    ともしてみたのですが、
    `no implicit conversion of Mail::Body into String`とエラーが発生しましたので、やはり何かしらencodeは必要なようです。

    もう一度何かテスト方法をご教授願えますでしょうか。

    キャンセル

  • 2019/11/06 20:28

    assert_match user.email,mail.body.decodedではテストが通らなかったのですが、下記のような記入をしたところ、原因が不明ですが、テストが通りました。
    ```
    assert_match user.email,mail.html_part.body.decoded
    assert_match user.email,mail.text_part.body.decoded
    ```
    なぜなのでしょうか。

    キャンセル

  • 2019/11/07 10:39

    その後、`assert_match user.email,mail.body.raw_source`や`assert_match user.email,mail.body.to_s`等も試してみましたが、`assert_match user.email,mail.body.decoded`と同様のエラーとなりました。
    最終的には
    assert_match user.email,mail.html_part.body.encoded
    assert_match user.email,mail.text_part.body.encoded
    としましたが、いまいち理解ができておりません。
    どなたかご教示いただけますと幸いです。

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 89.96%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる