diplodocus.org Git - nmh/blob - man/mhlogin.man

   1 .\"
   2 .\" %nmhwarning%
   3 .\"
   4 .TH SEND %manext1% "March 23, 2016" "%nmhversion%"
   5 .SH NAME
   6 mhlogin \- login to external (OAuth) services
   7 .SH SYNOPSIS
   8 .HP 5
   9 .na
  10 .B mhlogin
  11 .RB [ \-saslmech
  12 .IR mechanism ]
  13 .RB [ \-authservice
  14 .IR service ]
  15 .RB [ \-snoop ]
  16 .RB [ \-version ]
  17 .RB [ \-help ]
  18 .ad
  19 .SH DESCRIPTION
  20 .B Mhlogin
  21 currently only supports OAuth for Gmail.  Run
  22 .B mhlogin
  23 .B \-saslmech xoauth2
  24 .B \-authservice
  25 .I gmail
  26 and load the printed URL in your browser.  Login to a Gmail account, grant
  27 authorization, and copy and paste the code into the
  28 .B mhlogin
  29 prompt.  Be sure to use the same account with the
  30 .B -user
  31 switch to
  32 .BR send .
  33 .PP
  34 The
  35 .B \-snoop
  36 switch can be used to view the HTTP transaction.
  37 .PP
  38 All parameters configuring the service may be overridden by profile components,
  39 and even though only Gmail is supported out of the box, the user can define
  40 new services entirely in the profile.  Profile components are prefixed by
  41 .IR oauth-service- ,
  42 for example,
  43 .I oauth-gmail-credential-file
  44 which specifies where
  45 .B mhlogin
  46 should write credentials and where
  47 .B send
  48 should read them.
  49 .SH "PROFILE COMPONENTS"
  50 .fc ^ ~
  51 .nf
  52 .ta 2.4i
  53 .ta \w'ExtraBigProfileName          'u
  54 ^oauth-gmail-credential-file:~^oauth-gmail
  55 ^oauth-gmail-client_id:~^nmh project client_id
  56 ^oauth-gmail-client_secret:~^nmh project client_secret
  57 ^oauth-gmail-auth_endpoint:~^https://accounts.google.com/o/oauth2/auth
  58 ^oauth-gmail-redirect_uri:~^urn:ietf:wg:oauth:2.0:oob
  59 ^oauth-gmail-token_endpoint:~^https://accounts.google.com/o/oauth2/token
  60 ^oauth-gmail-scope:~^https://mail.google.com/
  61 .fi
  62 .SH "SEE ALSO"
  63 .IR send (1)