client.signatures()
Every method in this namespace: its signature, its parameters, what it returns and an example.
Methods
The signatures each address keeps: list them, add one, rename or rewrite it, choose which one signs new mail and which one signs replies and forwards, copy one to other addresses, and delete it.
signatures().list
List the signatures of the workspace or of one address, a page at a time
Page list(RequestOptions options)Returns one page of signatures, sorted by address and then oldest first. signatures().listAll collects every page and signatures().iterate walks them lazily. 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.
Parameters
options.addressStringOne address, such as
[email protected], or*@example.comfor the catch-all of a domain. Left out, every address is listed.options.limitintPage size, from 1 to 100. The server defaults to 25.
options.cursorStringThe
nextCursorof the previous page, passed back as it came. Leave it out for the first page.options.apiKeyStringOverrides the client's API key for this call only.
Returns
A Page of signature maps, with items, hasMore and nextCursor. Each item has id, address, name, html, isDefault, isReplyDefault, createdAt and updatedAt.
Example
Page page = client.signatures().list(RequestOptions.of("address", "[email protected]")); for (Map<String, Object> signature : page) { System.out.println(signature.get("name") + " " + signature.get("isDefault") + " " + signature.get("isReplyDefault"));} if (page.hasMore()) { System.out.println("Next page: " + page.nextCursor());}Notes
A key or an app limited to particular addresses or domains sees only the signatures of the addresses it holds, and those of a catch-all only when it holds the domain whole.
An
addressthat is not an address, or that names a whole domain with@example.com, is a 422invalid_parameter.The cursor is opaque and holds where the last row sat in this order, so a signature added or deleted between pages never breaks the walk. A cursor this list did not hand out is a 400
invalid_cursor.
Also available in
signatures().listAll
Collect every signature into one list
List<Map<String, Object>> listAll(RequestOptions options)Walks every page of signatures().list and returns all signatures in one list, sorted by address and then oldest first. One request per page. Give address to collect the signatures of one address or catch-all.
Parameters
options.addressStringOne address, or
*@example.comfor a catch-all. Left out, every address is collected.options.limitintPage size for each request, from 1 to 100. The server defaults to 25.
options.cursorStringStarts the walk after this cursor instead of the first page.
options.apiKeyStringOverrides the client's API key for every page of this walk.
Returns
A list of signature maps holding every signature.
Example
List<Map<String, Object>> signatures = client.signatures().listAll(RequestOptions.of("address", "[email protected]")); for (Map<String, Object> signature : signatures) { if ("Short".equals(signature.get("name"))) { client.emails().send(Body.of( "from", "[email protected]", "to", "[email protected]", "subject", "Quick note", "text", "See you on Thursday.", "signatureId", signature.get("id") )); }}Notes
If any page fails, the exception is thrown and the signatures already fetched are discarded.
Also available in
signatures().iterate
Stream the signatures one at a time
PagedIterable iterate(RequestOptions options)Returns a PagedIterable that yields signatures one at a time, sorted by address and then oldest first, and requests the next page only once the current one is used up. Nothing is fetched until the loop starts, and breaking out of the for stops the requests.
Parameters
options.addressStringOne address, or
*@example.comfor a catch-all. Left out, every address is walked.options.limitintPage size for each request, from 1 to 100. The server defaults to 25.
options.cursorStringStarts the walk after this cursor instead of the first page.
options.apiKeyStringOverrides the client's API key for every page of this walk.
Returns
A PagedIterable that yields one signature map per step.
Example
for (Map<String, Object> signature : client.signatures().iterate()) { if (Boolean.TRUE.equals(signature.get("isDefault"))) { System.out.println(signature.get("address") + " signs new mail with " + signature.get("name")); }}Notes
The
PagedIterableis lazy, so an abandoned loop costs only the pages you consumed.
Also available in
signatures().get
Read one signature by id
Map<String, Object> get(String id, RequestOptions options)Looks up a single signature and returns it in the same shape as a row of signatures().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.
Parameters
idStringRequiredSignature id, which starts with
sig_.options.apiKeyStringOverrides the client's API key for this call only.
Returns
A map with id, address, name, html, isDefault, isReplyDefault, createdAt and updatedAt.
Example
Map<String, Object> signature = client.signatures().get("sig_8f2c1a9b7d3e4f60a1b2c3d4"); System.out.println(signature.get("address") + " " + signature.get("name") + " " + signature.get("html"));Notes
A missing signature throws a
NotFoundException, whoseisNotFound()is true and whosecode()isresource_not_found. So does one on an address a narrowed key does not hold.
Also available in
signatures().create
Add a signature to an address
Map<String, Object> create(Map<String, Object> body, RequestOptions options)Adds a signature to one address, or to a catch-all with *@example.com, and returns 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 isDefault or isReplyDefault 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.
Parameters
body.addressStringRequiredThe address the signature is for, such as
[email protected], or*@example.comfor the catch-all of a domain.body.nameStringRequiredWhat the signature is called, trimmed, 1 to 80 characters. Unique on its address, whatever the case.
body.htmlStringRequiredThe signature as HTML, at most 150,000 characters before and after sanitising. It has to keep some text or an image.
body.isDefaultbooleantruemakes it the signature of new mail from the address. Left out, only the first signature of an address becomes that.body.isReplyDefaultbooleantruemakes it the signature of replies and forwards from the address. Left out, only the first signature of an address becomes that.options.apiKeyStringOverrides the client's API key for this call only.
Returns
A map with the new id, the trimmed name, the sanitised html, isDefault and isReplyDefault.
Example
Map<String, Object> signature = client.signatures().create(Body.of( "address", "[email protected]", "name", "Short", "html", "<p>Ada<br>Acme Ltd</p>", "isReplyDefault", true)); System.out.println(signature.get("id") + " " + signature.get("isDefault") + " " + signature.get("isReplyDefault"));Notes
The SDK does not retry a create after a network failure. If you retry by hand after a lost response, a 409
signature_name_takenmeans the first attempt succeeded.A key or an app limited to particular addresses or domains can only add to an address it holds, and to a catch-all only when it holds the domain whole. Anything else is a 422
capability_unsupported.copyputs the same signature on other addresses.
Also available in
signatures().update
Rename a signature, rewrite it or change what it is the default for
Map<String, Object> update(String id, Map<String, Object> patch, RequestOptions options)Changes a signature and returns it as it is stored. Send any of name, html, isDefault and isReplyDefault: 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. isReplyDefault 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.
Parameters
idStringRequiredSignature id, which starts with
sig_.patch.nameStringNew name, trimmed, 1 to 80 characters. Left out, the name stays.
patch.htmlStringNew HTML, at most 150,000 characters before and after sanitising. Left out, the HTML stays.
patch.isDefaultbooleantruemakes it the default for new mail,falsetakes that away when it held it. Left out, nothing changes.patch.isReplyDefaultbooleantruemakes it the default for replies and forwards,falsetakes that away when it held it. Left out, nothing changes.options.apiKeyStringOverrides the client's API key for this call only.
Returns
A map with the unchanged id and address and the new name, html, isDefault and isReplyDefault.
Example
Map<String, Object> saved = client.signatures().update("sig_8f2c1a9b7d3e4f60a1b2c3d4", Body.of("isDefault", true)); System.out.println(saved.get("name") + " " + saved.get("isDefault"));Notes
The SDK retries this call after a network failure, since the same patch sent twice leaves the same signature.
settings().updatewith an address still takessignature: it rewrites the HTML of the default for new mail, and adds a signature calledSignaturewhen the address has no default.
Also available in
signatures().delete
Delete a signature
Map<String, Object> delete(String id, RequestOptions options)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.
Parameters
idStringRequiredSignature id, which starts with
sig_.options.apiKeyStringOverrides the client's API key for this call only.
Returns
A map with object set to signature, id, address and deleted set to true.
Example
Map<String, Object> removed = client.signatures().delete("sig_8f2c1a9b7d3e4f60a1b2c3d4"); System.out.println(removed.get("address") + " " + removed.get("deleted"));Notes
The SDK does not retry a delete. A 404 on your own second attempt after a lost response means the first one worked.
Also available in
signatures().copy
Copy a signature to other addresses
List<Map<String, Object>> copy(String id, Map<String, Object> body, RequestOptions options)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 returns 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 isDefault is true and the default for replies and forwards where isReplyDefault 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.
Parameters
idStringRequiredThe signature to copy.
body.addressesList<String>Required1 to 500 addresses to copy it to. Each is one address or
*@example.comfor a catch-all.body.isDefaultbooleantruemakes each copy the default for new mail on its address.body.isReplyDefaultbooleantruemakes each copy the default for replies and forwards on its address.options.apiKeyStringOverrides the client's API key for this call only.
Returns
A list of signature maps, one copy for each address, in the order given.
Example
List<Map<String, Object>> copies = client.signatures().copy("sig_8f2c1a9b7d3e4f60a1b2c3d4", Body.of( "addresses", List.of("[email protected]", "[email protected]"), "isDefault", true)); for (Map<String, Object> copy : copies) { System.out.println(copy.get("address") + " " + copy.get("id") + " " + copy.get("isDefault"));}Notes
The copies are written one address at a time. When an address is full, the call fails with 422
signature_limit_reachedand the addresses before it keep their copy, so the same call can be sent again once there is room.The SDK retries this call after a network failure, since copying twice leaves the same signatures.
A key or an app limited to particular addresses or domains can only copy to addresses it holds. One it does not hold fails the whole call with 422
capability_unsupportedbefore anything is written.