Skip to content

Commit

Permalink
format docs
Browse files Browse the repository at this point in the history
  • Loading branch information
christian-bromann committed Sep 14, 2023
1 parent f7cfcae commit 950f799
Showing 1 changed file with 39 additions and 8 deletions.
47 changes: 39 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.<br />
```to```: String. Filter on the email address of the sender.<br />
```subject```: String. Filter on the subject of the email.<br />
```includeBody```: boolean. Set to true to fetch decoded email bodies.<br />
```includeAttachments```: boolean. Set to true to fetch the base64-encoded email attachments.<br />
```before```: Date. Filter messages received before the specified date.<br />
```after```: Date. Filter messages received after the specified date.<br />
```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`

---

Expand Down

0 comments on commit 950f799

Please sign in to comment.