Transports
**********







A **transport** is used to get a report on the right place (on the
file system, in your mailbox...).

APyCot comes with the following transports. If you don't find the feature
you're  looking for, you may still write your own transport, and contribute
it ;). The best way to do so for the moment is to look at the existant ones...


file
````
The *file* transport will put your reports in a specific directory on the
file system. Existant reports will be overriden at each reports generation.
It supports the following options: 

+--------------+-----+--------------------------------------------------------+
|     name     | req |   description                                          |
+==============+=====+========================================================+
| destination  | yes | the file system destination directory                  |
+--------------+-----+--------------------------------------------------------+
| url_base     | no  | URL that may be used as base to get reports from the   |
|              |     | web                                                    |
+--------------+-----+--------------------------------------------------------+


datedfile
`````````
The *datedfile* transport will put your reports in a specific directory on the
file system, in a separated directory for each run.
It supports the following options: 

+--------------+-----+--------------------------------------------------------+
|     name     | req |   description                                          |
+==============+=====+========================================================+
| destination  | yes | the file system destination directory                  |
+--------------+-----+--------------------------------------------------------+
| url_base     | no  | URL that may be used as base to get reports from the   |
|              |     | web                                                    |
+--------------+-----+--------------------------------------------------------+

datedzope
`````````
The *datedzope* transport will put your reports in a specific directory on a
Zope CMF site, in a separated directory for each run.
It supports the following options: 

+--------------+-----+--------------------------------------------------------+
|     name     | req |   description                                          |
+==============+=====+========================================================+
| destination  | yes | the file system destination directory                  |
+--------------+-----+--------------------------------------------------------+
| url_base     | yes | URL that used as base to get reports from the web      |
+--------------+-----+--------------------------------------------------------+
| user         | no  | the user name for the connection to the base_url       |
+--------------+-----+--------------------------------------------------------+
| password     | no  | the user password for the connection to the base_url   |
+--------------+-----+--------------------------------------------------------+
| folder_type  | no  | the CMF type used for folders (default to Folder)      |
+--------------+-----+--------------------------------------------------------+
| document_type| no  | the CMF type used for reports (default to RawDocument) |
+--------------+-----+--------------------------------------------------------+


email
`````
The *email* transport may be used to send a report by mail. 
It supports the following options: 

+--------------+-----+--------------------------------------------------------+
|     name     | req |   description                                          |
+==============+=====+========================================================+
| dest         | yes | list of destination addresses                          |
+--------------+-----+--------------------------------------------------------+
| from         | yes | email from name and address                            |
+--------------+-----+--------------------------------------------------------+
| subject      | no  | email subject (default to APyCot Report)               |
+--------------+-----+--------------------------------------------------------+
| smtp_server  | no  | SMTP server host name (default to localhost)           |
+--------------+-----+--------------------------------------------------------+
| smtp_port    | no  | SMTP server port (default to 25)                       |
+--------------+-----+--------------------------------------------------------+
| smtp_debug   | no  | debug the smtp connexion (default to 0)                |
+--------------+-----+--------------------------------------------------------+
