API:Emailuser/ja

MediaWiki 操作 API
基本 クエリの下位モジュール群 ページ属性を取得 条件に合致するページの列挙 変数の情報を取得 ウィキと利用者のメタ情報を取得 認証 データ変更を伴う操作用のトークンの取得 ログイン ログアウト 利用者とアカウント アカウントを作成 利用者のブロックとブロック解除 Get info about the current user 現在の利用者のウォッチリストをフィードとして取得 利用者オプションを変更 利用者の所属グループの変更 メールの送信 ページのオペレーション ページ内容の構文解析 ページの作成/編集 ファイルのアップロード ページの取り込み ページの削除 ページのウォッチ/ウォッチ解除 ページのキャッシュの破棄 ページの巻き戻し ページの移動 ページや更新の巡回 削除されたページの版の復元 ページの保護レベルの変更 ページ言語の変更 その他... 検索 記事や文の検索 結果を OpenSearch 形式で取得 周辺に関連するウィキを検索 言語を検索 ページ名の前方一致検索 開発者向けユーティリティ ライブラリにアクセス クロスサイト リクエスト 拡張機能内での API モジュールの作成 MediaWiki および拡張機能内での API の使用 API の使用の制限 地域化 Implementation Strategy チュートリアル 操作 API のチュートリアル Article ideas generator Nearby places viewer Picture of the day viewer

Emailuser
Email a user. このモジュールは Generator としては使用できません。
接頭辞	なし
必要な権限	sendemail
POST のみ?	はい
自動生成ヘルプ	現行バージョン
追加されたバージョン	≧ 1.13

トークン

メールを送信するにはトークンが必要です。このトークンは編集のためのトークンと同一のもので、送信先に関わらず同じですが、ログインの度に変わります。電子メールトークンは action=tokens で type=email を指定する(MW 1.20+), または以下の方法で取得できます:

Obtaining an email token

api.php?action=query&meta=tokens [ApiSandbox で試用する]

利用者へのメールの送信

メールアドレスを認証した利用者に action=emailuser でメールを送信することができます。Sending email is subject to rate limits.

パラメーター

• target: メールの宛先の利用者
• subject: メッセージの件名
• text: メッセージ
• token: 以前のリクエストで取得したトークン。必ず + を %2B にエンコードしてください。
• ccme: 設定すると、メールのコピーをあなたにお送りします

例

注記: 簡潔性のためにこの例ではすべてのパラメーターをGETリクエストで渡していますが, action=emailuser はPOSTリクエストを必要とします; GETリクエストだとエラーが発生します。

Sending an email to User:Catrope

api.php?action=emailuser&target=Catrope&subject=Hi&text=Just%20wanted%20to%20say%20hi&token=58b54e0bab4a1d3fd3f7653af38e75cb+\ [ApiSandbox で試用する]

起こりうるエラー

In addition to the usual stuff:

Code	Info
cantsend	You are not logged in, you do not have a confirmed email address, or you are not allowed to send email to other users, so you cannot send email.
blockedfrommail	You have been blocked from sending email.
usermaildisabled	User email has been disabled
notarget	You have not specified a valid target for this action.
noemail	この利用者は有効なメールアドレスを登録していません。 この利用者は他の利用者からメールを受け取らない設定にしています。

Checking emailable status

Before trying to send an email, it is recommended to check if the user is emailable first. To do this, you can execute a list query on the user (or several users at once). Here is an example using Ajax:

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' );
} );

If you are testing from a client-side script, it is also possible to simply check for the existence of the t-emailuser list item:

emailable = $( '#t-emailuser' ).length ? true : false;

---

action=emailuser

(main | 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.

• https://www.mediawiki.org/wiki/Special:MyLanguage/API:Email

Parameters:

target

User to send email to.

This parameter is required.

subject

Subject header.

text

Mail 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.

Example:

Send an email to user WikiSysop with the text Content.

api.php?action=emailuser&target=WikiSysop&text=Content&token=123ABC [open in sandbox]