API:Emailuser - MediaWiki (original) (raw)

	This page is part of the MediaWiki Action API documentation.

	The following documentation is the output of Special:ApiHelp/emailuser, automatically generated by the pre-release version of MediaWiki that is running on this site (MediaWiki.org).

(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

Specific parameters:

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.

To send an email, an email token is required. This token is equal to the edit token and the same for all recipients, but changes at every login. Email tokens can be obtained via action=query&meta=tokens , or by using the following method:

Obtaining an email token

Sending email to users

[edit]

You can send email to users who have a confirmed email address with action=emailuser. Sending email is subject to rate limits.

• target: User to send email to
• subject: The subject of the message
• text: The message
• token: The token obtained in the previous request. Take care to encode the + as %2B
• ccme: If set, a copy of the email will be sent to you

In this example, all parameters are passed in a GET request just for the sake of simplicity. However, action=emailuser requires POST requests; GET requests will cause an error.

#!/usr/bin/python3

""" send_email.py

MediaWiki API Demos
Demo of `Emailuser` module: sending POST request to send email to wiki user

Author: Jayprakash12345
MIT license

"""

import requests

S = requests.Session()

URL = "https://test.wikipedia.org/w/api.php"

Step 1: GET request to fetch login token

PARAMS_0 = { "action": "query", "meta": "tokens", "type": "login", "format": "json" }

R = S.get(url=URL, params=PARAMS_0) DATA = R.json()

LOGIN_TOKEN = DATA['query']['tokens']['logintoken']

Step 2: POST request to log in. Use of main account for login is not

supported. Obtain credentials via Special:BotPasswords

(https://www.mediawiki.org/wiki/Special:BotPasswords) for lgname & lgpassword

PARAMS_1 = { "action": "login", "lgname": "your_bot_username", "lgpassword": "your_bot_password", "lgtoken": LOGIN_TOKEN, "format": "json" }

R = S.post(URL, data=PARAMS_1)

Step 3: GET request to fetch Email token

PARAMS_2 = { "action": "query", "meta": "tokens", "format": "json" }

R = S.get(url=URL, params=PARAMS_2) DATA = R.json()

EMAIL_TOKEN = DATA['query']['tokens']['csrftoken']

Step 4: POST request to send an email

PARAMS_3 = { "action": "emailuser", "target": "Test", "subject": "Hi", "text": "Just wanted to say hi", "token": EMAIL_TOKEN, "format": "json" }

R = S.post(URL, data=PARAMS_3) DATA = R.text

print(DATA)