ActionMailer overrides header[:parts_order] when a block is passed to #mail #7978

Closed
nateberkopec opened this Issue Oct 17, 2012 · 2 comments

Projects

None yet

3 participants

Contributor

We discovered that our application's mails were displaying as plaintext in Gmail. After some investigation, we realized the mime parts were being sent in the opposite of the normal order - instead of text then html it was being mailed as html then text. According to the RFC, the mail client should render the last compatible mimepart, which Gmail does.

So, I started digging into our stack and trying to figure out why the order was getting flopped and setting header[:parts_order] in our mailer had no effect.

I realized this mail in particular was the only one where we were passing a block to #mail.

mail do |format|
  format.html
  format.text 
end

Some more chugging through ActionMailer and I discovered that if a block is passed into mail, #collect_responses_and_parts_order sets the parts_order for the email, which overrides header[:parts_order]. Aha! So reordering the format.* lines in my block set the correct order in my mail.

I don't know if this is a documentation issue or a problem with the API - nowhere in the documentation is it very explicit that changing the order of the mail block also changes the order of the mail parts.

It's weird to me because I'm used to writing format.* stuff in the controller, and obviously in the context of a typical ActionController instance that order doesn't matter, but in ActionMailer it does - which strikes me as confusing. I'd suggest that ActionMailer should respect parts_order if it is set, or perhaps even ignore the order of the passed block completely.

Let me know if you guys think this is a documentation problem or an API problem, and I'll investigate a fix.

Member

I would lean towards documentation, but I can see how it may be API as well.

Owner

Closed by #8044

@pftg pftg added a commit to jetthoughts/rails that referenced this issue Jun 25, 2013
@pftg pftg Bacported explicit multipart messages respect :parts_order
As issue #7978, the order in which ActionMailer
sends multipart messages could be unintentionally
overwritten if a block is passed to the mail
method. This changes the mail method such that
:parts_order is always respected, regardless of
whether a block is passed to mail.
72af6ce
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment