E-posta ve API komutları
mail Mail
E-posta gönderir (SMTP) ve bir posta kutusuyla çalışır (IMAP): read mesajları kayıt olarak listeler; saveattachments, move, delete ve markread bu kayıtların Id değerini alır. Hesap (kullanıcı adı ve parola) bir kasa kimlik bilgisinden gelir: --vault ve --credential seçin.
Tüm türlerde geçerli parametreler
| Parametre | Değer | Varsayılan | Açıklama |
|---|---|---|---|
--retry | sayı | Yeniden deneme sayısı. Belirtilmezse ekran ve dosya komutları geçici bir sorundan (hâlâ yüklenen bir sayfa, örtülü bir öğe, kilitli bir dosya) sonra bir kez daha dener; 0 bunu kapatır | |
--retryinterval | sayı | 1 | Yeniden denemeler arasındaki saniye |
İşlemler (--action)
--action:send
Bir SMTP sunucusu üzerinden mesaj gönderir. Sunucu mesajı almış olabileceğinden, başarısız bir gönderim --retry ile tekrarlanmaz.
| Parametre | Değer | Varsayılan | Açıklama |
|---|---|---|---|
--smtp zorunlu | metin | SMTP sunucusu, ör. smtp.gmail.com veya smtp.office365.com | |
--port zorunlu | sayı | 587 (STARTTLS, olağan), 465 (TLS) veya 25 (iç aktarıcılar) | |
--vault | metin | Posta hesabını tutan kasa (Kasalar sayfası); --credential bu durumda içindeki kimlik bilgisinin adıdır | |
--credential | herhangi bir değer | Posta hesabı: --vault içindeki bir kimlik bilgisinin adı (Kasalar sayfasında tutulan kullanıcı adı ve parolası) veya bir kimlik bilgisi değişkeni ($cred$). Gmail, Outlook.com ve Yahoo uygulama şifresi ister; --authtype:oauth2 ile kimlik bilgisi uygulama kaydıdır (client id / client secret). Oturum açmadan posta kabul eden bir aktarıcı için boş bırakın | |
--from zorunlu | metin | Gönderen adresi, ör. bot@company.com veya "Robot <bot@company.com>" | |
--to zorunlu | metin | Alıcılar, , veya ; ile ayrılmış | |
--cc | metin | Bilgi (CC) alıcıları, , veya ; ile ayrılmış | |
--bcc | metin | Gizli bilgi (BCC) alıcıları, , veya ; ile ayrılmış | |
--replyto | metin | Gönderen değilse, yanıtların gideceği adres | |
--subject zorunlu | metin | ||
--body zorunlu | metin | ||
--bodytype | şunlardan biri: text, html | text | |
--attachment | metin | Dosya yolları, , veya ; ile ayrılmış Ajan makinesindeki bir dosya. | |
--priority | şunlardan biri: low, normal, high | normal | Posta programlarında gösterilen önem derecesi |
--security | şunlardan biri: auto, ssl, starttls, none | auto | auto: 465/993 portlarında TLS, diğer portlarda sunucu sunuyorsa STARTTLS (parola asla şifrelenmeden gönderilmez); ssl: baştan TLS; starttls: TLS'ye geçmek zorunludur; none: şifresiz (yalnızca iç sunucular) |
--ssl | true / false | --security parametresinin eski biçimi: false = none, true = TLS veya STARTTLS (ikisi de ayarlıysa --security geçerlidir) | |
--timeout | sayı | 60 | Vazgeçmeden önce posta sunucusunun bekleneceği saniye |
--ignoresslerrors | true / false | false | Her sunucu sertifikasını kabul et (kendinden imzalı sertifikalı iç sunucular); genel sunucular için false bırakın |
--authtype | şunlardan biri: password, oauth2, none | password: kimlik bilgisiyle oturum açar; none: oturum açmadan gönderir (aktarıcılar); oauth2: parolayla oturum açmanın kapalı olduğu posta kutuları için uygulama kaydıyla Microsoft 365 oturum açma (IMAP.AccessAsApp / SMTP.SendAsApp). Ayarlanmazsa: --credential ayarlıysa password, değilse none | |
--tenant | metin | oauth2: Microsoft 365 dizini, ör. contoso.onmicrosoft.com veya kimliği | |
--mailbox | metin | oauth2: posta kutusu kullanılan adres (send: boşsa --from adresi) |
--action:read
Bir klasörün mesajları, en yeni önce, kayıt listesi olarak (Id, From, FromName, To, Cc, Subject, Date, Body, HtmlBody, IsRead, Attachments).
| Parametre | Değer | Varsayılan | Açıklama |
|---|---|---|---|
--server zorunlu | metin | IMAP sunucusu, ör. imap.gmail.com veya outlook.office365.com | |
--port | sayı | 993 | TLS için 993 (olağan), STARTTLS veya şifresiz için 143 |
--vault | metin | Posta hesabını tutan kasa (Kasalar sayfası); --credential bu durumda içindeki kimlik bilgisinin adıdır | |
--credential zorunlu | herhangi bir değer | Posta hesabı: --vault içindeki bir kimlik bilgisinin adı (Kasalar sayfasında tutulan kullanıcı adı ve parolası) veya bir kimlik bilgisi değişkeni ($cred$). Gmail, Outlook.com ve Yahoo uygulama şifresi ister; --authtype:oauth2 ile kimlik bilgisi uygulama kaydıdır (client id / client secret) | |
--security | şunlardan biri: auto, ssl, starttls, none | auto | auto: 465/993 portlarında TLS, diğer portlarda sunucu sunuyorsa STARTTLS (parola asla şifrelenmeden gönderilmez); ssl: baştan TLS; starttls: TLS'ye geçmek zorunludur; none: şifresiz (yalnızca iç sunucular) |
--ssl | true / false | --security parametresinin eski biçimi: false = none, true = TLS veya STARTTLS (ikisi de ayarlıysa --security geçerlidir) | |
--timeout | sayı | 60 | Vazgeçmeden önce posta sunucusunun bekleneceği saniye |
--ignoresslerrors | true / false | false | Her sunucu sertifikasını kabul et (kendinden imzalı sertifikalı iç sunucular); genel sunucular için false bırakın |
--authtype | şunlardan biri: password, oauth2 | password | oauth2: parolayla oturum açmanın kapalı olduğu posta kutuları için uygulama kaydıyla Microsoft 365 oturum açma (IMAP.AccessAsApp / SMTP.SendAsApp) |
--tenant | metin | oauth2: Microsoft 365 dizini, ör. contoso.onmicrosoft.com veya kimliği | |
--mailbox | metin | oauth2: posta kutusu kullanılan adres (send: boşsa --from adresi) | |
--folder | metin | INBOX | Posta klasörü, ör. INBOX veya Processed (mail --action:folders bunları listeler) |
--unread | true / false | true | Yalnızca okunmamış mesajlar |
--from | metin | Yalnızca göndereni bunu içeren mesajlar | |
--to | metin | Yalnızca alıcıları bunu içeren mesajlar | |
--subject | metin | Yalnızca konusu bunu içeren mesajlar | |
--body | metin | Yalnızca metni bunu içeren mesajlar | |
--since | herhangi bir değer | Yalnızca bu tarihte veya sonrasında alınan mesajlar | |
--before | herhangi bir değer | Yalnızca bu tarihten önce alınan mesajlar | |
--hasattachments | true / false | true: yalnızca ekli mesajlar; false: yalnızca eksiz mesajlar | |
--max | sayı | 50 | En fazla bu kadar mesaj |
--markread | true / false | false | Döndürülen mesajları okundu olarak işaretle |
--output zorunlu | değişken adı | Sonucu alan değişken |
--action:count
Bir klasördeki, read ile aynı filtrelere uyan mesajların sayısı (varsayılan: okunmamış olanlar).
| Parametre | Değer | Varsayılan | Açıklama |
|---|---|---|---|
--server zorunlu | metin | IMAP sunucusu, ör. imap.gmail.com veya outlook.office365.com | |
--port | sayı | 993 | TLS için 993 (olağan), STARTTLS veya şifresiz için 143 |
--vault | metin | Posta hesabını tutan kasa (Kasalar sayfası); --credential bu durumda içindeki kimlik bilgisinin adıdır | |
--credential zorunlu | herhangi bir değer | Posta hesabı: --vault içindeki bir kimlik bilgisinin adı (Kasalar sayfasında tutulan kullanıcı adı ve parolası) veya bir kimlik bilgisi değişkeni ($cred$). Gmail, Outlook.com ve Yahoo uygulama şifresi ister; --authtype:oauth2 ile kimlik bilgisi uygulama kaydıdır (client id / client secret) | |
--security | şunlardan biri: auto, ssl, starttls, none | auto | auto: 465/993 portlarında TLS, diğer portlarda sunucu sunuyorsa STARTTLS (parola asla şifrelenmeden gönderilmez); ssl: baştan TLS; starttls: TLS'ye geçmek zorunludur; none: şifresiz (yalnızca iç sunucular) |
--ssl | true / false | --security parametresinin eski biçimi: false = none, true = TLS veya STARTTLS (ikisi de ayarlıysa --security geçerlidir) | |
--timeout | sayı | 60 | Vazgeçmeden önce posta sunucusunun bekleneceği saniye |
--ignoresslerrors | true / false | false | Her sunucu sertifikasını kabul et (kendinden imzalı sertifikalı iç sunucular); genel sunucular için false bırakın |
--authtype | şunlardan biri: password, oauth2 | password | oauth2: parolayla oturum açmanın kapalı olduğu posta kutuları için uygulama kaydıyla Microsoft 365 oturum açma (IMAP.AccessAsApp / SMTP.SendAsApp) |
--tenant | metin | oauth2: Microsoft 365 dizini, ör. contoso.onmicrosoft.com veya kimliği | |
--mailbox | metin | oauth2: posta kutusu kullanılan adres (send: boşsa --from adresi) | |
--folder | metin | INBOX | Posta klasörü, ör. INBOX veya Processed (mail --action:folders bunları listeler) |
--unread | true / false | true | Yalnızca okunmamış mesajlar |
--from | metin | Yalnızca göndereni bunu içeren mesajlar | |
--to | metin | Yalnızca alıcıları bunu içeren mesajlar | |
--subject | metin | Yalnızca konusu bunu içeren mesajlar | |
--body | metin | Yalnızca metni bunu içeren mesajlar | |
--since | herhangi bir değer | Yalnızca bu tarihte veya sonrasında alınan mesajlar | |
--before | herhangi bir değer | Yalnızca bu tarihten önce alınan mesajlar | |
--hasattachments | true / false | true: yalnızca ekli mesajlar; false: yalnızca eksiz mesajlar | |
--output zorunlu | değişken adı | Sonucu alan değişken |
--action:folders
Hesabın posta klasörlerinin tam adları (ör. INBOX, Archive/2024), liste olarak.
| Parametre | Değer | Varsayılan | Açıklama |
|---|---|---|---|
--server zorunlu | metin | IMAP sunucusu, ör. imap.gmail.com veya outlook.office365.com | |
--port | sayı | 993 | TLS için 993 (olağan), STARTTLS veya şifresiz için 143 |
--vault | metin | Posta hesabını tutan kasa (Kasalar sayfası); --credential bu durumda içindeki kimlik bilgisinin adıdır | |
--credential zorunlu | herhangi bir değer | Posta hesabı: --vault içindeki bir kimlik bilgisinin adı (Kasalar sayfasında tutulan kullanıcı adı ve parolası) veya bir kimlik bilgisi değişkeni ($cred$). Gmail, Outlook.com ve Yahoo uygulama şifresi ister; --authtype:oauth2 ile kimlik bilgisi uygulama kaydıdır (client id / client secret) | |
--security | şunlardan biri: auto, ssl, starttls, none | auto | auto: 465/993 portlarında TLS, diğer portlarda sunucu sunuyorsa STARTTLS (parola asla şifrelenmeden gönderilmez); ssl: baştan TLS; starttls: TLS'ye geçmek zorunludur; none: şifresiz (yalnızca iç sunucular) |
--ssl | true / false | --security parametresinin eski biçimi: false = none, true = TLS veya STARTTLS (ikisi de ayarlıysa --security geçerlidir) | |
--timeout | sayı | 60 | Vazgeçmeden önce posta sunucusunun bekleneceği saniye |
--ignoresslerrors | true / false | false | Her sunucu sertifikasını kabul et (kendinden imzalı sertifikalı iç sunucular); genel sunucular için false bırakın |
--authtype | şunlardan biri: password, oauth2 | password | oauth2: parolayla oturum açmanın kapalı olduğu posta kutuları için uygulama kaydıyla Microsoft 365 oturum açma (IMAP.AccessAsApp / SMTP.SendAsApp) |
--tenant | metin | oauth2: Microsoft 365 dizini, ör. contoso.onmicrosoft.com veya kimliği | |
--mailbox | metin | oauth2: posta kutusu kullanılan adres (send: boşsa --from adresi) | |
--output zorunlu | değişken adı | Sonucu alan değişken |
--action:saveattachments
Bir mesajın eklerini bir klasöre kaydeder; --output dosya listesini alır.
| Parametre | Değer | Varsayılan | Açıklama |
|---|---|---|---|
--server zorunlu | metin | IMAP sunucusu, ör. imap.gmail.com veya outlook.office365.com | |
--port | sayı | 993 | TLS için 993 (olağan), STARTTLS veya şifresiz için 143 |
--vault | metin | Posta hesabını tutan kasa (Kasalar sayfası); --credential bu durumda içindeki kimlik bilgisinin adıdır | |
--credential zorunlu | herhangi bir değer | Posta hesabı: --vault içindeki bir kimlik bilgisinin adı (Kasalar sayfasında tutulan kullanıcı adı ve parolası) veya bir kimlik bilgisi değişkeni ($cred$). Gmail, Outlook.com ve Yahoo uygulama şifresi ister; --authtype:oauth2 ile kimlik bilgisi uygulama kaydıdır (client id / client secret) | |
--security | şunlardan biri: auto, ssl, starttls, none | auto | auto: 465/993 portlarında TLS, diğer portlarda sunucu sunuyorsa STARTTLS (parola asla şifrelenmeden gönderilmez); ssl: baştan TLS; starttls: TLS'ye geçmek zorunludur; none: şifresiz (yalnızca iç sunucular) |
--ssl | true / false | --security parametresinin eski biçimi: false = none, true = TLS veya STARTTLS (ikisi de ayarlıysa --security geçerlidir) | |
--timeout | sayı | 60 | Vazgeçmeden önce posta sunucusunun bekleneceği saniye |
--ignoresslerrors | true / false | false | Her sunucu sertifikasını kabul et (kendinden imzalı sertifikalı iç sunucular); genel sunucular için false bırakın |
--authtype | şunlardan biri: password, oauth2 | password | oauth2: parolayla oturum açmanın kapalı olduğu posta kutuları için uygulama kaydıyla Microsoft 365 oturum açma (IMAP.AccessAsApp / SMTP.SendAsApp) |
--tenant | metin | oauth2: Microsoft 365 dizini, ör. contoso.onmicrosoft.com veya kimliği | |
--mailbox | metin | oauth2: posta kutusu kullanılan adres (send: boşsa --from adresi) | |
--folder | metin | INBOX | Posta klasörü, ör. INBOX veya Processed (mail --action:folders bunları listeler) |
--id zorunlu | herhangi bir değer | mail read ile alınan bir mesajın kimliği, ör. $message.Id$ (okunduğu klasörde geçerlidir) | |
--destination zorunlu | metin | Dosyalar için klasör (mevcut dosyalar korunur; ada bir numara eklenir) Ajan makinesindeki bir klasör. | |
--filter | metin | * | Dosya adı deseni, ör. *.pdf |
--output | değişken adı | Sonucu alan değişken |
--action:move
| Parametre | Değer | Varsayılan | Açıklama |
|---|---|---|---|
--server zorunlu | metin | IMAP sunucusu, ör. imap.gmail.com veya outlook.office365.com | |
--port | sayı | 993 | TLS için 993 (olağan), STARTTLS veya şifresiz için 143 |
--vault | metin | Posta hesabını tutan kasa (Kasalar sayfası); --credential bu durumda içindeki kimlik bilgisinin adıdır | |
--credential zorunlu | herhangi bir değer | Posta hesabı: --vault içindeki bir kimlik bilgisinin adı (Kasalar sayfasında tutulan kullanıcı adı ve parolası) veya bir kimlik bilgisi değişkeni ($cred$). Gmail, Outlook.com ve Yahoo uygulama şifresi ister; --authtype:oauth2 ile kimlik bilgisi uygulama kaydıdır (client id / client secret) | |
--security | şunlardan biri: auto, ssl, starttls, none | auto | auto: 465/993 portlarında TLS, diğer portlarda sunucu sunuyorsa STARTTLS (parola asla şifrelenmeden gönderilmez); ssl: baştan TLS; starttls: TLS'ye geçmek zorunludur; none: şifresiz (yalnızca iç sunucular) |
--ssl | true / false | --security parametresinin eski biçimi: false = none, true = TLS veya STARTTLS (ikisi de ayarlıysa --security geçerlidir) | |
--timeout | sayı | 60 | Vazgeçmeden önce posta sunucusunun bekleneceği saniye |
--ignoresslerrors | true / false | false | Her sunucu sertifikasını kabul et (kendinden imzalı sertifikalı iç sunucular); genel sunucular için false bırakın |
--authtype | şunlardan biri: password, oauth2 | password | oauth2: parolayla oturum açmanın kapalı olduğu posta kutuları için uygulama kaydıyla Microsoft 365 oturum açma (IMAP.AccessAsApp / SMTP.SendAsApp) |
--tenant | metin | oauth2: Microsoft 365 dizini, ör. contoso.onmicrosoft.com veya kimliği | |
--mailbox | metin | oauth2: posta kutusu kullanılan adres (send: boşsa --from adresi) | |
--folder | metin | INBOX | Posta klasörü, ör. INBOX veya Processed (mail --action:folders bunları listeler) |
--id zorunlu | herhangi bir değer | mail read ile alınan bir mesajın kimliği, ör. $message.Id$ (okunduğu klasörde geçerlidir) | |
--target zorunlu | metin | Mesajın taşınacağı posta klasörü, ör. Processed |
--action:delete
| Parametre | Değer | Varsayılan | Açıklama |
|---|---|---|---|
--server zorunlu | metin | IMAP sunucusu, ör. imap.gmail.com veya outlook.office365.com | |
--port | sayı | 993 | TLS için 993 (olağan), STARTTLS veya şifresiz için 143 |
--vault | metin | Posta hesabını tutan kasa (Kasalar sayfası); --credential bu durumda içindeki kimlik bilgisinin adıdır | |
--credential zorunlu | herhangi bir değer | Posta hesabı: --vault içindeki bir kimlik bilgisinin adı (Kasalar sayfasında tutulan kullanıcı adı ve parolası) veya bir kimlik bilgisi değişkeni ($cred$). Gmail, Outlook.com ve Yahoo uygulama şifresi ister; --authtype:oauth2 ile kimlik bilgisi uygulama kaydıdır (client id / client secret) | |
--security | şunlardan biri: auto, ssl, starttls, none | auto | auto: 465/993 portlarında TLS, diğer portlarda sunucu sunuyorsa STARTTLS (parola asla şifrelenmeden gönderilmez); ssl: baştan TLS; starttls: TLS'ye geçmek zorunludur; none: şifresiz (yalnızca iç sunucular) |
--ssl | true / false | --security parametresinin eski biçimi: false = none, true = TLS veya STARTTLS (ikisi de ayarlıysa --security geçerlidir) | |
--timeout | sayı | 60 | Vazgeçmeden önce posta sunucusunun bekleneceği saniye |
--ignoresslerrors | true / false | false | Her sunucu sertifikasını kabul et (kendinden imzalı sertifikalı iç sunucular); genel sunucular için false bırakın |
--authtype | şunlardan biri: password, oauth2 | password | oauth2: parolayla oturum açmanın kapalı olduğu posta kutuları için uygulama kaydıyla Microsoft 365 oturum açma (IMAP.AccessAsApp / SMTP.SendAsApp) |
--tenant | metin | oauth2: Microsoft 365 dizini, ör. contoso.onmicrosoft.com veya kimliği | |
--mailbox | metin | oauth2: posta kutusu kullanılan adres (send: boşsa --from adresi) | |
--folder | metin | INBOX | Posta klasörü, ör. INBOX veya Processed (mail --action:folders bunları listeler) |
--id zorunlu | herhangi bir değer | mail read ile alınan bir mesajın kimliği, ör. $message.Id$ (okunduğu klasörde geçerlidir) |
--action:markread
| Parametre | Değer | Varsayılan | Açıklama |
|---|---|---|---|
--server zorunlu | metin | IMAP sunucusu, ör. imap.gmail.com veya outlook.office365.com | |
--port | sayı | 993 | TLS için 993 (olağan), STARTTLS veya şifresiz için 143 |
--vault | metin | Posta hesabını tutan kasa (Kasalar sayfası); --credential bu durumda içindeki kimlik bilgisinin adıdır | |
--credential zorunlu | herhangi bir değer | Posta hesabı: --vault içindeki bir kimlik bilgisinin adı (Kasalar sayfasında tutulan kullanıcı adı ve parolası) veya bir kimlik bilgisi değişkeni ($cred$). Gmail, Outlook.com ve Yahoo uygulama şifresi ister; --authtype:oauth2 ile kimlik bilgisi uygulama kaydıdır (client id / client secret) | |
--security | şunlardan biri: auto, ssl, starttls, none | auto | auto: 465/993 portlarında TLS, diğer portlarda sunucu sunuyorsa STARTTLS (parola asla şifrelenmeden gönderilmez); ssl: baştan TLS; starttls: TLS'ye geçmek zorunludur; none: şifresiz (yalnızca iç sunucular) |
--ssl | true / false | --security parametresinin eski biçimi: false = none, true = TLS veya STARTTLS (ikisi de ayarlıysa --security geçerlidir) | |
--timeout | sayı | 60 | Vazgeçmeden önce posta sunucusunun bekleneceği saniye |
--ignoresslerrors | true / false | false | Her sunucu sertifikasını kabul et (kendinden imzalı sertifikalı iç sunucular); genel sunucular için false bırakın |
--authtype | şunlardan biri: password, oauth2 | password | oauth2: parolayla oturum açmanın kapalı olduğu posta kutuları için uygulama kaydıyla Microsoft 365 oturum açma (IMAP.AccessAsApp / SMTP.SendAsApp) |
--tenant | metin | oauth2: Microsoft 365 dizini, ör. contoso.onmicrosoft.com veya kimliği | |
--mailbox | metin | oauth2: posta kutusu kullanılan adres (send: boşsa --from adresi) | |
--folder | metin | INBOX | Posta klasörü, ör. INBOX veya Processed (mail --action:folders bunları listeler) |
--id zorunlu | herhangi bir değer | mail read ile alınan bir mesajın kimliği, ör. $message.Id$ (okunduğu klasörde geçerlidir) | |
--read | true / false | true | false mesajı okunmadı olarak işaretler |
Örnekler
mail --action:send --smtp:"smtp.gmail.com" --port:587 --vault:"Mail" --credential:"Robot mailbox" --from:"bot@company.com" --to:"admin@company.com" --cc:"manager@company.com" --subject:"RPA Report" --body:$reportContent$ --bodytype:html --attachment:"C:\report.pdf"
mail --action:send --smtp:"relay.company.local" --port:25 --authtype:none --from:"bot@company.com" --to:"team@company.com; boss@company.com" --replyto:"help@company.com" --priority:high --subject:"Done" --body:"All invoices are booked"
mail --action:read --server:"imap.gmail.com" --vault:"Mail" --credential:"Robot mailbox" --subject:"Invoice" --since:$yesterday$ --hasattachments:true --max:20 --output:messages
mail --action:count --server:"imap.gmail.com" --vault:"Mail" --credential:"Robot mailbox" --output:unreadCount
mail --action:folders --server:"imap.gmail.com" --vault:"Mail" --credential:"Robot mailbox" --output:folders
mail --action:saveattachments --server:"imap.gmail.com" --credential:$mailCred$ --id:$message.Id$ --destination:"C:\Inbox" --filter:"*.pdf" --output:files
mail --action:move --server:"imap.gmail.com" --credential:$mailCred$ --id:$message.Id$ --target:"Processed"
mail --action:markread --server:"imap.gmail.com" --credential:$mailCred$ --id:$message.Id$
mail --action:delete --server:"imap.gmail.com" --credential:$mailCred$ --id:$message.Id$
restapi REST API
Bir HTTP isteği yapar; yanıt bir kayıt değişkeni olarak saklanır.
Tüm türlerde geçerli parametreler
| Parametre | Değer | Varsayılan | Açıklama |
|---|---|---|---|
--url zorunlu | metin | ||
--query | metin | Virgülle ayrılmış name=value çiftleri olarak sorgu dizesi, ör. page=1,search=$term$ (sizin için URL kodlaması yapılır) | |
--headers | metin | Virgülle ayrılmış Key=Value çiftleri | |
--body | herhangi bir değer | ||
--bodytype | şunlardan biri: json, xml, text, formdata, urlencoded | json | |
--file | metin | Yüklenecek dosya (formdata) Ajan makinesindeki bir dosya. | |
--saveto | metin | İndirme: yanıtı okumak yerine bu dosyaya kaydet (kayıtta bu durumda File bulunur; hata yanıtı Body içinde kalır) Ajan makinesindeki bir dosya. | |
--credential | $değişken$ | ||
--authtype | şunlardan biri: basic, bearer, apikey | ||
--apikey | metin | X-API-Key | API anahtarı başlık adı |
--output | değişken adı | Sonucu alan değişken | |
--timeout | sayı | 30 | Saniye cinsinden zaman aşımı |
--retry | sayı | Yeniden deneme sayısı. Belirtilmezse ekran ve dosya komutları geçici bir sorundan (hâlâ yüklenen bir sayfa, örtülü bir öğe, kilitli bir dosya) sonra bir kez daha dener; 0 bunu kapatır | |
--retryinterval | sayı | 1 | Yeniden denemeler arasındaki saniye |
--followredirects | true / false | true | |
--ignoresslerrors | true / false | false |
İşlemler (--action)
--action:get
Başka parametre yok.
--action:post
Başka parametre yok.
--action:put
Başka parametre yok.
--action:delete
Başka parametre yok.
--action:patch
Başka parametre yok.
--action:head
Başka parametre yok.
--action:options
Başka parametre yok.
Örnekler
restapi --action:get --url:"https://api.example.com/orders" --query:"status=open,page=1" --output:response
json --action:getvalue --source:$response.Json$ --path:"data.orders[0].customer.name" --output:name
json --action:getvalue --source:$response.Json$ --path:"data.total" --default:0 --output:total
json --action:count --source:$response.Json$ --path:"data.orders" --output:orderCount
json --action:todatatable --source:$response.Json$ --path:"data.orders" --output:orders
json --action:parse --text:$response.Body$ --output:doc
json --action:readfile --file:"C:\config.json" --output:config
json --action:setvalue --name:request --path:"customer.id" --value:42
json --action:setvalue --name:request --path:"items[0].sku" --value:"A-1"
json --action:remove --name:request --path:"draft"
json --action:stringify --source:$request$ --output:body
json --action:writefile --source:$request$ --file:"C:\out\request.json"
json --action:keys --source:$config$ --output:names
restapi --action:get --url:"https://api.example.com/users" --headers:"Content-Type=application/json,Authorization=Bearer $token$" --output:response
restapi --action:post --url:"https://api.example.com/users" --headers:"Content-Type=application/json" --body:$jsonBody$ --output:response
restapi --action:put --url:"https://api.example.com/users/1" --headers:"Content-Type=application/json" --body:$updateData$ --output:response
restapi --action:delete --url:"https://api.example.com/users/1" --headers:"Authorization=Bearer $token$" --output:response
restapi --action:patch --url:"https://api.example.com/users/1" --headers:"Content-Type=application/json" --body:$patchData$ --output:response
restapi --action:post --url:"https://api.example.com/upload" --bodytype:formdata --file:"C:\report.pdf" --output:response
restapi --action:post --url:"https://secure-api.com/data" --credential:$apiCred$ --authtype:basic --body:$payload$ --output:response