How to add BCC or CC with email plugin ?

[blackyzero]

Hello,

How could i BCC/CC on order confirmation or verify email with Email Plugin?
I tried to add bcc into setting, but vendure failed to start, i guess the variable is not added.

Thank you.

[blackyzero]

Hello,

Is there anyone could help me on this?
Thank you.

[michaelbromley]

This is done with the setOptionalAddressFields method of the email event handler.

[blackyzero]

Thanks for pointing me this.

I tried to put those setting into vendure-config.ts, but it seems i didn't wrong.

            OptionalAddressFields {
                cc: '[email protected],
            },

What would be correct setting if i'd like to send an email copy to [email protected] on each new order or event ?
Thank you.

[michaelbromley]

Hi,
So the above code is not valid JavaScript or TypeScript - I'm guessing it didn't compile or run?
To get this to work you'll need to modify the email event handler directly, so something like:

import { orderConfirmationHandler } from '@vendure/email-plugin`;


// omitted rest of config

EmailPlugin.init({
  route: 'mailbox',
  handlers: [
    ...defaultEmailHandlers,
    orderConfirmationHandler.setOptionalAddressFields(event => {
      return {
        cc: '[email protected]',
        bcc: '[email protected]'
      }  
    }),
    ],
    // ...
}),

[blackyzero]

Thanks @michaelbromley for your help.
Unfortunately, it doesn't work for my case, i am getting following error after adding new settings.

root@vendure01:/opt/services/vendure/api# npm run start

> [email protected] start
> concurrently yarn:run:*

yarn run v1.22.19
yarn run v1.22.19
$ ts-node ./src/index.ts
$ ts-node ./src/index-worker.ts
[run:*server] /opt/services/vendure/api/node_modules/ts-node/src/index.ts:843
[run:*server]     return new TSError(diagnosticText, diagnosticCodes, diagnostics);
[run:*server]            ^
[run:*server] TSError: ⨯ Unable to compile TypeScript:
[run:*server] src/vendure-config.ts(68,3): error TS2740: Type 'EmailEventHandler<any, any>[]' is missing the following properties from type 'EmailEventHandler<string, EventWithContext>': listener, event, setRecipientFn, setTemplateVarsFn, and 19 more.
[run:*server] src/vendure-config.ts(69,3): error TS2322: Type 'EmailEventHandler<"order-confirmation", EventWithAsyncData<OrderStateTransitionEvent, { shippingLines: ShippingLine[]; }>>' is not assignable to type 'EmailEventHandler<string, EventWithContext>'.
[run:*server]   The types returned by 'loadData(...)' are incompatible between these types.
[run:*server]     Type 'EmailEventHandlerWithAsyncData<any, "order-confirmation", EventWithAsyncData<OrderStateTransitionEvent, { shippingLines: ShippingLine[]; }>, EventWithAsyncData<...>>' is not assignable to type 'EmailEventHandlerWithAsyncData<any, string, EventWithContext, EventWithAsyncData<EventWithContext, any>>'.
[run:*server]       Type 'EventWithContext' is not assignable to type 'EventWithAsyncData<OrderStateTransitionEvent, { shippingLines: ShippingLine[]; }>'.
[run:*server]
[run:*server]     at createTSError (/opt/services/vendure/api/node_modules/ts-node/src/index.ts:843:12)
[run:*server]     at reportTSError (/opt/services/vendure/api/node_modules/ts-node/src/index.ts:847:19)
[run:*server]     at getOutput (/opt/services/vendure/api/node_modules/ts-node/src/index.ts:1057:36)
[run:*server]     at Object.compile (/opt/services/vendure/api/node_modules/ts-node/src/index.ts:1411:41)
[run:*server]     at Module.m._compile (/opt/services/vendure/api/node_modules/ts-node/src/index.ts:1596:30)
[run:*server]     at Module._extensions..js (node:internal/modules/cjs/loader:1159:10)
[run:*server]     at Object.require.extensions.<computed> [as .ts] (/opt/services/vendure/api/node_modules/ts-node/src/index.ts:1600:12)
[run:*server]     at Module.load (node:internal/modules/cjs/loader:981:32)
[run:*server]     at Function.Module._load (node:internal/modules/cjs/loader:822:12)
[run:*server]     at Module.require (node:internal/modules/cjs/loader:1005:19) {
[run:*server]   diagnosticCodes: [ 2740, 2322 ]
[run:*server] }
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
[run:*server] yarn run run:server exited with code 1
[run:*worker] /opt/services/vendure/api/node_modules/ts-node/src/index.ts:843
[run:*worker]     return new TSError(diagnosticText, diagnosticCodes, diagnostics);
[run:*worker]            ^
[run:*worker] TSError: ⨯ Unable to compile TypeScript:
[run:*worker] src/vendure-config.ts(68,3): error TS2740: Type 'EmailEventHandler<any, any>[]' is missing the following properties from type 'EmailEventHandler<string, EventWithContext>': listener, event, setRecipientFn, setTemplateVarsFn, and 19 more.
[run:*worker] src/vendure-config.ts(69,3): error TS2322: Type 'EmailEventHandler<"order-confirmation", EventWithAsyncData<OrderStateTransitionEvent, { shippingLines: ShippingLine[]; }>>' is not assignable to type 'EmailEventHandler<string, EventWithContext>'.
[run:*worker]   The types returned by 'loadData(...)' are incompatible between these types.
[run:*worker]     Type 'EmailEventHandlerWithAsyncData<any, "order-confirmation", EventWithAsyncData<OrderStateTransitionEvent, { shippingLines: ShippingLine[]; }>, EventWithAsyncData<...>>' is not assignable to type 'EmailEventHandlerWithAsyncData<any, string, EventWithContext, EventWithAsyncData<EventWithContext, any>>'.
[run:*worker]       Type 'EventWithContext' is not assignable to type 'EventWithAsyncData<OrderStateTransitionEvent, { shippingLines: ShippingLine[]; }>'.
[run:*worker]
[run:*worker]     at createTSError (/opt/services/vendure/api/node_modules/ts-node/src/index.ts:843:12)
[run:*worker]     at reportTSError (/opt/services/vendure/api/node_modules/ts-node/src/index.ts:847:19)
[run:*worker]     at getOutput (/opt/services/vendure/api/node_modules/ts-node/src/index.ts:1057:36)
[run:*worker]     at Object.compile (/opt/services/vendure/api/node_modules/ts-node/src/index.ts:1411:41)
[run:*worker]     at Module.m._compile (/opt/services/vendure/api/node_modules/ts-node/src/index.ts:1596:30)
[run:*worker]     at Module._extensions..js (node:internal/modules/cjs/loader:1159:10)
[run:*worker]     at Object.require.extensions.<computed> [as .ts] (/opt/services/vendure/api/node_modules/ts-node/src/index.ts:1600:12)
[run:*worker]     at Module.load (node:internal/modules/cjs/loader:981:32)
[run:*worker]     at Function.Module._load (node:internal/modules/cjs/loader:822:12)
[run:*worker]     at Module.require (node:internal/modules/cjs/loader:1005:19) {
[run:*worker]   diagnosticCodes: [ 2740, 2322 ]
[run:*worker] }
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
[run:*worker] yarn run run:worker exited with code 1
root@vendure01:/opt/services/vendure/api#

Here is my config,

import { defaultEmailHandlers, EmailPlugin, orderConfirmationHandler } from '@vendure/email-plugin';

// omitted rest of config
EmailPlugin.init({
            devMode: true,
            outputPath: path.join(__dirname, '../static/email/test-emails'),
            route: 'mailbox',
            handlers: [
                defaultEmailHandlers,
                orderConfirmationHandler.setOptionalAddressFields(event => {
                  return {
                    cc: '[email protected]',
                    bcc: '[email protected]'
                  }
                }),
            ],
            templatePath: path.join(__dirname, '../static/email/templates'),
            /// ... 

Please advise how could i make it work?
Thank you.

[michaelbromley]

Oh there was a TypeScript typing error which will be fixed in the next version. For now do it like this:

handlers: [
  ...defaultEmailHandlers,
  orderConfirmationHandler.setOptionalAddressFields(event => {
    return {
      cc: '[email protected]',
      bcc: '[email protected]'
    }
  }) as any,
],

Also note the ... before the defaultEmailHandlers. This is required to "spread" that array into the new one you are defining here.

[blackyzero]

Awesome. It works great !
Thank you.