Allow custom filename when adding an attachment

[loomchild]

Description

When adding an attachment to an email, the filename that will be sent is determined by the provided file path. This is problematic when using Tempfile because part of the path will be random. I propose accepting an optional filename parameter in FileUtils.attach_file_request_builder.

License

I confirm that this contribution is made under the terms of the MIT license and that I have the authority necessary to make this contribution on behalf of its copyright owner.

[loomchild]

Alternatively, it could also be named parameter: filename: nil.

[loomchild]

@SubashPradhan could you please tell me what do you think about this PR, is there a chance of merging it?

[SubashPradhan]

@SubashPradhan could you please tell me what do you think about this PR, is there a chance of merging it?

@loomchild Thanks for looking into this, while sending an attachment, you can configure the custom file_name on the attachments field itself.

Have you tried the above approach, example of custom filename would look as below, in the below example the filename will be reflected as different_name.jpeg in the email.

 file_path = "/path/file_name.jpeg"
  base64_content = file_to_base64(file_path)
  buffer = Base64.decode64(base64_content)
  stream = StringIO.new(buffer)

  request_body = {
    subject: "Hello",
    to: [{ name: "My Friend", email: "[email protected]" }],
    body: "Hello, World!",
    attachments: [{
      content: stream,
      content_id: 'image_1_Xf0apsUfZ',
      filename: 'different_name.jpeg',
      size: 370,
      content_type: 'image/jpeg'
    }]
  }

Can you tell me if this is something you were aiming for? Thanks

[loomchild]

No. I don't want to load the entire attachment to memory. It also won't work for files > 3M per your documentation, since they require special multi-part request to Nylas API and simple Base64 embedded in JSON won't do.

That's why I want to use attach_file_request_builder helper provided by Nylas. Obviously, I can avoid using it altogether and just copy-paste your code to our app, or link a file to a different name to make the helper happy (that's what I am currently doing). But I am trying to avoid that hassle and use standard Tempfile.

That's why I am suggesting a simple improvement in your SDK, but if you are not interested, feel free to drop it.

[SubashPradhan]

No. I don't want to load the entire attachment to memory. It also won't work for files > 3M per your documentation, since they require special multi-part request to Nylas API and simple Base64 embedded in JSON won't do.

That's why I want to use attach_file_request_builder helper provided by Nylas. Obviously, I can avoid using it altogether and just copy-paste your code to our app, or link a file to a different name to make the helper happy (that's what I am currently doing). But I am trying to avoid that hassle and use standard Tempfile.

That's why I am suggesting a simple improvement in your SDK, but if you are not interested, feel free to drop it.

I see, thanks for the explanation, we should be good to merge the doc comment is added.

[SubashPradhan]

Thanks for contributing 🎉

[loomchild]

Sure, thanks for approving 🙂. Looking forward to the next release.

[loomchild]

Unfortunately it doesn't work for attachments > 3MB (unfortunately I didn't test it earlier).
I created a follow-up: #502