MailRuClient ClassNemiro.OAuth
OAuth client for Mail.Ru.
Inheritance Hierarchy

System Object
  Nemiro.OAuth OAuthBase
    Nemiro.OAuth OAuth2Client
      Nemiro.OAuth.Clients MailRuClient

Namespace: Nemiro.OAuth.Clients
Assembly: Nemiro.OAuth (in Nemiro.OAuth.dll) Version: 1.9.4.725 (1.9.4.725)
Syntax

public class MailRuClient : OAuth2Client

The MailRuClient type exposes the following members.

Constructors

  NameDescription
Public methodMailRuClient
Initializes a new instance of the MailRuClient.
Top
Methods

  NameDescription
Public methodClone 
Creates a shallow copy of the current object.
(Inherited from OAuthBase.)
Public methodClone(NameValueCollection, String)
Creates a shallow copy of the current object.
(Inherited from OAuthBase.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Protected methodGetAccessToken
Gets the access token from the remote server.
(Inherited from OAuth2Client.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetSpecifiedTokenOrCurrent
Returns the specified access token or the current access token.
(Inherited from OAuthBase.)
Public methodGetType (Inherited from Object.)
Public methodGetUserInfo Obsolete.
Gets the user details via API of the provider.
(Inherited from OAuthBase.)
Public methodGetUserInfo(AccessToken)
Gets the user details.
(Overrides OAuthBase GetUserInfo(AccessToken).)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodRedirectToAuthorization
Redirects a client to the Authorization URL.
(Inherited from OAuthBase.)
Public methodRefreshToken
Sends a request to refresh the access token.
(Overrides OAuth2Client RefreshToken(AccessToken).)
Public methodRevokeToken
Sends a request to revoke the access token.
(Inherited from OAuthBase.)
Public methodToString (Inherited from Object.)
Top
Properties

  NameDescription
Public propertyAccessToken
Gets or sets an access token.
(Inherited from OAuthBase.)
Protected propertyAccessTokenUrl
Gets or sets the address for the access token.
(Inherited from OAuthBase.)
Public propertyAccessTokenValue
Gets an access token value.
(Inherited from OAuthBase.)
Public propertyApplicationId
Gets or sets the application identifier.
(Inherited from OAuthBase.)
Public propertyApplicationSecret
Gets or sets the application secret key.
(Inherited from OAuthBase.)
Public propertyAuthorizationCode
Gets or sets access code for access token requests.
(Inherited from OAuthBase.)
Public propertyAuthorizationUrl
Gets the endpoint of the authorization.
(Inherited from OAuth2Client.)
Protected propertyAuthorizeUrl
Gets or sets the base address for login.
(Inherited from OAuthBase.)
Public propertyDefaultScope
The deault scope.
(Inherited from OAuth2Client.)
Public propertyGrantType
Gets or sets grant type.
(Inherited from OAuth2Client.)
Public propertyParameters
Gets or sets additional query parameters.
(Inherited from OAuthBase.)
Public propertyPassword
Gets or sets password if GrantType is password or client_credentials.
(Inherited from OAuth2Client.)
Public propertyProviderName
Unique provider name: Mail.Ru.
(Overrides OAuthBase ProviderName.)
Public propertyReturnUrl
Return URL.
(Overrides OAuthBase ReturnUrl.)
Public propertyScope
The scope of the access request.
(Inherited from OAuth2Client.)
Public propertyScopeSeparator
The separator in the scope list.
(Inherited from OAuth2Client.)
Public propertyState
Gets or sets unique request identifier. For clients the value sets is automatically.
(Inherited from OAuthBase.)
Public propertySupportRefreshToken
Gets or sets a value indicating whether the current client supports refreshing access token.
(Inherited from OAuthBase.)
Public propertySupportRevokeToken
Gets or sets a value indicating whether the current client supports revoking access token.
(Inherited from OAuthBase.)
Public propertyUsername
Gets or sets username if GrantType is password or client_credentials.
(Inherited from OAuth2Client.)
Public propertyVersion
Gets the version of the OAuth protocol.
(Inherited from OAuthBase.)
Top
Remarks

Mail.Ru is a popular email service, search engine, social network, photo & video hosting, blogs and another services in Russia and CIS.

Register and Configure a Mail.Ru Site

(!)Web Management Interface may change over time. Applications registration shown below may differ.
If the interface is changed, you need to register the application and get Client ID and Client Secret. For web projects, configure return URLs.
If you have any problems with this, please visit issues. If you do not find a solution to your problem, you can create a new question.

Unfortunately, the interface is only in Russian.

You must have a confirmed account in Mail.Ru.

Open Sites page and click Connect a New Site.

Create a New Site button

Accept the terms of the agreement.

Terms

Enter the site name, URL and click the Next button.

Site name and URL

Download the receiver.html file and place it in the root directory of your site.

This step can be skipped (Пропустить).

receiver.html file

The last step you will find the Client ID and Client Secret.

Use this for creating an instance of the MailRuClient.

Cleint ID and Client Secret

OAuthManager.RegisterClient
(
  new MailRuClient
  (
    "722701", 
    "d0622d3d9c9efc69e4ca42aa173b938a"
  )
);

For more details, please visit to the Mail.Ru API Documentation.

Examples

Windows Forms

The following example shows how to use the MailRuClient in desktop applications.

To test the example, create a new Windows Forms project with two forms. Add a Button to the Form1.

public Form1()
{
  InitializeComponent();
  button1.Click += new EventHandler(button1_Click);
}

private void Form1_Load(object sender, EventArgs e)
{
  // mail.ru client registration
  OAuthManager.RegisterClient
  (
    new MailRuClient
    (
      "722701", 
      "d0622d3d9c9efc69e4ca42aa173b938a"
    )
  );
}

private void button1_Click(object sender, EventArgs e)
{
  var frm = new Form2();
  frm.ShowDialog();
}

Add a WebBrowser to the Form2.

public Form2()
{
  InitializeComponent();
  webBrowser1.DocumentCompleted += new System.Windows.Forms.WebBrowserDocumentCompletedEventHandler(webBrowser1_DocumentCompleted);
  webBrowser1.Navigate(OAuthWeb.GetAuthorizationUrl("Mail.Ru"));
}

private void webBrowser1_DocumentCompleted(object sender, WebBrowserDocumentCompletedEventArgs e)
{
  // waiting for results 
  if (e.Url.Query.IndexOf("code=") != -1 || e.Url.Fragment.IndexOf("code=") != -1 || e.Url.Query.IndexOf("oauth_verifier=") != -1)
  {
    // is the result, verify 
    var result = OAuthWeb.VerifyAuthorization(e.Url.ToString());
    if (result.IsSuccessfully)
    {
      // show user info
      MessageBox.Show
      (
        String.Format
        (
          "User ID: {0}\r\nUsername: {1}\r\nDisplay Name: {2}\r\nE-Mail: {3}", 
          result.UserInfo.UserId,
          result.UserInfo.UserName,
          result.UserInfo.DisplayName ?? result.UserInfo.FullName,
          result.UserInfo.Email
        ), 
        "Successfully", 
        MessageBoxButtons.OK, 
        MessageBoxIcon.Information
      );
    }
    else
    {
      // show error message
      MessageBox.Show(result.ErrorInfo.Message, "Error", MessageBoxButtons.OK, MessageBoxIcon.Error);
    }
    this.Close();
  }
}

Result of the program is shown in the images below.

Log in with Mail.Ru

Mail.Ru User Info

ASP .NET MVC

The following example shows how to use the MailRuClient in ASP .NET MVC Application.

In the Application_Start event handler (Global.asax file) is registered the MailRuClient.

protected void Application_Start()
{
  OAuthManager.RegisterClient
  (
    new MailRuClient
    (
      "722701", 
      "d0622d3d9c9efc69e4ca42aa173b938a"
    )
  );
}

The MailRuLoginResult method will handle authorization result.

public ActionResult MailRuLoginResult()
{
  var result = OAuthWeb.VerifyAuthorization();
  if (result.IsSuccessfully)
  {
    var user = result.UserInfo;    
    // NOTE: For StringBuilder import the System.Text
    StringBuilder r = new StringBuilder();
    r.AppendFormat("User ID: {0}\r\n", user.UserId);
    r.AppendFormat("Name:    {0}\r\n", user.DisplayName);
    r.AppendFormat("Email:   {0}", user.Email);
    return new ContentResult { Content = r.ToString(), ContentType = "text/plain" }; 
  }

  return new ContentResult 
  { 
    Content = "Error: " + result.ErrorInfo.Message, 
    ContentType = "text/plain" 
  };
}

Add action method for redirection to the Mail.Ru.

public ActionResult MailRuLogin()
{
  string authUrl = OAuthWeb.GetAuthorizationUrl("Mail.Ru", Url.Action("MailRuLoginResult", "Home", null, null, Request.Url.Host));
  return Redirect(authUrl);
}

On a page add link to the MailRuLogin method.

@Html.ActionLink("Log in with Mail.Ru", "MailRuLogin")

NOTE: For proper processing, you will need to download and put on your site a receiver.html file.

See Also

Nemiro.OAuth.Clients MailRuClient