openemail account
هر فرمان در این فضای نام، با آرگومانها، پرچمها و نمونههایش.
فرمانها
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.
هر فرمان در اینجا پرچمهای سراسری مانند --json، --profile و --dry-run را هم میپذیرد. پرچمهای سراسری را ببینید
account get-notificationsaccount set-email-notificationaccount set-push-mutedaccount set-photoaccount remove-photoaccount get-usernameaccount check-usernameaccount set-usernameaccount list-connected-appsaccount revoke-connected-appaccount list-invitationsaccount accept-invitationaccount decline-invitation
openemail account get-notifications
Read your notification settings
نحوه استفاده
openemail account get-notifications [flags]
Resolves 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.
نمونهها
openemail account get-notificationsopenemail account get-notifications --jsonهمچنین در دسترس در
openemail account set-email-notification
Turn a kind of email on or off
نحوه استفاده
openemail account set-email-notification <category> --enabled [flags] openemail account set-email-notification <category> --data <json|@file|-> [flags]
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.
آرگومانها
<category>الزامیaccount,billing,activityorproduct.
پرچمها
--enabledTrue to receive that email, false to stop it. Required, here or in
--data.--data <json|@file|->The whole
bodyas JSON, inline, from a file with @path, or - for standard input. Flags override its keys.
نمونهها
openemail account set-email-notification product --no-enabledopenemail account set-email-notification product --data @account.jsonهمچنین در دسترس در
openemail account set-push-muted
Mute a workspace on your phone
نحوه استفاده
openemail account set-push-muted <workspace-id> --muted [flags] openemail account set-push-muted <workspace-id> --data <json|@file|-> [flags]
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.
آرگومانها
<workspace-id>الزامیA workspace id from
workspaces.list.
پرچمها
--mutedTrue to mute it, false to let it notify again. Required, here or in
--data.--data <json|@file|->The whole
bodyas JSON, inline, from a file with @path, or - for standard input. Flags override its keys.
نمونهها
openemail account set-push-muted 10417196-e324-4283-af98-66ec62167c47 --mutedopenemail account set-push-muted 10417196-e324-4283-af98-66ec62167c47 --data @account.jsonهمچنین در دسترس در
openemail account set-photo
Set your profile photo
نحوه استفاده
openemail account set-photo <data> [flags]
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 a Blob, an ArrayBuffer or a Uint8Array. The type is read from --content-type, or from a Blob's own type when that is left out. Without either the bytes go as application/octet-stream and the server refuses them with 422 invalid_image.
آرگومانها
<data>الزامیThe image: a
Blob,ArrayBufferorUint8Array.
پرچمها
--content-type <value>image/png,image/jpeg,image/webporimage/gif. Required unlessdatais aBlobwith a type.
نمونهها
openemail account set-photo ./photo.jpgopenemail account set-photo ./photo.jpg --content-type image/jpegهمچنین در دسترس در
openemail account remove-photo
Remove your profile photo
نحوه استفاده
openemail account remove-photo [flags]
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.
نمونهها
openemail account remove-photoopenemail account remove-photo --yesهمچنین در دسترس در
openemail account get-username
Read your username
نحوه استفاده
openemail account get-username [flags]
Resolves 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.
نمونهها
openemail account get-usernameopenemail account get-username --jsonهمچنین در دسترس در
openemail account check-username
Check a username
نحوه استفاده
openemail account check-username <username> [flags]
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.
آرگومانها
<username>الزامیUp to 60 characters before it is tidied.
نمونهها
openemail account check-username ada.lovelaceopenemail account check-username ada.lovelace --jsonهمچنین در دسترس در
openemail account set-username
Choose your username
نحوه استفاده
openemail account set-username <username> [flags]
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.
آرگومانها
<username>الزامی3 to 30 lowercase letters, numbers and single dots once it is tidied.
نمونهها
openemail account set-username ada.lovelaceopenemail account set-username ada.lovelace --yesهمچنین در دسترس در
openemail account list-connected-apps
List your connected apps
نحوه استفاده
openemail account list-connected-apps [flags]
Resolves 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.
نمونهها
openemail account list-connected-appsopenemail account list-connected-apps --jsonهمچنین در دسترس در
openemail account revoke-connected-app
Remove a connected app
نحوه استفاده
openemail account revoke-connected-app <client-id> [flags]
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.
آرگومانها
<client-id>الزامیThe app's
clientIdfromlistConnectedApps.
نمونهها
openemail account revoke-connected-app client_4c1b257aopenemail account revoke-connected-app client_4c1b257a --yesهمچنین در دسترس در
openemail account list-invitations
List your invitations
نحوه استفاده
openemail account list-invitations [flags]
Resolves 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.
نمونهها
openemail account list-invitationsopenemail account list-invitations --jsonهمچنین در دسترس در
openemail account accept-invitation
Accept an invitation
نحوه استفاده
openemail account accept-invitation <invitation-id> [flags]
Joins the workspace with the role and the addresses the invitation gives, as accepting it in the app or from its link does. --activate 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.
آرگومانها
<invitation-id>الزامیAn invitation id from
listInvitations.
پرچمها
--activateTrue to make it the workspace the app opens. Defaults to false.
نمونهها
openemail account accept-invitation winv_6bb640f5b99e47deb758f1f5openemail account accept-invitation winv_6bb640f5b99e47deb758f1f5 --activateهمچنین در دسترس در
openemail account decline-invitation
Decline an invitation
نحوه استفاده
openemail account decline-invitation <invitation-id> [flags]
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.
آرگومانها
<invitation-id>الزامیAn invitation id from
listInvitations.
نمونهها
openemail account decline-invitation winv_6bb640f5b99e47deb758f1f5openemail account decline-invitation winv_6bb640f5b99e47deb758f1f5 --yes