You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-1Lines changed: 6 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -61,7 +61,12 @@ Otherwise you will need to install XCode from the [App Store][app-store] or [App
61
61
62
62
> **NOTE**: You should probably just use [email-templates][] directly instead of using this package.
63
63
64
-
The function `previewEmail` returns a `Promise` which resolves with a URL. We automatically open the browser to this URL unless you specify `options.open` as `false` (see [Options](#options) for more info).
64
+
The function `previewEmail` accepts two arguments `message` and `options`, and it returns a `Promise` which resolves with a URL (unless you specify `returnHTML: true` in `options` argument). We automatically open the browser to this URL unless you specify `options.open` as `false` (see [Options](#options) for more info).
65
+
66
+
* The argument `message` can be one of the following:
67
+
*`Object` – A [Nodemailer message configuration](https://nodemailer.com/message/) object.
68
+
*`String` or `Buffer` – A custom generated RFC822 formatted message to use (instead of one that is generated by Nodemailer – see [Nodemailer's custom source](https://nodemailer.com/message/custom-source/)).
69
+
* The argument `options` is documented under [Options](#options) below.
0 commit comments