Skip to content

Commit 87b158e

Browse files
committed
docs: add missing DKIM signing options and vmc date option
- Add expires and headerList options to DKIM signing documentation - Add --date option to vmc CLI command documentation
1 parent 3280a59 commit 87b158e

File tree

2 files changed

+3
-0
lines changed

2 files changed

+3
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,8 @@ const signResult = await dkimSign(message, options);
163163
- **canonicalization** (`string`): Canonicalization method. Defaults to `'relaxed/relaxed'`.
164164
- **algorithm** (`string`): Signing and hashing algorithm. Defaults to `'rsa-sha256'`.
165165
- **signTime** (`Date`): Signing time. Defaults to current time.
166+
- **expires** (`Date`): Signature expiration time (`x=` tag). Optional.
167+
- **headerList** (`Array`): List of header field names to sign. Optional; uses default set if not specified.
166168
- **signatureData** (`Array`): Array of signature objects. Each object may contain:
167169
- **signingDomain** (`string`): DKIM key domain name.
168170
- **selector** (`string`): DKIM key selector.

cli.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -268,6 +268,7 @@ mailauth vmc [options]
268268
- `--authority <url>`, `-a <url>`: URL of the VMC resource.
269269
- `--authorityPath <path>`, `-p <path>`: Path to a local VMC file, used to avoid network requests.
270270
- `--domain <domain>`, `-d <domain>`: Sender domain to validate against the certificate.
271+
- `--date <timestamp>`, `-t <timestamp>`: ISO-formatted timestamp for certificate expiration checks. Defaults to the current time.
271272

272273
#### Example
273274

0 commit comments

Comments
 (0)