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            [-u|--username USERNAME] [-C|--langcode LANGCODE] [-s|--pattern USERNAME]
14            [-p|--password PASSWORD] [--nopass] [-c|--create] [-r|--delete] [-R|--rename STRING]
15            [-l|--list] [--listlangs] [--dump] [-a|--attr VALUE] [--dump-data] [-d|--debuglevel LEVEL]
16            [--getfqdn] [-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
78       -l     List  the  available languages. These can be used to specify the
79              language name (--language) when creating a profile.
80
81
82
83

OPTIONS

85       --database DATABASE
86
87       -f     Path to the profile database. If no path database  is  specified
88              then the default one will be used $HOME/.openchange/profiles.ldb
89
90
91       --ldif LDIF
92
93       -L     Path  to  the ldif files. If no ldif directory is specified then
94              the default one set at  compilation  time  will  be  used.  This
95              option is only used when creating a new profile database.
96
97
98       --profile PROFILE
99
100       -p     Set  the  profile  name  to  use  (e.g. the profile to create or
101              delete, or to dump information about).
102
103
104       --address IP_ADDR|FQDN
105
106       -I     Set the Exchange server IP address  or  fully  qualified  domain
107              name.
108
109
110       --workstation WORKSTATION
111
112       -M     Sets the local computer name.
113
114
115       --domain DOMAIN
116
117       -D     Set the Windows domain name.
118
119
120       --encrypt
121
122       -E     Require  the  connection  to  be  encrypted.  This  is  normally
123              required only on Exchange 2010  (and  will  presumably  also  be
124              required  on  future versions), but may be used on Exchange 2003
125              and Exchange 2007.
126
127
128       --realm REALM
129
130       -R     Set the Windows realm
131
132
133       --username
134
135       -u     Set the username to use to log on the Exchange server.
136
137
138       --password
139
140       -p     Set the password corresponding to the username described above.
141
142
143       --langcode
144
145       -C     Specify the language to use with the account. This can be speci‐
146              fied  as  a  code (in hexadecimal) or as a name. When specifying
147              the name, you use the name of the language, and the location (if
148              any), separated by underscores (e.g. English_United_States). See
149              the --listlangs option for how to obtain the full list  of  lan‐
150              guages. The default language code is 0x0409, for US English.
151
152
153       --pattern
154
155       -s     Set a username string pattern mapiprofile should use rather than
156              the default username. This option is used  during  mapi  profile
157              creation.
158
159
160       --nopass
161              Do not save password in the profile.
162
163
164       --attr VALUE
165
166       -a     Print an attribute value.
167
168
169       --dump-data
170              Dump the hex data.
171
172
173       --debuglevel LEVEL
174
175       -d     Set the debug level.
176
177
178       --getfqdn
179              Returns  the  DNS fully qualified domain name of the NSPI server
180              matching the legacyDN.
181
182

EXAMPLES

184       Create a blank MAPI profile database:
185       mapiprofile --database=/tmp/profiles2.ldb --ldif=/usr/local/samba/share/setup --newdb
186
187       Create a new profile using NTLMSSP authentication:
188       mapiprofile --database=/tmp/profiles.ldb --profile=jkerihuel
189            --username=jkerihuel --password=secret --language=0x040C
190            --address=192.168.194.22 --workstation=LOCALHOST --domain=OPENCHANGE
191            --create
192       Profile jkerihuel completed and added to database /tmp/profiles.ldb. Note
193       that this account will use French.
194
195       Create a new profile using Kerberos authentication:
196       mapiprofile --database=/tmp/profiles.ldb --profile=jkerihuel
197            --username=jkerihuel --password=secret --language=0x040C
198            --address=exchange.openchange.local --domain=OPENCHANGE
199            --realm=OPENCHANGE.LOCAL --create
200
201
202       Delete a profile:
203       mapiprofile --database=/tmp/profiles.ldb --profile=jkerihuel --delete
204       Profile jkerihuel deleted from database /tmp/profiles.ldb
205
206       List profiles:
207       mapiprofile --database=/tmp/profiles.ldb --list
208       We have 2 profiles in the database:
209               Profile = exchange-2000
210               Profile = jkerihuel
211
212       Dump a profile:
213       mapiprofile --database=/tmp/profiles.ldb --profile=jkerihuel --dump
214       Profile: jkerihuel
215            username       == jkerihuel
216            password       == secret
217            mailbox        == /o=First Organization/ou=First Administrative Group/cn=Recipients/cn=jkerihuel
218            workstation    == LOCALHOST
219            domain         == OPENCHANGE
220            server         == exchange.openchange.local
221
222       Dump profile attribute:
223       mapiprofile --database=/tmp/profiles.ldb --profile=jkerihuel --attr=HomeMDB
224       Profile jkerihuel: HomeMDB = /o=First Organization/ou=First Administrative Group/cn=Configuration/cn=Servers/cn=EXCHANGE2000
225
226

AUTHOR

228       Julien Kerihuel <j.kerihuel at openchange dot org>
229
230       Brad Hards <bradh at openchange dot org>
231
232