Skip to content

Commit

Permalink
fix(submit): Added additional and optional reference field 'messageId…
Browse files Browse the repository at this point in the history 
…'. If set then this value is validated against the Message-ID header of the referenced email
  • Loading branch information
@andris9
andris9 committed Oct 23, 2024
1 parent d502425 commit 8d76345
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 18 deletions.
14 changes: 14 additions & 0 deletions lib/email-client/base-client.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -689,6 +689,13 @@ class BaseClient {
}

if (referencedMessage) {
if (data.reference.messageId && data.reference.messageId !== referencedMessage.messageId) {
let err = new Error('The referenced message was found, but its Message-ID does not match the expected value');
err.code = 'MessageNotFound';
err.statusCode = 404;
throw err;
}

let references = []
.concat(referencedMessage.messageId || [])
.concat(referencedMessage.inReplyTo || [])
Expand Down Expand Up @@ -1056,6 +1063,13 @@ class BaseClient {
}

if (referencedMessage) {
if (data.reference.messageId && data.reference.messageId !== referencedMessage.messageId) {
let err = new Error('The referenced message was found, but its Message-ID does not match the expected value');
err.code = 'MessageNotFound';
err.statusCode = 404;
throw err;
}

let references = []
.concat(referencedMessage.messageId || [])
.concat(referencedMessage.inReplyTo || [])
Expand Down
60 changes: 42 additions & 18 deletions workers/api.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4169,19 +4169,26 @@ const init = async () => {
.max(256)
.required()
.example('AAAAAQAACnA')
.description('Referenced message ID'),
action: Joi.string().lowercase().valid('forward', 'reply').example('reply').default('reply'),
.description(
"The EmailEngine-specific ID of the referenced message. Note: This is not the Message-ID found in the email's headers"
),
action: Joi.string()
.lowercase()
.valid('forward', 'reply')
.example('reply')
.default('reply')
.description("Specifies the action to perform on the referenced message. Possible values are 'reply' or 'forward'"),
inline: Joi.boolean()
.truthy('Y', 'true', '1')
.falsy('N', 'false', 0)
.default(false)
.description('If true, then blockquotes the email that is being replied to')
.description('When set to `true`, includes the original email content as blockquoted text in the reply')
.label('InlineReply'),
forwardAttachments: Joi.boolean()
.truthy('Y', 'true', '1')
.falsy('N', 'false', 0)
.default(false)
.description('If true, then includes attachments in forwarded message')
.description('When set to `true`, includes attachments from the original email in the forwarded message')
.when('action', {
is: 'forward',
then: Joi.optional(),
Expand All @@ -4192,19 +4199,23 @@ const init = async () => {
.truthy('Y', 'true', '1')
.falsy('N', 'false', 0)
.default(false)
.description('If true, then processes the email even if the original message is not available anymore')
.description('When set to `true`, processes the email even if the original referenced message is no longer available.')
.label('IgnoreMissing'),
documentStore: documentStoreSchema.default(false)
messageId: Joi.string()
.max(996)
.example('<[email protected]>')
.description("Optional. Apply the reference action only if the referenced email's Message-ID matches this value."),
documentStore: documentStoreSchema.default(false).meta({ swaggerHidden: true })
})
.description('Message reference for a reply or a forward. This is EmailEngine specific ID, not Message-ID header value.')
.description('Contains information needed when replying to or forwarding an email')
.label('MessageReference'),

raw: Joi.string()
.base64()
.max(MAX_ATTACHMENT_SIZE)
.example('TUlNRS1WZXJzaW9uOiAxLjANClN1YmplY3Q6IGhlbGxvIHdvcmxkDQoNCkhlbGxvIQ0K')
.description(
'Base64 encoded email message in rfc822 format. If you provide other keys as well then these will override the values in the raw message.'
'A Base64-encoded email message in RFC 822 format. If you provide other fields along with raw, those fields will override the corresponding values in the raw message.'
)
.label('RFC822Raw'),

Expand Down Expand Up @@ -4258,7 +4269,7 @@ const init = async () => {
.allow(false, null)
.example('AAAAAQAACnAcde')
.description(
'Reference an existing attachment ID instead of providing attachment content. If set, then `content` option is not allowed. Otherwise `content` is required.'
'References an existing attachment by its ID instead of providing new attachment content. If this field is set, the `content` field must not be included. If not set, the `content` field is required.'
)
}).label('UploadAttachment')
)
Expand Down Expand Up @@ -5278,19 +5289,26 @@ const init = async () => {
.max(256)
.required()
.example('AAAAAQAACnA')
.description('Referenced message ID'),
action: Joi.string().lowercase().valid('forward', 'reply').example('reply').default('reply'),
.description(
"The EmailEngine-specific ID of the referenced message. Note: This is not the Message-ID found in the email's headers"
),
action: Joi.string()
.lowercase()
.valid('forward', 'reply')
.example('reply')
.default('reply')
.description("Specifies the action to perform on the referenced message. Possible values are 'reply' or 'forward'"),
inline: Joi.boolean()
.truthy('Y', 'true', '1')
.falsy('N', 'false', 0)
.default(false)
.description('If true, then blockquotes the email that is being replied to')
.description('When set to `true`, includes the original email content as blockquoted text in the reply')
.label('InlineReply'),
forwardAttachments: Joi.boolean()
.truthy('Y', 'true', '1')
.falsy('N', 'false', 0)
.default(false)
.description('If true, then includes attachments in forwarded message')
.description('When set to `true`, includes attachments from the original email in the forwarded message')
.when('action', {
is: 'forward',
then: Joi.optional(),
Expand All @@ -5301,18 +5319,24 @@ const init = async () => {
.truthy('Y', 'true', '1')
.falsy('N', 'false', 0)
.default(false)
.description('If true, then processes the email even if the original message is not available anymore')
.description('When set to `true`, processes the email even if the original referenced message is no longer available.')
.label('IgnoreMissing'),
documentStore: documentStoreSchema.default(false)
messageId: Joi.string()
.max(996)
.example('<[email protected]>')
.description("Optional. Apply the reference action only if the referenced email's Message-ID matches this value."),
documentStore: documentStoreSchema.default(false).meta({ swaggerHidden: true })
})
.description('Message reference for a reply or a forward. This is EmailEngine specific ID, not Message-ID header value.')
.description('Contains information needed when replying to or forwarding an email')
.label('MessageReference'),

envelope: Joi.object({
from: Joi.string().email().allow('').example('[email protected]'),
to: Joi.array().items(Joi.string().email().required().example('[email protected]')).single()
})
.description('Optional SMTP envelope. If not set then derived from message headers.')
.description(
"An optional object specifying the SMTP envelope used during email transmission. If not provided, the envelope is automatically derived from the email's message headers. This is useful when you need the envelope addresses to differ from those in the email headers."
)
.label('SMTPEnvelope')
.when('mailMerge', {
is: Joi.exist().not(false, null),
Expand All @@ -5324,7 +5348,7 @@ const init = async () => {
.max(MAX_ATTACHMENT_SIZE)
.example('TUlNRS1WZXJzaW9uOiAxLjANClN1YmplY3Q6IGhlbGxvIHdvcmxkDQoNCkhlbGxvIQ0K')
.description(
'Base64 encoded email message in rfc822 format. If you provide other keys as well then these will override the values in the raw message.'
'A Base64-encoded email message in RFC 822 format. If you provide other fields along with raw, those fields will override the corresponding values in the raw message.'
)
.label('RFC822Raw')
.when('mailMerge', {
Expand Down

0 comments on commit 8d76345

Please sign in to comment.