class MediaWiktory::Wikipedia::Actions::Emailuser
Email a user.
Usage:
“`ruby api.emailuser.target(value).perform # returns string with raw output # or api.emailuser.target(value).response # returns output parsed and wrapped into Response
object “`
See {Base} for generic explanation of working with MediaWiki actions and {MediaWiktory::Wikipedia::Response} for working with action responses.
All action's parameters are documented as its public methods, see below.
Public Instance Methods
ccme()
click to toggle source
Send a copy of this mail to me.
@return [self]
# File lib/mediawiktory/wikipedia/actions/emailuser.rb, line 49 def ccme() merge(ccme: 'true') end
subject(value)
click to toggle source
Subject header.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/actions/emailuser.rb, line 34 def subject(value) merge(subject: value.to_s) end
target(value)
click to toggle source
User to send email to.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/actions/emailuser.rb, line 26 def target(value) merge(target: value.to_s) end
text(value)
click to toggle source
Mail body.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/actions/emailuser.rb, line 42 def text(value) merge(text: value.to_s) end
token(value)
click to toggle source
A “csrf” token retrieved from action=query&meta=tokens
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/actions/emailuser.rb, line 57 def token(value) merge(token: value.to_s) end