mapi/ReadmeMapi32.txt

   1 ReadmeMapi32.txt
   2 January 27, 2009
   3 University of Washington
   4
   5 NOTE: It is uncertain what remains to be done for pmapi to work with
   6 alpine.  This dll should work with a PC-Pine installation, but in
   7 the future will be made to work with Alpine.  Registry access and
   8 Unicode support will have to change for that to happen.
   9
  10                  pmapi32 for Alpine 2.11
  11
  12 This distribution comes with two other files, instmapi.exe and
  13 pmapi32.dll, for use with Aline.  It is recommended that these files
  14 be put in your pine directory (generally C:\Program Files\Alpine).
  15
  16 pmapi32.dll - a Simple MAPI dynamically linked library.  pmapi32.dll
  17 is used by other applications to access your inbox or send mail
  18 through Alpine.
  19
  20 instmapi.exe - installs mapi32.dll such that registry values are set
  21 according to the location of pmapi32.dll, and possibly copies
  22 pmapi32.dll to the system directory if it is run on older systems.  It
  23 will also offer to set Alpine as your default mailer and newsreader
  24 if it is not already set.  The "-silent" option has been added to
  25 assume that default mailer and newsreader should be set and also to
  26 suppress a "Successful Completion" alert. This program can be run
  27 repeatedly without side effects.
  28
  29 instmapi.exe must be run at least once in order for pmapi32.dll to be
  30 accessible to other applications.  As of Alpine 4.30, instmapi.exe
  31 may or may not need to be run in order for pmapi32.dll to work,
  32 depending on Windows/Internet Explorer/Microsoft Office versions. To
  33 manually set Alpine as your default mailer, you must open "Internet
  34 Options" in your Control Panel and select the "Programs" tab.  Under
  35 "E-mail", select Alpine.
  36
  37 Configuration:
  38 Currently there is only one configuration option that is specific to
  39 pmapi32.dll:
  40
  41 pmapi-send-behavior: With the ability to send messages without dialogs
  42 it was decided that the user might want to be prompted in this case.
  43 There are three possible values for this variable:
  44      always-prompt: Always prompt before sending.  This is the default
  45                     behavior unless set otherwise.
  46      always-send: Always send the message without prompting.
  47      never-send: Never send the message
  48
  49 pmapi-suppress-dialogs: MAPI Clients may tell pmapi32.dll that they
  50 would like some dialogs allowing the user to edit the message before
  51 sending.  Since Alpine is not yet designed to properly handle this
  52 (nor will it be unless there is sufficient demand for it), it may be
  53 desired to forego the Alpine interaction if the message contains
  54 enough information for it to be set.  Possible values are:
  55      no: Never suppress dialogs, this is the default behavior
  56      yes: Always try sending it as is.  You should be aware of the
  57           implications before setting this
  58      prompt: Prompt whether or not it should fire up PC-Pine to edit
  59              the message
  60
  61 pmapi-strict-no-dialog: Some MAPI clients will request pmapi32 not to
  62 display any dialogs, even when it is absolutely necessary that a
  63 dialog be displayed for the purpose of logging in.  By default,
  64 pmapi32 will just display the dialog, but this variable is available
  65 for those who require a strict adherence of this request. The two
  66 possible values for this variable are:
  67      no: Show login dialogs when necessary, which is the default
  68          behavior
  69      yes: Suppress dialogs when it is requested by the client. It
  70           should generally be safe to set this, as it more accurately
  71           reflects the specification, but it is possible that setting
  72           this will hide necessary authentication prompts.
  73
  74
  75 To change the default setting of these variables, you will need to
  76 either hand edit the pinerc or set a value in the Windows registry.
  77 The pinerc setting always takes precedence over the registry setting.
  78 An example of setting the value pmapi-send-behavior to "always-send"
  79 in the pinerc would be to add the line:
  80 pmapi-send-behavior=always-send
  81 To add it to the registry, you would need to make sure the following
  82 key exists (from the regedit program):
  83   HKEY_CURRENT_USER\Software\University of Washington\PC-Pine\4.0\PmapiOpts
  84 Then, you would add a string named "pmapi-send-behavior" with the
  85 value of "always-send"
  86
  87 Environment Variables:
  88 Some sites may take advantage of environment variables in their
  89 configurations, setting them via some program that gets executed
  90 before running PC-Pine.  There is a way to mimmick this behavior in
  91 MAPI.  First you would need to create the following key:
  92   HKEY_CURRENT_USER\Software\University of Washington\Alpine\1.0\PmapiOpts\Env
  93 Say there is a variable that contains the string "${LOGNAME}".  To set
  94 this for MAPI, you would add a string "LOGNAME" to the above key, and
  95 have its value point to whatever the environment variable %LOGNAME%
  96 would point to.
  97
  98 Troubleshooting: To view debugging information, create a file called
  99 mapi_debug.txt in your system's %TEMP% directory.  Bug reports or
 100 comments should be sent to pine@cac.washington.edu.
 101
 102 Jeff Franklin <jpf@washington.edu>