API:Emailuser
Bu sayfa MediaWiki Eylem API'si belgelerinin bir parçasıdır. |
Emailuser | ||
---|---|---|
Email a user. Bu modül jeneratör olarak kullanılamaz. | ||
Önek | hiçbiri | |
Gerekli haklar | sendemail | |
Sadece gönderme mi? | Evet | |
Oluşturulan yardım | Şimdiki | |
Sürüm eklendi |
|
Anahtar
Bir e-posta göndermek için bir e-posta anahtarı gereklidir. Bu anahtar, düzenleme anahtarını eşittir ve tüm alıcılar için aynıdır, ancak her girişte değişir. E-posta anahtarları action=query&meta=tokens üzerinden veya aşağıdaki yöntem kullanılarak elde edilebilir:
Sonuç |
---|
{
"batchcomplete": "",
"query": {
"tokens": {
"csrftoken": "7773cbfff263682c97ffc74b8672cbf25a5e0045+\\"
}
}
}
|
kullanıcılara eposta gönderimi
action=emailuser ile onaylanmış bir e-posta adresi olan kullanıcılara e-posta gönderebilirsiniz. E-posta göndermek oran sınırlarına tabidir.
Parametreler
target
: Eposta gönderilecek kullanıcısubject
: Mesajın konusutext
: Mesajtoken
: Önceki istekte elde edilen anahtar.+
ile%2B
olarak kodlamaya özen gösterinccme
: Ayarlanırsa, e-postanın bir kopyası size gönderilecektir
Örnekler
Sonuç |
---|
<?xml version="1.0" encoding="utf-8"?>
<api>
<emailuser result="Success" />
</api>
|
Örnek kod
Olası hatalar
Olağan şeylere ek olarak:
Kod | Bilgi |
---|---|
cantsend | Giriş yapmadınız, onaylanmış bir e-posta adresiniz yok veya diğer kullanıcılara e-posta göndermenize izin verilmediğinden e-posta gönderemezsiniz. |
blockedfrommail | E-posta göndermeniz engellendi. |
usermaildisabled | Kullanıcı epostası pasifleştirildi |
notarget | ⧼apierror-notarget⧽ |
noemail | Bu kullanıcı geçerli bir e-posta adresi belirtmemiş. |
nowikiemail | Bu kullanıcı, diğer kullanıcılardan e-posta almamayı tercih etti. |
Eposta gönderebilme durumunu kontrol etmek
Bir e-posta göndermeye çalışmadan önce, kullanıcının e-posta ile gönderilebilir olup olmadığını kontrol etmeniz önerilir. Bunu yapmak için kullanıcı (veya aynı anda birkaç kullanıcı) üzerinde bir liste sorgusu yürütebilirsiniz. İşte Ajax kullanan bir örnek:
new mw.Api().get( {
action: 'query',
list: 'users',
ususers: mw.config.get( 'wgTitle' ),
usprop: 'emailable',
rawcontinue: ''
} ).done( function( getEmailable ) {
alert( ( getEmailable.query.users[ 0 ][ 'emailable' ] !== undefined ) ? 'emailable' : 'not emailable' );
} );
İstemci tarafı komut dosyasından test yapıyorsanız, t-emailuser liste öğesinin varlığını kontrol etmek de mümkündür:
emailable = $( '#t-emailuser' ).length ? true : false;
Aşağıdaki belgelendirme, bu sitede (MediaWiki.org) çalışan MediaWiki'nin sürüm öncesi sürümü tarafından otomatik olarak oluşturulan Special: |
action=emailuser
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0-or-later
Email a user.
- target
User to send the email to.
- This parameter is required.
- subject
Subject header.
- This parameter is required.
- text
Email body.
- This parameter is required.
- ccme
Send a copy of this mail to me.
- Type: boolean (details)
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- Send an email to the user WikiSysop with the text Content.
- api.php?action=emailuser&target=WikiSysop&text=Content&token=123ABC [open in sandbox]