[Mailer] Fix attachment content encoding for SendgridTransport #32645
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -146,6 +146,14 @@ public function getPreparedHeaders(): Headers | |||
| return $headers; | |||
| } | |||
|
|
|||
| /** | |||
| * @internal | |||
There was a problem hiding this comment.
it doesn't make sense to me to have an internal method for cross component uses
if we think this is a needed API, we should commit to it
There was a problem hiding this comment.
I'm against making this public, that leaks internal information I don't want to expose.
| @@ -113,9 +113,11 @@ private function getAttachments(Email $email): array | |||
| $headers = $attachment->getPreparedHeaders(); | |||
| $filename = $headers->getHeaderParameter('Content-Disposition', 'filename'); | |||
| $disposition = $headers->getHeaderBody('Content-Disposition'); | |||
| // Sendgrid does not accept line breaks for base64 encoded attachments | |||
| $content = 'base64' === $attachment->getEncoding() ? base64_encode($attachment->getBody()) : $attachment->bodyToString(); | |||
There was a problem hiding this comment.
this looks like bypassing the encoding abstraction
can't we instead decide for the encoding earlier? (a line-break-less variant of base64)
There was a problem hiding this comment.
We can have a specific base64 encoder, but it can’t be done earlier since the email is not aware of the transport. The transport would have to set the encoder on each attachment (DataPart instance) at send time
nicolas-grekas
added a commit
that referenced
this pull request
Jan 4, 2020
…tuart Fyfe) This PR was squashed before being merged into the 4.3 branch. Discussion ---------- [Mailer] Remove line breaks in email attachment content Line breaks are not allowed in attachment content when sending over the API. | Q | A | ------------- | --- | Branch? | 4.3 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Fix #33671, Closes #32645 | License | MIT | Doc PR | This is a fix for #33671. Send grid's API throws a 400 error when sending email attachments with default base64 encoding. Removing the line breaks resolves this issue. Commits ------- a28a7f9 [Mailer] Remove line breaks in email attachment content
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Using the SendgridTransport (HTTP), emails cannot be sent as soon as they have attachments.
This is due to Sendgrid not supporting line breaks in base64 encoded content (encoding is considered invalid, which results in a 400 response from the Sendgrid API).
It has been reported multiple times in sendgrid official integrations, and the answer was always "please open a PR to document this in our troubleshooting section, strict base64 is required".
See limitation documented here https://github.com/sendgrid/sendgrid-ruby/blob/master/USE_CASES.md#adding-attachments and a bug report sendgrid/sendgrid-php#272.