Class: MediaWiktory::Wikipedia::Actions::Emailuser

Inherits:
Post
  • Object
show all
Defined in:
lib/mediawiktory/wikipedia/actions/emailuser.rb

Overview

Email a user.

Usage:

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 Response for working with action responses.

All action's parameters are documented as its public methods, see below.

Instance Method Summary collapse

Methods inherited from Post

#perform

Methods inherited from Base

#inspect, #merge, #name, #perform, #response, #to_h, #to_param, #to_url

Methods included from GlobalParams

#assert, #assertuser, #centralauthtoken, #curtimestamp, #errorformat, #errorlang, #errorsuselocal, #format, #maxage, #maxlag, #origin, #requestid, #responselanginfo, #servedby, #smaxage, #uselang

Instance Method Details

#ccme ⇒ self

Send a copy of this mail to me.

Returns:

  • (self) 


49
50
51
 
# File 'lib/mediawiktory/wikipedia/actions/emailuser.rb', line 49

def ccme()
  merge(ccme: 'true')
end

#subject(value) ⇒ self

Subject header.

Parameters:

  • value (String)

Returns:

  • (self) 


34
35
36
 
# File 'lib/mediawiktory/wikipedia/actions/emailuser.rb', line 34

def subject(value)
  merge(subject: value.to_s)
end

#target(value) ⇒ self

User to send email to.

Parameters:

  • value (String)

Returns:

  • (self) 


26
27
28
 
# File 'lib/mediawiktory/wikipedia/actions/emailuser.rb', line 26

def target(value)
  merge(target: value.to_s)
end

#text(value) ⇒ self

Mail body.

Parameters:

  • value (String)

Returns:

  • (self) 


42
43
44
 
# File 'lib/mediawiktory/wikipedia/actions/emailuser.rb', line 42

def text(value)
  merge(text: value.to_s)
end

#token(value) ⇒ self

A "csrf" token retrieved from action=query&meta=tokens

Parameters:

  • value (String)

Returns:

  • (self) 


57
58
59
 
# File 'lib/mediawiktory/wikipedia/actions/emailuser.rb', line 57

def token(value)
  merge(token: value.to_s)
end