Komutlar

openemail <command> [subcommand] [arguments] [flags]

• —Bayraklar komuttan sonra, bağımsız değişkenlerin önünde ya da arkasında, herhangi bir yere gelir. --profile ve --json gibi genel bayraklar komuttan önce de gelebilir; oraya konan başka her bayrak, onu komut adından sonraya taşımanızı söyleyen bir ipucuyla durur.
• —Bir değer bayrağını bir boşluk ya da eşittir işaretinden sonra izler, bu yüzden --limit 50 ile --limit=50 aynıdır. Kısa bayraklar da değer alır, örneğin -n 50.
• —Tireyle başlayan bir değer, --subject=-draft- örneğindeki gibi eşittir işareti ister, çünkü bir boşluktan sonra sonraki bayrak olarak okunur ve ilk bayrağın değeri eksik diye bildirilir. Negatif sayılar iki biçimde de çalışır. Boş bir değer, sessiz bir varsayılan değil, bir kullanım hatasıdır.
• —Bir anahtar --flag ile açılır, --no-flag ile kapanır; --flag=true ve --flag=false da çalışır.
• —Bir liste virgülle ayrılır ya da tekrarlanır: --to [email protected],[email protected] ya da iki kez --to.
• —-- sonrasındaki her şey bağımsız değişkendir, asla bayrak değildir; -from:ada araması böyle geçer.
• —Bilinmeyen bir komut ya da bayrak 2 çıkış koduyla durur ve en yakın eşleşmeyi önerir.

Bunlar insanlar için yazılmıştır: eksik olanı sorar, çıktılarını biçimlendirir ve işe yaradığında birkaç API çağrısını birleştirirler.

SDK'nın her yöntemi aynı zamanda bir komuttur: openemail <namespace> <verb>. Ad alanı kebab-case yazılmış SDK ad alanıdır, fiil de kebab-case yazılmış yöntem adıdır, bu yüzden keys.listRequests komutu openemail keys list-requests olur. Birlikte REST API'nin tamamını kapsarlar.

openemail domains listopenemail domains create --domain acme.comopenemail rules create --data @rule.jsonopenemail keys list-requests 9f2c1a4b7e05d3862c1f0a44 --failed-only --allopenemail files download file_6bb640f5b99e47deb758f1f5 --out report.pdf

• —Yöntemin aldığı bir kimlik, openemail domains get <id> örneğindeki gibi bir bağımsız değişkendir. İstek gövdesinin her alanı, kebab-case yazılmış adını taşıyan bir bayraktır: replyTo, --reply-to olur; color.backgroundColor de --color-background-color olur.
• —Bayrağı genel bir bayrakla çakışacak üç alanın adı değiştirildi: --template-version, --label-color ve --resend-key.
• —--data gövdenin tamamını JSON olarak alır: satır içi, @path ile bir dosyadan ya da - ile stdin'den; ayrıca verdiğiniz her bayrak kendi anahtarını geçersiz kılar. Nesne alan bir bayrak JSON'u aynı şekilde okur.
• —Sayılar ve anahtarlar olduğu gibi okunur, listeler virgülle ayrılır ya da tekrarlanır.
• —Eksik bir zorunlu değer terminalde sorulur, başka her yerde bir kullanım hatasıdır (2 çıkış kodu).
• —Bir liste fiili tek bir sayfa okur. --limit boyutunu belirler, --cursor yazdırdığı imleçten devam eder. --all her sayfayı okuyup öğeleri akış halinde verir, --max <n> o kadar öğeden sonra durur, --ndjson her satıra bir JSON nesnesi yazdırır.
• —Silme, iptal etme, döndürme, vazgeçme ya da boşaltma gibi yıkıcı her şey, --yes vermediğiniz sürece onay ister.
• —Bir indirme --out ile verilen dosyaya yazılır; stdout'a ise yalnızca stdout bir terminal değilken yazılır.

openemail <namespace> <verb> --help her bağımsız değişkeni ve bayrağı türüyle, çağrının gerektirdiği kapsamları, yöntemini ve yolunu, ne döndürdüğünü ve API başvurusundaki notları gösterir.

Ayrıca sütunu, bir ad alanının yanıt verdiği diğer adları listeler.

Fiilleri add ve remove olan members ve suppressions içinde, new ve create komutları add fiiline, rm, del ve delete de remove fiiline götürür. Elle yazılmış bazı alt komutların kendi takma adları vardır ve yardımları bunları listeler.

openemail api <method> <path>, REST API'ye diğer her komutla aynı taşıma üzerinden tek bir istek gönderir; bu yüzden profiliniz ya da anahtarınız, token yenileme ve doğrulama kodları geçerli olur. Tek başına bir yol bir GET isteğidir. JSON yanıtı biçimlendirilmiş olarak yazdırılır; başarısız bir istek ise API hatasını yazdırır ve uygun kodla çıkar.

openemail api /keys/selfopenemail api GET /threads --query folder=inbox --query limit=5openemail api POST /labels --data '{"name":"Receipts"}'openemail api PATCH /threads/CAHk7pQ2x9LmZ4 --data @patch.jsonopenemail api GET /files/file_6bb640f5b99e47deb758f1f5/content --out report.pdf

• —-d, --data gövdeyi satır içi JSON olarak, @path ile bir dosyadan ya da - ile stdin'den alır. -q, --query ve -H, --header key=value alır ve tekrarlanabilir; -o, --out yanıtı geldiği gibi bir dosyaya kaydeder.
• —Yol, API kaynağına göredir. Tam bir URL, kaynağın dışına çıkacak bir yol ve bir Authorization başlığı hiçbir şey gönderilmeden 2 çıkış koduyla reddedilir, çünkü kimlik bilgisini CLI kendisi ayarlar.

openemail --helpopenemail help sendopenemail domains --helpopenemail domains create --help

openemail --help her komutu ne işe yaradığına göre listeler. Bir grup alt komutlarını örneklerle listeler, bir komut da aldığı her şeyi gösterir. openemail docs open cli bu sayfaları açar.