openemail signatures

Resolves one page of signatures, sorted by address and then oldest first. An address keeps a list of named signatures, as its Signature tab in the app shows. At most one of them is the default for new mail (isDefault) and at most one the default for replies and forwards (isReplyDefault), and one signature can be both.

Give address to read the signatures of one address, or of a catch-all with *@example.com. Without it the list holds every address. An address that only ever had the single signature of earlier versions shows it here as one signature called Signature, default for both.

emails.send adds the default of the address it sends from, and takes signatureId to add any other signature of that address instead.

Add --all to walk every page: a table on a terminal, one JSON object per line when piped or with --ndjson, and one { items, hasMore, nextCursor } document with --json. --max <n> stops after that many items.

Looks up a single signature and returns it in the same shape as a row of list: the address it belongs to, its name, its HTML and whether it is the default for new mail, for replies and forwards, for both or for neither.

Adds a signature to one address, or to a catch-all with *@example.com, and resolves with it as it is stored. name is what the app calls it and is unique on its address, whatever the case, so a second Work on the same address is a 409 signature_name_taken. html is sanitised the way outgoing mail is and has to keep some text or an image, so the stored HTML can differ from what you sent.

The first signature of an address becomes its default for new mail and for replies and forwards, unless --is-default or --is-reply-default says false. A later signature becomes a default only when you ask, and then takes that place from the signature that held it. An address holds at most 50 signatures, and the call past that is a 422 signature_limit_reached.

The address has to be one of the workspace, or a catch-all on a verified domain here with its catch-all on.

Changes a signature and resolves with it as it is stored. Send any of name, html, --is-default and --is-reply-default: a field left out stays as it is, and a patch with none of them is a 422.

isDefault: true makes it the signature of new mail from its address in place of the one that was. isDefault: false takes that away when this signature held it, so new mail from the address goes out with no signature until another one is chosen. --is-reply-default does the same for replies and forwards. The two are independent, so one signature can sign new mail and another, shorter one the replies.

A new name another signature of the address already has, compared without case, is a 409 signature_name_taken. The HTML is sanitised again and has to keep some text or an image. A message that is already scheduled picks up the new HTML when it goes out.

Deletes a signature for good. When it was a default, that default is left empty, so mail it would have signed goes out with no signature until another one is chosen with update. A scheduled message that named it with signatureId carries the default of its address instead. There is no undo.

Puts a copy of a signature on up to 500 other addresses or catch-alls, as Copy to other addresses does in the app, and resolves with the copies. An address that already has a signature with the same name, whatever the case, gets its HTML replaced, so copying again after an edit brings every copy up to date. Any other address gets a new signature with that name.

A copy becomes the default for new mail where --is-default is true and the default for replies and forwards where --is-reply-default is true. On an address that had no signature at all it becomes both unless you say false. Left out, the defaults of the other addresses stay as they are.

The address the signature is already on is skipped. Each copy is its own signature from then on, with its own id: editing the original later changes no copy until you copy again.