The content_id parameter is required if disposition = \'inline\'.'

[dungahk]

Issue Summary

Error when trying to send an email with an attachment.

The content_id parameter is required if disposition = \'inline\'.',

Steps to Reproduce

Just try to send an email with attachments and disposition 'inline'.

My code:

send({
  from: { name: 'From Name', email: 'some@email.com' },
  to: { name: 'To Name', email: 'another@email.com' },
  subject: `Some subject`,
  text: 'Email text',
  attachments: [
    {
      content: buffers.pop().toString('base64'),
      filename: fileMetadata.name.split('/').pop(),
      type: fileMetadata.contentType,
      disposition: 'inline',
      contentId: 'my_content_id'
    }
  ]
});

I'm using Typescript and the attachments property is defined as an Array of AttachmentData, which includes a property called contentId, but the API requires the property content_id which is in the interface AttachmentJSON instead.

send function types: https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/mail/src/mail.d.ts#L20

attachments property types: https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/helpers/classes/mail.d.ts#L134

AttachmentData interface types: https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/helpers/classes/attachment.d.ts#L1

Technical details:

• @sendgrid/mail Version: 6.3.1
• Node.js Version: 8.11.2
• TypeScript Version: 3.1.6

[thinkingserious]

Hello @dungahk,

It looks like there is a bug in the AttachmentData interface. I will add this issue to our backlog for a fix as well as tag it for external contribution.

With Best Regards,

Elmer

[sculaste]

Hi @thinkingserious ,
Is there any updates on this one?

Best regards,
Solomon

[thinkingserious]

Hello @dungahk, @sculaste,

Have you tried using content_id instead of contentId as the key?

With Best Regards,

Elmer

[kozak-codes]

Yeah, looks like just a simple typescript error. A simple cast of your object to any is a quick and simple fix until the fix is roled out.
eg:

mail.attachments.push({
	content: logo,
	content_id: 'logo',
	filename: 'logo.png',
	disposition: 'inline',
	type: 'image/png',
} as any);