openemail.account
Cada método de este espacio de nombres: su firma, sus parámetros, lo que devuelve y un ejemplo.
Métodos
The account of the person behind the key or the app: the email notifications they get and the workspaces muted on their phone, their profile photo and username, the apps they connected and the invitations waiting for them. An API key acts for the workspace owner, and an app for the person who connected it.
account.get_notifications()
Read your notification settings
def get_notifications( *, api_key: str | None = None, timeout: float | None = None,) -> NotificationSettingsResourceReturns which kinds of email OpenEmail sends the person, as Account, Notifications shows them, and the workspaces whose notifications are muted on their phone. An API key answers for the workspace owner, and an app for the person who connected it.
Parámetros
api_keystrOverrides the client's 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.
Devuelve
NotificationSettingsResource with email, a list holding one EmailNotificationSetting for each kind of email, and mutedWorkspaces, a list of workspace ids.
Ejemplo
from openemail import openemail settings = openemail.account.get_notifications() for kind in settings['email']: print(kind['label'], 'on' if kind['enabled'] else 'off') print('Muted on the phone:', settings['mutedWorkspaces'])Notas
accountandbillingemail are always on, andrequiredsays so.
También disponible en
account.set_email_notification()
Turn a kind of email on or off
def set_email_notification( category: EmailNotificationCategory, body: EmailNotificationSet, *, api_key: str | None = None, timeout: float | None = None,) -> NotificationSettingsResource{'enabled': False} stops OpenEmail sending the person that kind of email, and {'enabled': True} starts it again. activity and product can be turned off. account and billing cannot, and asking to is a 422 invalid_parameter on category.
Parámetros
categoryEmailNotificationCategoryObligatorioaccount,billing,activityorproduct.body['enabled']boolObligatorioTrueto receive that email,Falseto stop it.api_keystrOverrides the client's 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.
Devuelve
NotificationSettingsResource as it is after the change.
Ejemplo
from openemail import openemail settings = openemail.account.set_email_notification('product', {'enabled': False}) for kind in settings['email']: print(kind['category'], kind['enabled'])Notas
Retried automatically on network failure, since the same setting sent twice changes nothing.
También disponible en
account.set_push_muted()
Mute a workspace on your phone
def set_push_muted( workspace_id: str, body: PushNotificationSet, *, api_key: str | None = None, timeout: float | None = None,) -> NotificationSettingsResource{'muted': True} stops the phone app notifying the person about the mail of one workspace, on every phone they signed in on, and {'muted': False} lets it notify them again.
Parámetros
workspace_idstrObligatorioA workspace id from
workspaces.list.body['muted']boolObligatorioTrueto mute it,Falseto let it notify again.api_keystrOverrides the client's 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.
Devuelve
NotificationSettingsResource with the new mutedWorkspaces.
Ejemplo
from openemail import openemail settings = openemail.account.set_push_muted( '10417196-e324-4283-af98-66ec62167c47', {'muted': True}) print(settings['mutedWorkspaces'])Notas
A workspace the person cannot open is a 404
resource_not_found.Retried automatically on network failure, since the same setting sent twice changes nothing.
También disponible en
account.set_photo()
Set your profile photo
def set_photo( data: RawBody, *, content_type: ContactPhotoType | None = None, api_key: str | None = None, timeout: float | None = None,) -> AccountPhotoResourceSends the image bytes as the request body, replacing the person's profile photo, as Account, Profile does. PNG, JPEG, WebP and GIF are accepted, up to 5 MB. The server fits the image into a 512 pixel square, stores it as WebP and keeps the first frame of an animation.
data is bytes, a bytearray or a memoryview, such as what Path('photo.jpg').read_bytes() returns. Bytes carry no type of their own, so the type is read from content_type= alone. Without it the bytes go as application/octet-stream and the server refuses them with 422 invalid_image.
Parámetros
dataRawBodyObligatorioThe image as
bytes, abytearrayor amemoryview.content_typeContactPhotoTypeimage/png,image/jpeg,image/webporimage/gif, matching the bytes. Left out, the upload is refused with 422invalid_image.api_keystrOverrides the client's 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.
Devuelve
AccountPhotoResource with the new url.
Ejemplo
from pathlib import Path from openemail import openemail photo = openemail.account.set_photo(Path('photo.jpg').read_bytes(), content_type='image/jpeg') print(photo['url'])Notas
A busy image service answers 503
image_busy, which the SDK retries like any other 503.Every upload gets a new URL, so a cached old photo never shows under the new one.
También disponible en
- API
PUT /account/photo- TypeScript
account.setPhoto()- Ruby
account.set_photo- CLI
openemail account set-photo
account.remove_photo()
Remove your profile photo
def remove_photo( *, api_key: str | None = None, timeout: float | None = None,) -> AccountPhotoResourceRemoves the profile photo and deletes the stored image, so the app shows the person's initials again. Removing it when there is none changes nothing.
Parámetros
api_keystrOverrides the client's 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.
Devuelve
AccountPhotoResource with url set to None.
Ejemplo
from openemail import openemail photo = openemail.account.remove_photo() print(photo['url'])Notas
Safe to replay, so the SDK retries it after a network failure.
También disponible en
account.get_username()
Read your username
def get_username( *, api_key: str | None = None, timeout: float | None = None,) -> UsernameResourceReturns the person's username, whether they chose it or it was made for them from their name, and the free address it gives them when this deployment offers one. A username the person chose never changes.
Parámetros
api_keystrOverrides the client's 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.
Devuelve
UsernameResource with username, chosen and address.
Ejemplo
from openemail import openemail account = openemail.account.get_username() print(account['username'], 'chosen' if account['chosen'] else 'made for you')print(account['address'])Notas
The first read makes a username for an account that has none.
También disponible en
account.check_username()
Check a username
def check_username( username: str, *, api_key: str | None = None, timeout: float | None = None,) -> UsernameAvailabilityResourceSays whether the person could choose a username, without choosing it, and why not when they could not. The username is lowercased and its spaces become dots before it is checked, as the app does, and username in the answer is the form that was checked.
Parámetros
usernamestrObligatorioUp to 60 characters before it is tidied.
api_keystrOverrides the client's 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.
Devuelve
UsernameAvailabilityResource with status, available and a message that says why.
Ejemplo
from openemail import openemail check = openemail.account.check_username('Ada Lovelace') if check['available']: print(check['username'], 'is free')else: print(check['status'], check['message'])Notas
statusiscurrentfor the username the person already has, andavailableisFalsefor it.
También disponible en
account.set_username()
Choose your username
def set_username( username: str, *, api_key: str | None = None, timeout: float | None = None,) -> UsernameResourceSets the person's username for good, and with it their free address. Once chosen it never changes: a second choice is refused with 409 username_locked. A username another account has is a 409 username_taken, and one that is too short, too long, reserved or not lowercase letters, numbers and single dots is a 422 invalid_parameter on username. Check one first with check_username.
Parámetros
usernamestrObligatorio3 to 30 lowercase letters, numbers and single dots once it is tidied.
api_keystrOverrides the client's 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.
Devuelve
UsernameResource with chosen set to True.
Ejemplo
from openemail import OpenEmailApiError, openemail try: account = openemail.account.set_username('ada.lovelace')except OpenEmailApiError as error: if error.code == 'username_taken': print('Someone else has that one, try another') elif error.code == 'username_locked': print('Your username is already chosen for good') else: raiseelse: print(account['username'], account['address'])Notas
Not retried automatically: a retry after a lost response would be refused with
username_locked, because the first call already chose it.
También disponible en
account.list_connected_apps()
List your connected apps
def list_connected_apps( *, api_key: str | None = None, timeout: float | None = None,) -> builtins.list[ConnectedAppResource]Returns every app the person connected with OAuth, as Account, Connected apps lists them: the workspace and the permissions each may reach, until when, how many tokens it holds, and until when it may make changes that ask for a verification code without one. current marks the app making the call.
What an app may reach is changed in the app, never through an app.
Parámetros
api_keystrOverrides the client's 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.
Devuelve
list[ConnectedAppResource], each with clientId, name, kind, status, grant and tokenCount.
Ejemplo
from openemail import openemail apps = openemail.account.list_connected_apps() for app in apps: print(app['name'], app['kind'], app['status'], '(this app)' if app['current'] else '')Notas
A sign-in of the command line tool shows with
kindset tocli, and its device incliDevice.
También disponible en
account.revoke_connected_app()
Remove a connected app
def revoke_connected_app( client_id: str, *, api_key: str | None = None, timeout: float | None = None,) -> RevokedConnectedAppResourceDeletes every token the app holds and the access the person gave it, so its next call is refused and it has to ask again, as removing it in Account, Connected apps does. Removing the app making the call disconnects it.
Parámetros
client_idstrObligatorioThe app's
clientIdfromlist_connected_apps.api_keystrOverrides the client's 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.
Devuelve
RevokedConnectedAppResource with revoked set to True and tokensRevoked.
Ejemplo
from openemail import openemail revoked = openemail.account.revoke_connected_app('kZ3mQ9vT2xR7pL4wN8bY1cF6hJ5sD0aE') print(revoked['clientId'], 'lost', revoked['tokensRevoked'], 'tokens')Notas
An app the person never connected is a 404
resource_not_found.Not retried automatically. A retry after a lost response is a 404, since the app is already gone.
También disponible en
account.list_invitations()
List your invitations
def list_invitations( *, api_key: str | None = None, timeout: float | None = None,) -> builtins.list[ReceivedInvitationResource]Returns the invitations to join a workspace that are waiting for the address the person signs in with, oldest first. Expired, accepted and withdrawn ones are left out. The invitations a workspace sent are members.list_invitations instead.
Parámetros
api_keystrOverrides the client's 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.
Devuelve
list[ReceivedInvitationResource], each with id, workspaceName, roleName, inviterName, addresses and expiresAt.
Ejemplo
from openemail import openemail invitations = openemail.account.list_invitations() for invitation in invitations: print(invitation['workspaceName'], invitation['roleName'], invitation['expiresAt'])Notas
addressescounts the addresses and the whole domains the invitation gives together.
También disponible en
account.accept_invitation()
Accept an invitation
def accept_invitation( invitation_id: str, *, activate: bool | None = None, api_key: str | None = None, timeout: float | None = None,) -> AcceptedInvitationResourceJoins the workspace with the role and the addresses the invitation gives, as accepting it in the app or from its link does. activate=True also makes it the workspace the app opens for the person.
A workspace that asks everyone in it to sign in with two-factor authentication is refused with 403 two_factor_required until the person turns it on. An invitation that expired, was withdrawn or went to another address is a 422, and one that is not waiting any more a 404 invitation_not_found.
Parámetros
invitation_idstrObligatorioAn invitation id from
list_invitations.activateboolTrueto make it the workspace the app opens. Defaults toFalse.api_keystrOverrides the client's 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.
Devuelve
AcceptedInvitationResource with workspaceId, workspaceName, addressesGranted, domainsGranted and activated.
Ejemplo
from openemail import openemail invitations = openemail.account.list_invitations() if invitations: joined = openemail.account.accept_invitation(invitations[0]['id'], activate=True) print(joined['workspaceName'], joined['addressesGranted'], joined['activated'])Notas
Retried automatically on network failure, since accepting an invitation the person already accepted succeeds again and changes nothing.
También disponible en
account.decline_invitation()
Decline an invitation
def decline_invitation( invitation_id: str, *, api_key: str | None = None, timeout: float | None = None,) -> DeclinedInvitationResourceTurns the invitation down, so its link stops working, and tells whoever sent it. It cannot be taken back: they have to invite the person again. An invitation the person already accepted is refused with 409 invitation_accepted.
Parámetros
invitation_idstrObligatorioAn invitation id from
list_invitations.api_keystrOverrides the client's 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.
Devuelve
DeclinedInvitationResource with declined set to True.
Ejemplo
from openemail import openemail declined = openemail.account.decline_invitation('winv_6bb640f5b99e47deb758f1f5') print(declined['id'], declined['declined'])Notas
Retried automatically on network failure, since declining twice changes nothing.