mapiprofile(1)

1MAPIPROFILE(1)             OpenChange Users' Manual             MAPIPROFILE(1)
2
3
4

NAME

6       mapiprofile - administer OpenChange MAPI Profiles databases
7
8

SYNOPSIS

10       mapiprofile [-?GSnEcrlV] [-?|--help] [--usage] [-L|--ldif=PATH] [-G|--getdefault] [-S|--default]
11            [-n|--newdb] [-f|--database=PATH] [-P|--profile=PROFILE] [-I|--address=xxx.xxx.xxx.xxx]
12            [-M|--workstation=WORKSTATION_NAME] [-D|--domain=DOMAIN] [-R|--realm=REALM] [-E|--encrypt]
13            [-v|--exchange-version=2000] [-u|--username=USERNAME] [-C|--language=LANGUAGE]
14            [-s|--pattern=USERNAME] [-p|--password=PASSWORD] [--nopass] [-c|--create] [-r|--delete]
15            [-R|--rename=STRING] [-l|--list] [--listlangs] [--dump] [-a|--attr=VALUE] [--dump-data]
16            [-d|--debuglevel=LEVEL] [--getfqdn] [-k|--kerberos={yes|no}] [-V|--version]
17
18

DESCRIPTION

20       mapiprofile  is  a command line tool designed to provide administrative
21       support for OpenChange MAPI profiles. A profile in this context  repre‐
22       sents a single user's connection to a server. It can be thought of as a
23       user's account information stored on the client side.  Most  OpenChange
24       utilities  make use of the profile information stored in the local pro‐
25       file database, often by referring to the name of the profile. In  addi‐
26       tion,  because most users only have a single account, it is possible to
27       designate one profile as the default profile. If a profile is not spec‐
28       ified,  other utilities will use the default profile (if any) to estab‐
29       lish a connection.
30
31       mapiprofile is designed so it also provides sample code for  developers
32       interested  in adding OpenChange MAPI profile support to their applica‐
33       tions.
34
35

COMMANDS

37       --newdb
38
39       -n     Create a new database.
40
41
42       --create
43
44       -c     Create a new profile in the database.
45
46
47       --delete
48
49       -r     Delete a profile from the database.
50
51
52       --rename PROFILE
53
54       -R     Rename a profile in the database
55
56
57       --default
58
59       -S     Set the default profile in the database.
60
61
62       --getdefault
63
64       -G     Get the default profile name from the database.
65
66
67       --dump Display information about a specific  profile  from  information
68              stored in the database.
69
70
71       --list
72
73       -l     List existing profiles in the database.
74
75
76       --listlangs
77              List  the  available languages. These can be used to specify the
78              language name (--language) when creating a profile.
79
80
81
82

OPTIONS

84       --database DATABASE
85
86       -f     Path to the profile database. If no path database  is  specified
87              then the default one will be used $HOME/.openchange/profiles.ldb
88
89
90       --ldif LDIF
91
92       -L     Path  to  the LDIF files. If no LDIF directory is specified then
93              the default one set at  compilation  time  will  be  used.  This
94              option is only used when creating a new profile database.
95
96
97       --profile PROFILE
98
99       -p     Set  the  profile  name  to  use  (e.g. the profile to create or
100              delete, or to dump information about).
101
102
103       --address IP_ADDR|FQDN
104
105       -I     Set the Exchange server IP address  or  fully  qualified  domain
106              name.
107
108
109       --workstation WORKSTATION
110
111       -M     Sets the local computer name.
112
113
114       --domain DOMAIN
115
116       -D     Set the Windows domain name.
117
118
119       --encrypt
120
121       -E     Require  the  connection  to  be  encrypted.  This  is  normally
122              required only on Exchange 2010  (and  will  presumably  also  be
123              required  on  future versions), but may be used on Exchange 2003
124              and Exchange 2007.
125
126
127       --exchange-version
128
129       -v     Specify which version of the protocol  to  use.  The  reasonable
130              options  are  2000, 2003/2007 and 2010.  2000 means use EcDoCon‐
131              nect (0x0) / EcDoRpc (0x2) RPC calls, 2003  or  2007  means  use
132              EcDoConnectEx  (0xA)  /  EcDoRpcExt2  (0xB)  RPC calls, and 2010
133              means use EcDoConnectEx (0xA) / EcDoRpcExt2 (0xB) RPC calls over
134              a sealed pipe.
135
136
137       --kerberos
138
139       -k     Specify whether to force Kerberos (set to yes), not use Kerberos
140              (set to no). If you omit this  option,  Kerberos  will  be  used
141              where practical.
142
143
144       --realm REALM
145
146       -R     Set the Windows realm
147
148
149       --username
150
151       -u     Set the username to use to log on the Exchange server.
152
153
154       --password
155
156       -p     Set the password corresponding to the username described above.
157
158
159       --language
160
161       -C
162
163              Specify  the  language  to use with the account. When specifying
164              the name, you use the name of the language returned  within  the
165              list --listlangs option displays. See the --listlangs option for
166              how to obtain the full list of languages. The  default  language
167              code  is  the  system one stored within the LC_CTYPE environment
168              variable.
169
170
171       --pattern
172
173       -s     Set a username string pattern mapiprofile should use rather than
174              the  default  username.  This option is used during mapi profile
175              creation.
176
177
178       --nopass
179              Do not save password in the profile.
180
181
182       --attr VALUE
183
184       -a     Print an attribute value.
185
186
187       --dump-data
188              Dump the hex data.
189
190
191       --debuglevel LEVEL
192
193       -d     Set the debug level.
194
195
196       --getfqdn
197              Returns the DNS fully qualified domain name of the  NSPI  server
198              matching the legacyDN.
199
200

EXAMPLES

202       Create a blank MAPI profile database:
203       mapiprofile --database=/tmp/profiles2.ldb --ldif=/usr/local/samba/share/setup --newdb
204
205       Create a new profile using NTLMSSP authentication:
206       mapiprofile --database=/tmp/profiles.ldb --profile=jkerihuel
207            --username=jkerihuel --password=secret --language=French\ \(France\)
208            --address=192.168.194.22 --workstation=LOCALHOST --domain=OPENCHANGE
209            --create
210       Profile jkerihuel completed and added to database /tmp/profiles.ldb.
211       Note that this account will use French.
212
213       Create a new profile using Kerberos authentication:
214       mapiprofile --database=/tmp/profiles.ldb --profile=jkerihuel
215            --username=jkerihuel --password=secret --language=French\ \(France\)
216            --address=exchange.openchange.local --domain=OPENCHANGE
217            --realm=OPENCHANGE.LOCAL --create
218
219
220       Delete a profile:
221       mapiprofile --database=/tmp/profiles.ldb --profile=jkerihuel --delete
222       Profile jkerihuel deleted from database /tmp/profiles.ldb
223
224       List profiles:
225       mapiprofile --database=/tmp/profiles.ldb --list
226       We have 2 profiles in the database:
227               Profile = exchange-2000
228               Profile = jkerihuel
229
230       Dump a profile:
231       mapiprofile --database=/tmp/profiles.ldb --profile=jkerihuel --dump
232       Profile: jkerihuel
233            username       == jkerihuel
234            password       == secret
235            mailbox        == /o=First Organization/ou=First Administrative Group/cn=Recipients/cn=jkerihuel
236            workstation    == LOCALHOST
237            domain         == OPENCHANGE
238            server         == exchange.openchange.local
239
240       Dump profile attribute:
241       mapiprofile --database=/tmp/profiles.ldb --profile=jkerihuel --attr=HomeMDB
242       Profile jkerihuel: HomeMDB = /o=First Organization/ou=First Administrative Group/cn=Configuration/cn=Servers/cn=EXCHANGE2000
243
244

AUTHOR

246       Julien Kerihuel <j.kerihuel at openchange dot org>
247
248       Brad Hards <bradh at openchange dot org>
249
250