Skip to content

Commit

Permalink
add resource syncjob
Browse files Browse the repository at this point in the history
  • Loading branch information
l-with committed Jul 23, 2022
1 parent 75de68d commit 81b2659
Showing 1 changed file with 54 additions and 0 deletions.
54 changes: 54 additions & 0 deletions docs/resources/syncjob.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
page_title: "mailcow_syncjob Resource - terraform-provider-mailcow"
subcategory: ""
description: |-
---

# mailcow_syncjob (Resource)

Provides a syncjob in mailcow.
This can be used to create, modify, and delete syncjobs.

## Example Usage
```terraform
resource "mailcow_syncjob" "syncjob" {
username = "[email protected]"
host1 = "example.com"
user1 = "[email protected]"
password1 = "secret-password"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `host1` (String) the smtp server where mails should be synced from (--host1)
- `password1` (String, Sensitive) the password of the mailbox on the host (--password1)
- `user1` (String) user to login on remote host (--user1)
- `username` (String) user to login on local host (--user2)

### Optional

- `active` (Boolean) is sync job active or not
- `automap` (Boolean) try to automap folders ("Sent items", "Sent" => "Sent" etc.) (--automap)
- `custom_params` (String) custom parameters
- `delete1` (Boolean) delete from source when completed (--delete1)
- `delete2` (Boolean) delete messages on destination that are not on source (--delete2)
- `delete2duplicates` (Boolean) delete duplicates on destination (--delete2duplicates)
- `enc1` (String) the encryption method used to connect to the target mailserver (SSL,TLS,PLAIN)
- `exclude` (String) exclude objects (regex) (--exclude)
- `maxage` (Number) only sync messages up to this age in days (--maxage)
- `maxbytespersecond` (String) max speed transfer limit for the sync (--maxbytespersecond)
- `mins_interval` (Number) the interval in which messages should be synced (minutes)
- `port1` (Number) the smtp port of the target mail server (--port1)
- `skipcrossduplicates` (Boolean) skip duplicate messages across folders (first come, first serve) (--skipcrossduplicates)
- `subfolder2` (String) sync into subfolder on destination (empty = do not use subfolder) (--subfolder2)
- `subscribeall` (Boolean) subscribe all folders (--subscribeall)
- `timeout1` (Number) timeout for connection to remote host (--timeout1)
- `timeout2` (Number) timeout for connection to local host (--timeout2)

### Read-Only

- `id` (String) The ID of this resource.

0 comments on commit 81b2659

Please sign in to comment.