openemail.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
def list( *, limit: int | None = None, cursor: str | None = None, address: str | None = None, api_key: str | None = None, timeout: float | None = None,) -> Page[SignatureResource]Returns one page of signatures, sorted by address and then oldest first. list_all collects every page into one list and 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
limitintPage size, from 1 to 100. The server defaults to 25.
cursorstrThe
nextCursorof the previous page, passed back as it came. Leave it out for the first page.addressstrOne address, such as
[email protected], or*@example.comfor the catch-all of a domain. Left out, every address is listed.api_keystrOverrides the client API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
OpenEmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
Page[SignatureResource], a dict with items, hasMore and nextCursor. Each item has id, address, name, html, isDefault, isReplyDefault, createdAt and updatedAt.
Example
from openemail import openemail page = openemail.signatures.list(address='[email protected]') for signature in page['items']: print( signature['name'], 'new mail' if signature['isDefault'] else '', 'replies' if signature['isReplyDefault'] else '', )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.list_all()
Collect every signature into one list
def list_all( *, limit: int | None = None, cursor: str | None = None, address: str | None = None, api_key: str | None = None, timeout: float | None = None,) -> builtins.list[SignatureResource]Walks every page of 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
limitintPage size for each request, from 1 to 100. The server defaults to 25.
cursorstrStarts the walk after this cursor instead of the first page.
addressstrOne address, or
*@example.comfor a catch-all. Left out, every address is collected.api_keystrOverrides the client API key for every page of this walk.
timeoutfloatSeconds this call may take, the response included, before it raises
OpenEmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
list[SignatureResource] holding every signature.
Example
from openemail import openemail signatures = openemail.signatures.list_all(address='[email protected]')short = next((signature for signature in signatures if signature['name'] == 'Short'), None) if short is not None: openemail.emails.send( { 'from': '[email protected]', 'to': '[email protected]', 'subject': 'Quick note', 'text': 'See you on Thursday.', 'signatureId': short['id'], } )Notes
If any page fails, the call raises and the signatures already fetched are discarded.
Also available in
signatures.iterate()
Stream the signatures one at a time
def iterate( *, limit: int | None = None, cursor: str | None = None, address: str | None = None, api_key: str | None = None, timeout: float | None = None,) -> Iterator[SignatureResource]Returns a generator 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 it stops the requests.
Parameters
limitintPage size for each request, from 1 to 100. The server defaults to 25.
cursorstrStarts the walk after this cursor instead of the first page.
addressstrOne address, or
*@example.comfor a catch-all. Left out, every address is walked.api_keystrOverrides the client API key for every page of this walk.
timeoutfloatSeconds this call may take, the response included, before it raises
OpenEmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
Iterator[SignatureResource], a generator yielding one signature per step.
Example
from openemail import openemail for signature in openemail.signatures.iterate(): if signature['isDefault']: print(signature['address'], 'signs new mail with', signature['name'])Notes
The generator is lazy, so an abandoned loop costs only the pages you consumed.
Also available in
signatures.get()
Read one signature by id
def get( id: str, *, api_key: str | None = None, timeout: float | None = None,) -> SignatureResourceLooks 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.
Parameters
idstrRequiredSignature id, which starts with
sig_.api_keystrOverrides the client API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
OpenEmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
SignatureResource with id, address, name, html, isDefault, isReplyDefault, createdAt and updatedAt.
Example
from openemail import openemail signature = openemail.signatures.get('sig_8f2c1a9b7d3e4f60a1b2c3d4') print(signature['address'], signature['name'], signature['html'])Notes
A missing signature raises
OpenEmailApiErrorwithis_not_foundset toTrueand coderesource_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
def create( body: SignatureInput, *, api_key: str | None = None, timeout: float | None = None,) -> SignatureResourceAdds 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['address']strRequiredThe address the signature is for, such as
[email protected], or*@example.comfor the catch-all of a domain.body['name']strRequiredWhat the signature is called, trimmed, 1 to 80 characters. Unique on its address, whatever the case.
body['html']strRequiredThe signature as HTML, at most 150,000 characters before and after sanitising. It has to keep some text or an image.
body['isDefault']boolTruemakes it the signature of new mail from the address. Left out, only the first signature of an address becomes that.body['isReplyDefault']boolTruemakes it the signature of replies and forwards from the address. Left out, only the first signature of an address becomes that.api_keystrOverrides the client API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
OpenEmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
SignatureResource with the new id, the trimmed name, the sanitised html, isDefault and isReplyDefault.
Example
from openemail import openemail signature = openemail.signatures.create( { 'address': '[email protected]', 'name': 'Short', 'html': '<p>Ada<br>Acme Ltd</p>', 'isReplyDefault': True, }) print(signature['id'], signature['isDefault'], signature['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
def update( id: str, patch: SignaturePatch, *, api_key: str | None = None, timeout: float | None = None,) -> SignatureResourceChanges a signature and returns it as it is stored. Send any of name, html, isDefault and isReplyDefault: a key 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
idstrRequiredSignature id, which starts with
sig_.patch['name']strNew name, trimmed, 1 to 80 characters. Left out, the name stays.
patch['html']strNew HTML, at most 150,000 characters before and after sanitising. Left out, the HTML stays.
patch['isDefault']boolTruemakes it the default for new mail,Falsetakes that away when it held it. Left out, nothing changes.patch['isReplyDefault']boolTruemakes it the default for replies and forwards,Falsetakes that away when it held it. Left out, nothing changes.api_keystrOverrides the client API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
OpenEmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
SignatureResource with the unchanged id and address and the new name, html, isDefault and isReplyDefault.
Example
from openemail import openemail saved = openemail.signatures.update('sig_8f2c1a9b7d3e4f60a1b2c3d4', {'isDefault': True}) print(saved['name'], saved['isDefault'])Notes
The SDK retries this call after a network failure, since the same patch sent twice leaves the same signature.
settings.updatewithaddress=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
def delete( id: str, *, api_key: str | None = None, timeout: float | None = None,) -> DeletedSignatureResourceDeletes 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
idstrRequiredSignature id, which starts with
sig_.api_keystrOverrides the client API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
OpenEmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
DeletedSignatureResource with object set to signature, the id, the address, and deleted set to True.
Example
from openemail import openemail removed = openemail.signatures.delete('sig_8f2c1a9b7d3e4f60a1b2c3d4') print(removed['address'], removed['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
def copy( id: str, body: SignatureCopy, *, api_key: str | None = None, timeout: float | None = None,) -> builtins.list[SignatureResource]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
idstrRequiredThe signature to copy.
body['addresses']list[str]Required1 to 500 addresses to copy it to. Each is one address or
*@example.comfor a catch-all.body['isDefault']boolTruemakes each copy the default for new mail on its address.body['isReplyDefault']boolTruemakes each copy the default for replies and forwards on its address.api_keystrOverrides the client API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
OpenEmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
list[SignatureResource], one copy for each address, in the order given.
Example
from openemail import openemail copies = openemail.signatures.copy( 'sig_8f2c1a9b7d3e4f60a1b2c3d4', {'addresses': ['[email protected]', '[email protected]'], 'isDefault': True},) for copy in copies: print(copy['address'], copy['id'], copy['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.