RE: [SOGo] documentation for sogo-tool

2023-10-05 Thread qhivert 
Of I forgot for setting instead of putting the value in the command line you
can write the json in a file and do:
sogo-tool user-preferences set defaults  Forward -f  -p


Quentin

-Original Message-
From: users-requ...@sogo.nu  On Behalf Of qhivert
Sent: jeudi 5 octobre 2023 15:38
To: users@sogo.nu
Subject: RE: [SOGo] documentation for sogo-tool

I see, as the doc is not yet ready, I will explain it:

To see if a user has a forwarding rule:
sogo-tool user-preferences get defaults  Forward
result:
Forward:
{"forwardAddress":["sogo-tests2@sogo.alinto"],"enabled":1,"keepCopy":1}
Or can be:
Value for key "Forward" not found in defaults If Forward have never been
set.

-

To unset a forwarding rule:
sogo-tool user-preferences unset defaults  Forward -p 

credfile is a simple one-line file that contains "username:password" of an
admin account of your imap/cyrus server.

-

To set a forwarding rule:
sogo-tool user-preferences set defaults  Forward  -p


values is a json-string as such:
 
{"forwardAddress":["sogo-tests2@sogo.alinto"],"enabled":1,"keepCopy":1,"alwa
ysSend":1}
* forwardAddress: string array of mails where to forward to
* enables: 0/1, 1 to enable 0 to disable the rule
* keepCopy: 0/1, 1 to keep a copy, 0 to not
* alwaysSend: 0/1, 1 to put the forwarding rule at the top of you sieve
script (so no other filters will be applied before), 0 to put it at the
bottom.
keepCopy and alwaysSend are optional cand will be 0 if missing.

Example:
sogo-tool user-preferences set defaults sogo-tests1 Forward
'{"forwardAddress":["sogo-tests2@sogo.alinto"],"enabled":1,"keepCopy":0}' -p
cred

-

Voilà! I've test it on my machine but let me know if you have trouble with
it or if there is unexpected behavior. The order of arguments is very
important.

Quentin

-Original Message-----
From: users-requ...@sogo.nu  On Behalf Of Marco
Sent: jeudi 5 octobre 2023 13:48
To: users@sogo.nu
Subject: Re: [SOGo] documentation for sogo-tool

Am 05.10.2023 schrieb "qhivert" (qhiv...@alinto.eu) :

> There is no documentation yet but it's in our short todo list.
> For now, you can have more information for each command by typing:
> sogo-tool 
> without any arguments.

Thanks for that suggestion, but that doesn't display all options.

[root@sogo ~]# sogo-tool user-preferences user-preferences get|set|unset
defaults|settings user [-p credentialFile] key [value|-f filename]

 user  the user of whom to set the defaults/settings
 key/value value the JSON-formatted value of the key

  -p credentialFileSpecify the file containing the sieve admin
  credentials The file should contain a single line:
 username:password
  Examples:
   sogo-tool user-preferences get defaults janedoe SOGoLanguage
   sogo-tool user-preferences unset settings janedoe Mail
   sogo-tool user-preferences set defaults janedoe SOGoTimeFormat
   '{"SOGoTimeFormat":"%I:%M %p"}'

I am interested in changing the forwarding rules via sogo-tool.

RE: [SOGo] documentation for sogo-tool

2023-10-05 Thread qhivert 
I see, as the doc is not yet ready, I will explain it:

To see if a user has a forwarding rule:
sogo-tool user-preferences get defaults  Forward
result:
Forward:
{"forwardAddress":["sogo-tests2@sogo.alinto"],"enabled":1,"keepCopy":1}
Or can be:
Value for key "Forward" not found in defaults
If Forward have never been set.

-

To unset a forwarding rule:
sogo-tool user-preferences unset defaults  Forward -p 

credfile is a simple one-line file that contains "username:password" of an
admin account of your imap/cyrus server.

-

To set a forwarding rule:
sogo-tool user-preferences set defaults  Forward  -p


values is a json-string as such:
 
{"forwardAddress":["sogo-tests2@sogo.alinto"],"enabled":1,"keepCopy":1,"alwa
ysSend":1}
* forwardAddress: string array of mails where to forward to
* enables: 0/1, 1 to enable 0 to disable the rule
* keepCopy: 0/1, 1 to keep a copy, 0 to not
* alwaysSend: 0/1, 1 to put the forwarding rule at the top of you sieve
script (so no other filters will be applied before), 0 to put it at the
bottom.
keepCopy and alwaysSend are optional cand will be 0 if missing.

Example:
sogo-tool user-preferences set defaults sogo-tests1 Forward
'{"forwardAddress":["sogo-tests2@sogo.alinto"],"enabled":1,"keepCopy":0}' -p
cred

-

Voilà! I've test it on my machine but let me know if you have trouble with
it or if there is unexpected behavior. The order of arguments is very
important.

Quentin

-Original Message-----
From: users-requ...@sogo.nu  On Behalf Of Marco
Sent: jeudi 5 octobre 2023 13:48
To: users@sogo.nu
Subject: Re: [SOGo] documentation for sogo-tool

Am 05.10.2023 schrieb "qhivert" (qhiv...@alinto.eu) :

> There is no documentation yet but it's in our short todo list.
> For now, you can have more information for each command by typing:
> sogo-tool 
> without any arguments.

Thanks for that suggestion, but that doesn't display all options.

[root@sogo ~]# sogo-tool user-preferences user-preferences get|set|unset
defaults|settings user [-p credentialFile] key [value|-f filename]

 user  the user of whom to set the defaults/settings
 key/value value the JSON-formatted value of the key

  -p credentialFileSpecify the file containing the sieve admin
  credentials The file should contain a single line:
 username:password
  Examples:
   sogo-tool user-preferences get defaults janedoe SOGoLanguage
   sogo-tool user-preferences unset settings janedoe Mail
   sogo-tool user-preferences set defaults janedoe SOGoTimeFormat
   '{"SOGoTimeFormat":"%I:%M %p"}'

I am interested in changing the forwarding rules via sogo-tool.

Re: [SOGo] documentation for sogo-tool

2023-10-05 Thread Marco 
Am 05.10.2023 schrieb "qhivert" (qhiv...@alinto.eu) :

> There is no documentation yet but it's in our short todo list.
> For now, you can have more information for each command by typing:
> sogo-tool 
> without any arguments.

Thanks for that suggestion, but that doesn't display all options.

[root@sogo ~]# sogo-tool user-preferences
user-preferences get|set|unset defaults|settings user [-p
credentialFile] key [value|-f filename]

 user  the user of whom to set the defaults/settings
 key/value value the JSON-formatted value of the key

  -p credentialFileSpecify the file containing the sieve admin
  credentials The file should contain a single line:
 username:password
  Examples:
   sogo-tool user-preferences get defaults janedoe SOGoLanguage
   sogo-tool user-preferences unset settings janedoe Mail
   sogo-tool user-preferences set defaults janedoe SOGoTimeFormat
   '{"SOGoTimeFormat":"%I:%M %p"}'

I am interested in changing the forwarding rules via sogo-tool.

RE: [SOGo] documentation for sogo-tool

2023-10-05 Thread qhivert 
Hello Marco,

There is no documentation yet but it's in our short todo list.
For now, you can have more information for each command by typing:
sogo-tool 
without any arguments.

Example:
root@de4b8c9d9ab1:/src/SOGo# sogo-tool backup
backup directory ALL|user1 [user2] ...

   directory  the target directory where backup files will be stored
   user   the user of whom to save the data or ALL for everybody

Example:   sogo-tool backup /tmp/foo ALL

Quentin

-Original Message-
From: users-requ...@sogo.nu  On Behalf Of Marco Moock
Sent: jeudi 5 octobre 2023 11:50
To: users@sogo.nu
Subject: [SOGo] documentation for sogo-tool

Hello!

I cannot find documentation for sogo-tool. -h exists, but doesn't list the
options for user-preferences.
A manpage doesn't exist.

Is there a place where the arguments are all documented?

--
kind regards
Marco Moock