From 950f799f8657912a6d31e7d52ed5e93c50d69844 Mon Sep 17 00:00:00 2001 From: Christian Bromann Date: Wed, 13 Sep 2023 20:54:42 -0700 Subject: [PATCH] format docs --- README.md | 47 +++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 39 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 940bcc2..0f32b6a 100644 --- a/README.md +++ b/README.md @@ -99,14 +99,45 @@ describe('Example', () => { The command parameters require at least one of `from`, `to`, or `subject`: -```from```: String. Filter on the email address of the receiver.
-```to```: String. Filter on the email address of the sender.
-```subject```: String. Filter on the subject of the email.
-```includeBody```: boolean. Set to true to fetch decoded email bodies.
-```includeAttachments```: boolean. Set to true to fetch the base64-encoded email attachments.
-```before```: Date. Filter messages received before the specified date.
-```after```: Date. Filter messages received after the specified date.
-```label```: String. The default label is 'INBOX', but can be changed to 'SPAM', 'TRASH' or a custom label. For a full list of built-in labels, see https://developers.google.com/gmail/api/guides/labels?hl=en +### `from` +Filter on the email address of the receiver. + +Type: `String` + +### `to` +Filter on the email address of the sender. + +Type: `String` + +### `subject` +Filter on the subject of the email. + +Type: `String` + +### `includeBody` +Set to true to fetch decoded email bodies. + +Type: `boolean` + +### `includeAttachments` +Set to true to fetch the base64-encoded email attachments. + +Type: `boolean` + +### `before` +Filter messages received before the specified date. + +Type: `Date` + +### `after` +Filter messages received after the specified date. + +Type: `Date` + +### `label` +The default label is 'INBOX', but can be changed to 'SPAM', 'TRASH' or a custom label. For a full list of built-in labels, see https://developers.google.com/gmail/api/guides/labels?hl=en + +Type: `String` ---