transactionalMails - Documentation

Source:

index.js, line 696

Methods

(static) abandonedCart(store, customer, cart, langopt, customMessageopt) → {Promise}

Source:

index.js, line 70

Returns HTML markup for abandoned cart email.

Example

transactionalMails.abandonedCart(store, customer, cart, 'pt_br')
  .then(html => sendEmail(html, options))
  .catch(err => console.error(err))

Parameters:

Name	Type	Attributes	Default	Description
`store`	object			Store body object
`customer`	object			Customer body object
`cart`	object			Cart body object
`lang`	string	<optional>	`'en_us'`	Snake case language code, eg.: 'en_us', 'pt_br'
`customMessage`	string	<optional>		Custom text for the main template phrase

Returns:

Type: Promise

(static) authorized(store, customer, order, langopt, customMessageopt) → {Promise}

Source:

index.js, line 658

Returns HTML markup for authorized payment email.

Example

transactionalMails.authorized(store, customer, order, 'pt_br')
    .then(html => sendEmail(html, options))
    .catch(err => console.error(err))

Parameters:

Name	Type	Attributes	Default	Description
`store`	object			Store body object
`customer`	object			Customer body object
`order`	object			Order body object
`lang`	string	<optional>	`'en_us'`	Snake case language code, eg.: 'en_us', 'pt_br'
`customMessage`	string	<optional>		Custom text for the main template phrase

Returns:

Type: Promise

(static) delivered(store, customer, order, langopt, customMessageopt) → {Promise}

Source:

index.js, line 126

Returns HTML markup for delivered order email.

Example

transactionalMails.delivered(store, customer, order, 'pt_br')
  .then(html => sendEmail(html, options))
  .catch(err => console.error(err))

Parameters:

Name	Type	Attributes	Default	Description
`store`	object			Store body object
`customer`	object			Customer body object
`order`	object			Order body object
`lang`	string	<optional>	`'en_us'`	Snake case language code, eg.: 'en_us', 'pt_br'
`customMessage`	string	<optional>		Custom text for the main template phrase

Returns:

Type: Promise

(static) inDispute(store, customer, order, langopt, customMessageopt) → {Promise}

Source:

index.js, line 322

Returns HTML markup for order in dispute email.

Example

transactionalMails.inDispute(store, customer, order, 'pt_br')
  .then(html => sendEmail(html, options))
  .catch(err => console.error(err))

Parameters:

Name	Type	Attributes	Default	Description
`store`	object			Store body object
`customer`	object			Customer body object
`order`	object			Order body object
`lang`	string	<optional>	`'en_us'`	Snake case language code, eg.: 'en_us', 'pt_br'
`customMessage`	string	<optional>		Custom text for the main template phrase

Returns:

Type: Promise

(static) inProduction(store, customer, order, langopt, customMessageopt) → {Promise}

Source:

index.js, line 434

Returns HTML markup for order in production email.

Example

transactionalMails.inProduction(store, customer, order, 'pt_br')
  .then(html => sendEmail(html, options))
  .catch(err => console.error(err))

Parameters:

Name	Type	Attributes	Default	Description
`store`	object			Store body object
`customer`	object			Customer body object
`order`	object			Order body object
`lang`	string	<optional>	`'en_us'`	Snake case language code, eg.: 'en_us', 'pt_br'
`customMessage`	string	<optional>		Custom text for the main template phrase

Returns:

Type: Promise

(static) inSeparation(store, customer, order, langopt, customMessageopt) → {Promise}

Source:

index.js, line 462

Returns HTML markup for order in separation email.

Example

transactionalMails.inSeparation(store, customer, order, 'pt_br')
  .then(html => sendEmail(html, options))
  .catch(err => console.error(err))

Parameters:

Name	Type	Attributes	Default	Description
`store`	object			Store body object
`customer`	object			Customer body object
`order`	object			Order body object
`lang`	string	<optional>	`'en_us'`	Snake case language code, eg.: 'en_us', 'pt_br'
`customMessage`	string	<optional>		Custom text for the main template phrase

Returns:

Type: Promise

(static) invoiceIssued(store, customer, order, langopt, customMessageopt) → {Promise}

Source:

index.js, line 406

Returns HTML markup for order invoice issued email.

Example

transactionalMails.invoiceIssued(store, customer, order, 'pt_br')
  .then(html => sendEmail(html, options))
  .catch(err => console.error(err))

Parameters:

Name	Type	Attributes	Default	Description
`store`	object			Store body object
`customer`	object			Customer body object
`order`	object			Order body object
`lang`	string	<optional>	`'en_us'`	Snake case language code, eg.: 'en_us', 'pt_br'
`customMessage`	string	<optional>		Custom text for the main template phrase

Returns:

Type: Promise

(static) new_order(store, customer, order, langopt, customMessageopt) → {Promise}

Source:

index.js, line 686

Returns HTML markup for new order email.

Example

transactionalMails.authorized(store, customer, order, 'pt_br')
    .then(html => sendEmail(html, options))
    .catch(err => console.error(err))

Parameters:

Name	Type	Attributes	Default	Description
`store`	object			Store body object
`customer`	object			Customer body object
`order`	object			Order body object
`lang`	string	<optional>	`'en_us'`	Snake case language code, eg.: 'en_us', 'pt_br'
`customMessage`	string	<optional>		Custom text for the main template phrase

Returns:

Type: Promise

(static) paid(store, customer, order, langopt, customMessageopt) → {Promise}

Source:

index.js, line 294

Returns HTML markup for paid order email.

Example

transactionalMails.paid(store, customer, order, 'pt_br')
  .then(html => sendEmail(html, options))
  .catch(err => console.error(err))

Parameters:

Name	Type	Attributes	Default	Description
`store`	object			Store body object
`customer`	object			Customer body object
`order`	object			Order body object
`lang`	string	<optional>	`'en_us'`	Snake case language code, eg.: 'en_us', 'pt_br'
`customMessage`	string	<optional>		Custom text for the main template phrase

Returns:

Type: Promise

(static) partiallyDelivered(store, customer, order, langopt, customMessageopt) → {Promise}

Source:

index.js, line 546

Returns HTML markup for partially delivered order email.

Example

transactionalMails.partiallyDelivered(store, customer, order, 'pt_br')
  .then(html => sendEmail(html, options))
  .catch(err => console.error(err))

Parameters:

Name	Type	Attributes	Default	Description
`store`	object			Store body object
`customer`	object			Customer body object
`order`	object			Order body object
`lang`	string	<optional>	`'en_us'`	Snake case language code, eg.: 'en_us', 'pt_br'
`customMessage`	string	<optional>		Custom text for the main template phrase

Returns:

Type: Promise

(static) partiallyPaid(store, customer, order, langopt, customMessageopt) → {Promise}

Source:

index.js, line 266

Returns HTML markup for partially paid order email.

Example

transactionalMails.partiallyPaid(store, customer, order, 'pt_br')
  .then(html => sendEmail(html, options))
  .catch(err => console.error(err))

Parameters:

Name	Type	Attributes	Default	Description
`store`	object			Store body object
`customer`	object			Customer body object
`order`	object			Order body object
`lang`	string	<optional>	`'en_us'`	Snake case language code, eg.: 'en_us', 'pt_br'
`customMessage`	string	<optional>		Custom text for the main template phrase

Returns:

Type: Promise

(static) partiallyRefunded(store, customer, order, langopt, customMessageopt) → {Promise}

Source:

index.js, line 350

Returns HTML markup for partially refunded email.

Example

transactionalMails.partiallyRefunded(store, customer, order, 'pt_br')
  .then(html => sendEmail(html, options))
  .catch(err => console.error(err))

Parameters:

Name	Type	Attributes	Default	Description
`store`	object			Store body object
`customer`	object			Customer body object
`order`	object			Order body object
`lang`	string	<optional>	`'en_us'`	Snake case language code, eg.: 'en_us', 'pt_br'
`customMessage`	string	<optional>		Custom text for the main template phrase

Returns:

Type: Promise

(static) partiallyShipped(store, customer, order, langopt, customMessageopt) → {Promise}

Source:

index.js, line 518

Returns HTML markup for partially shipped order email.

Example

transactionalMails.partiallyShipped(store, customer, order, 'pt_br')
  .then(html => sendEmail(html, options))
  .catch(err => console.error(err))

Parameters:

Name	Type	Attributes	Default	Description
`store`	object			Store body object
`customer`	object			Customer body object
`order`	object			Order body object
`lang`	string	<optional>	`'en_us'`	Snake case language code, eg.: 'en_us', 'pt_br'
`customMessage`	string	<optional>		Custom text for the main template phrase

Returns:

Type: Promise

(static) pending(store, customer, order, langopt, customMessageopt) → {Promise}

Source:

index.js, line 98

Returns HTML markup for pending payment email.

Example

transactionalMails.pending(store, customer, order, 'pt_br')
  .then(html => sendEmail(html, options))
  .catch(err => console.error(err))

Parameters:

Name	Type	Attributes	Default	Description
`store`	object			Store body object
`customer`	object			Customer body object
`order`	object			Order body object
`lang`	string	<optional>	`'en_us'`	Snake case language code, eg.: 'en_us', 'pt_br'
`customMessage`	string	<optional>		Custom text for the main template phrase

Returns:

Type: Promise

(static) readyForShipping(store, customer, order, langopt, customMessageopt) → {Promise}

Source:

index.js, line 490

Returns HTML markup for order ready for shipping email.

Example

transactionalMails.readyForShipping(store, customer, order, 'pt_br')
  .then(html => sendEmail(html, options))
  .catch(err => console.error(err))

Parameters:

Name	Type	Attributes	Default	Description
`store`	object			Store body object
`customer`	object			Customer body object
`order`	object			Order body object
`lang`	string	<optional>	`'en_us'`	Snake case language code, eg.: 'en_us', 'pt_br'
`customMessage`	string	<optional>		Custom text for the main template phrase

Returns:

Type: Promise

(static) receivedForExchange(store, customer, order, langopt, customMessageopt) → {Promise}

Source:

index.js, line 602

Returns HTML markup for order received for exchange email.

Example

transactionalMails.receivedForExchange(store, customer, order, 'pt_br')
  .then(html => sendEmail(html, options))
  .catch(err => console.error(err))

Parameters:

Name	Type	Attributes	Default	Description
`store`	object			Store body object
`customer`	object			Customer body object
`order`	object			Order body object
`lang`	string	<optional>	`'en_us'`	Snake case language code, eg.: 'en_us', 'pt_br'
`customMessage`	string	<optional>		Custom text for the main template phrase

Returns:

Type: Promise

(static) refunded(store, customer, order, langopt, customMessageopt) → {Promise}

Source:

index.js, line 378

Returns HTML markup for refunded order email.

Example

transactionalMails.refunded(store, customer, order, 'pt_br')
  .then(html => sendEmail(html, options))
  .catch(err => console.error(err))

Parameters:

Name	Type	Attributes	Default	Description
`store`	object			Store body object
`customer`	object			Customer body object
`order`	object			Order body object
`lang`	string	<optional>	`'en_us'`	Snake case language code, eg.: 'en_us', 'pt_br'
`customMessage`	string	<optional>		Custom text for the main template phrase

Returns:

Type: Promise

(static) returned(store, customer, order, langopt, customMessageopt) → {Promise}

Source:

index.js, line 630

Returns HTML markup for returned order email.

Example

transactionalMails.returned(store, customer, order, 'pt_br')
  .then(html => sendEmail(html, options))
  .catch(err => console.error(err))

Parameters:

Name	Type	Attributes	Default	Description
`store`	object			Store body object
`customer`	object			Customer body object
`order`	object			Order body object
`lang`	string	<optional>	`'en_us'`	Snake case language code, eg.: 'en_us', 'pt_br'
`customMessage`	string	<optional>		Custom text for the main template phrase

Returns:

Type: Promise

(static) returnedForExchange(store, customer, order, langopt, customMessageopt) → {Promise}

Source:

index.js, line 574

Returns HTML markup for order returned for exchange email.

Example

transactionalMails.returnedForExchange(store, customer, order, 'pt_br')
  .then(html => sendEmail(html, options))
  .catch(err => console.error(err))

Parameters:

Name	Type	Attributes	Default	Description
`store`	object			Store body object
`customer`	object			Customer body object
`order`	object			Order body object
`lang`	string	<optional>	`'en_us'`	Snake case language code, eg.: 'en_us', 'pt_br'
`customMessage`	string	<optional>		Custom text for the main template phrase

Returns:

Type: Promise

(static) shipped(store, customer, order, langopt, customMessageopt) → {Promise}

Source:

index.js, line 154

Returns HTML markup for order shipped email.

Example

transactionalMails.shipped(store, customer, order, 'pt_br')
  .then(html => sendEmail(html, options))
  .catch(err => console.error(err))

Parameters:

Name	Type	Attributes	Default	Description
`store`	object			Store body object
`customer`	object			Customer body object
`order`	object			Order body object
`lang`	string	<optional>	`'en_us'`	Snake case language code, eg.: 'en_us', 'pt_br'
`customMessage`	string	<optional>		Custom text for the main template phrase

Returns:

Type: Promise

(static) unauthorized(store, customer, order, langopt, customMessageopt) → {Promise}

Source:

index.js, line 182

Returns HTML markup for payment unauthorized email.

Example

transactionalMails.unauthorized(store, customer, order, 'pt_br')
  .then(html => sendEmail(html, options))
  .catch(err => console.error(err))

Parameters:

Name	Type	Attributes	Default	Description
`store`	object			Store body object
`customer`	object			Customer body object
`order`	object			Order body object
`lang`	string	<optional>	`'en_us'`	Snake case language code, eg.: 'en_us', 'pt_br'
`customMessage`	string	<optional>		Custom text for the main template phrase

Returns:

Type: Promise

(static) underAnalysis(store, customer, order, langopt, customMessageopt) → {Promise}

Source:

index.js, line 238

Returns HTML markup for new order email.

Example

transactionalMails.underAnalysis(store, customer, order, 'pt_br')
  .then(html => sendEmail(html, options))
  .catch(err => console.error(err))

Parameters:

Name	Type	Attributes	Default	Description
`store`	object			Store body object
`customer`	object			Customer body object
`order`	object			Order body object
`lang`	string	<optional>	`'en_us'`	Snake case language code, eg.: 'en_us', 'pt_br'
`customMessage`	string	<optional>		Custom text for the main template phrase

Returns:

Type: Promise

(static) voided(store, customer, order, langopt, customMessageopt) → {Promise}

Source:

index.js, line 210

Returns HTML markup for order voided email.

Example

transactionalMails.voided(store, customer, order, 'pt_br')
  .then(html => sendEmail(html, options))
  .catch(err => console.error(err))

Parameters:

Name	Type	Attributes	Default	Description
`store`	object			Store body object
`customer`	object			Customer body object
`order`	object			Order body object
`lang`	string	<optional>	`'en_us'`	Snake case language code, eg.: 'en_us', 'pt_br'
`customMessage`	string	<optional>		Custom text for the main template phrase

Returns:

Type: Promise

(static) welcome(store, customer, langopt, customMessageopt) → {Promise}

Source:

index.js, line 43

Returns HTML markup for customer welcome email.

Example

transactionalMails.welcome(store, customer, 'pt_br', 'Hello {name}, welcome to our Shop!')
  .then(html => sendEmail(html, options))
  .catch(err => console.error(err))

Parameters:

Name	Type	Attributes	Default	Description
`store`	object			Store body object
`customer`	object			Customer body object
`lang`	string	<optional>	`'en_us'`	Snake case language code, eg.: 'en_us', 'pt_br'
`customMessage`	string	<optional>		Custom text for the main template phrase

Returns:

Type: Promise