client.Account
Cada método deste espaço de nomes: a sua assinatura, os seus parâmetros, o que devolve e um exemplo.
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.GetNotifications
Read your notification settings
GetNotifications(ctx context.Context, opts ...openemail.RequestOption) (openemail.Object, error)Returns 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
openemail.WithAPIKeystringOverrides the client's API key for this call only.
Devolve
An openemail.Object with email, one EmailNotificationSetting for each kind of email, and mutedWorkspaces.
Exemplo
settings, err := client.Account.GetNotifications(ctx)if err != nil { return err} fmt.Println(settings.String("object"))Notas
accountandbillingemail are always on, andrequiredsays so.
Também disponível em
Account.SetEmailNotification
Turn a kind of email on or off
SetEmailNotification(ctx context.Context, category string, body openemail.Body, opts ...openemail.RequestOption) (openemail.Object, error)enabled: false stops OpenEmail sending the person that kind of email, and 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
categorystringObrigatórioaccount,billing,activityorproduct.enabledboolObrigatórioTrue to receive that email, false to stop it.
openemail.WithAPIKeystringOverrides the client's API key for this call only.
Devolve
An openemail.Object as it is after the change.
Exemplo
settings, err := client.Account.SetEmailNotification(ctx, "product", openemail.Body{"enabled": false})if err != nil { return err} fmt.Println(settings.String("object"))Notas
Retried automatically on network failure, since the same setting sent twice changes nothing.
Também disponível em
- API
PUT /account/notifications/email/{category}- TypeScript
account.setEmailNotification()- Python
account.set_email_notification()- Ruby
account.set_email_notification- PHP
account->setEmailNotification- Java
account().setEmailNotification- C#
Account.SetEmailNotificationAsync- CLI
openemail account set-email-notification
Account.SetPushMuted
Mute a workspace on your phone
SetPushMuted(ctx context.Context, workspaceID string, body openemail.Body, opts ...openemail.RequestOption) (openemail.Object, error)muted: true stops the phone app notifying the person about the mail of one workspace, on every phone they signed in on, and false lets it notify them again.
Parâmetros
workspaceIDstringObrigatórioA workspace id from
Workspaces.List.mutedboolObrigatórioTrue to mute it, false to let it notify again.
openemail.WithAPIKeystringOverrides the client's API key for this call only.
Devolve
An openemail.Object with the new mutedWorkspaces.
Exemplo
settings, err := client.Account.SetPushMuted(ctx, "10417196-e324-4283-af98-66ec62167c47", openemail.Body{"muted": true})if err != nil { return err} fmt.Println(settings.String("object"))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.
Também disponível em
Account.SetPhoto
Set your profile photo
SetPhoto(ctx context.Context, data io.Reader, opts ...openemail.RequestOption) (openemail.Object, error)Sends 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 an io.Reader. The type is read from openemail.WithContentType. Without either the bytes go as application/octet-stream and the server refuses them with 422 invalid_image.
Parâmetros
dataio.ReaderObrigatórioThe image, as an
io.Reader.openemail.WithContentTypestringimage/png,image/jpeg,image/webporimage/gif. The server needs it to accept the image.openemail.WithAPIKeystringOverrides the client's API key for this call only.
Devolve
An openemail.Object with the new url.
Exemplo
source, err := os.Open("photo.jpg")if err != nil { return err} defer source.Close() photo, err := client.Account.SetPhoto(ctx, source, openemail.WithContentType("image/jpeg"))if err != nil { return err} fmt.Println(photo.String("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.
Também disponível em
Account.RemovePhoto
Remove your profile photo
RemovePhoto(ctx context.Context, opts ...openemail.RequestOption) (openemail.Object, error)Removes 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
openemail.WithAPIKeystringOverrides the client's API key for this call only.
Devolve
An openemail.Object with url null.
Exemplo
photo, err := client.Account.RemovePhoto(ctx)if err != nil { return err} fmt.Println(photo.String("object"))Notas
Safe to replay, so the SDK retries it after a network failure.
Também disponível em
Account.GetUsername
Read your username
GetUsername(ctx context.Context, opts ...openemail.RequestOption) (openemail.Object, error)Returns 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
openemail.WithAPIKeystringOverrides the client's API key for this call only.
Devolve
An openemail.Object with username, chosen and address.
Exemplo
username, err := client.Account.GetUsername(ctx)if err != nil { return err} fmt.Println(username.String("username"), username.Bool("chosen"), username.String("address"))Notas
The first read makes a username for an account that has none.
Também disponível em
Account.CheckUsername
Check a username
CheckUsername(ctx context.Context, username string, opts ...openemail.RequestOption) (openemail.Object, error)Says 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
usernamestringObrigatórioUp to 60 characters before it is tidied.
openemail.WithAPIKeystringOverrides the client's API key for this call only.
Devolve
An openemail.Object with status, available and a message that says why.
Exemplo
check, err := client.Account.CheckUsername(ctx, "ada.lovelace")if err != nil { return err} fmt.Println(check.Bool("available"), check.String("message"))Notas
statusiscurrentfor the username the person already has, andavailableis false for it.
Também disponível em
Account.SetUsername
Choose your username
SetUsername(ctx context.Context, username string, opts ...openemail.RequestOption) (openemail.Object, error)Sets 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 CheckUsername.
Parâmetros
usernamestringObrigatório3 to 30 lowercase letters, numbers and single dots once it is tidied.
openemail.WithAPIKeystringOverrides the client's API key for this call only.
Devolve
An openemail.Object with chosen: true.
Exemplo
username, err := client.Account.SetUsername(ctx, "ada.lovelace")if err != nil { return err} fmt.Println(username.String("address"), username.String("object"))Notas
Not retried automatically: a retry after a lost response would be refused with
username_locked, because the first call already chose it.
Também disponível em
Account.ListConnectedApps
List your connected apps
ListConnectedApps(ctx context.Context, opts ...openemail.RequestOption) ([]openemail.Object, error)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
openemail.WithAPIKeystringOverrides the client's API key for this call only.
Devolve
A []openemail.Object, each with clientId, name, kind, status, grant and tokenCount.
Exemplo
apps, err := client.Account.ListConnectedApps(ctx)if err != nil { return err} for _, app := range apps { fmt.Println(app.String("name"), app.String("status"), app.Bool("current"))}Notas
A sign-in of the command line tool shows as
kind: 'cli', with its device incliDevice.
Também disponível em
Account.RevokeConnectedApp
Remove a connected app
RevokeConnectedApp(ctx context.Context, clientID string, opts ...openemail.RequestOption) (openemail.Object, error)Deletes 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
clientIDstringObrigatórioThe app's
clientIdfromListConnectedApps.openemail.WithAPIKeystringOverrides the client's API key for this call only.
Devolve
An openemail.Object with revoked: true and tokensRevoked.
Exemplo
app, err := client.Account.RevokeConnectedApp(ctx, "app_3f9c2a7b1e4d8f60")if err != nil { return err} fmt.Println(app.String("object"))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.
Também disponível em
Account.ListInvitations
List your invitations
ListInvitations(ctx context.Context, opts ...openemail.RequestOption) ([]openemail.Object, error)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.ListInvitations instead.
Parâmetros
openemail.WithAPIKeystringOverrides the client's API key for this call only.
Devolve
A []openemail.Object, each with id, workspaceName, roleName, inviterName, addresses and expiresAt.
Exemplo
invitations, err := client.Account.ListInvitations(ctx)if err != nil { return err} for _, invitation := range invitations { fmt.Println(invitation.String("workspaceName"), invitation.String("roleName"))}Notas
addressescounts the addresses and the whole domains the invitation gives together.
Também disponível em
Account.AcceptInvitation
Accept an invitation
AcceptInvitation(ctx context.Context, invitationID string, opts ...openemail.RequestOption) (openemail.Object, error)Joins the workspace with the role and the addresses the invitation gives, as accepting it in the app or from its link does. openemail.WithActivate 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
invitationIDstringObrigatórioAn invitation id from
ListInvitations.openemail.WithActivateboolTrue to make it the workspace the app opens. Defaults to false.
openemail.WithAPIKeystringOverrides the client's API key for this call only.
Devolve
An openemail.Object with workspaceId, workspaceName, addressesGranted, domainsGranted and activated.
Exemplo
joined, err := client.Account.AcceptInvitation(ctx, "winv_6bb640f5b99e47deb758f1f5", openemail.WithActivate(true))if err != nil { return err} fmt.Println(joined.String("workspaceName"))Notas
Retried automatically on network failure, since accepting an invitation the person already accepted succeeds again and changes nothing.
Também disponível em
Account.DeclineInvitation
Decline an invitation
DeclineInvitation(ctx context.Context, invitationID string, opts ...openemail.RequestOption) (openemail.Object, error)Turns 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
invitationIDstringObrigatórioAn invitation id from
ListInvitations.openemail.WithAPIKeystringOverrides the client's API key for this call only.
Devolve
An openemail.Object with declined: true.
Exemplo
invitation, err := client.Account.DeclineInvitation(ctx, "winv_6bb640f5b99e47deb758f1f5")if err != nil { return err} fmt.Println(invitation.String("id"), invitation.String("object"))Notas
Retried automatically on network failure, since declining twice changes nothing.