'\" t
.\"     Title: AMC-mailing
.\"    Author: Alexis Bienven\(:ue <paamc@passoire.fr>
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 2018-12-29
.\"    Manual: Auto Multiple Choice
.\"    Source: Auto Multiple Choice 1.4.0
.\"  Language: English
.\"
.TH "AMC\-MAILING" "1" "2018-12-29" "Auto Multiple Choice 1\&.4\&.0" "Auto Multiple Choice"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
AMC-mailing \- mail PDF annotated completed answer sheets to students
.SH "SYNOPSIS"
.HP \w'\fBauto\-multiple\-choice\fR\ 'u
\fBauto\-multiple\-choice\fR mailing [\-\-xmlargs\ \fIargs\&.xml\fR] \-\-project\ \fIproject\-dir\fR \-\-students\-list\ \fIstudents\-list\&.csv\fR [\-\-list\-encoding\ \fIencoding\fR] \-\-email\-column\ \fIcol\fR \-\-sender\ \fIsender\-email\fR \-\-subject\ \fIsubject\fR \-\-text\ \fIemail\-body\fR [\-\-text\-content\-type\ \fIcontent\-type\fR] [\-\-debug\ \fIfile\&.log\fR] [\fItransport\ arguments\fR...]
.SH "DESCRIPTION"
.PP
The command
\fBAMC\-mailing\&.pl\fR
sends by email the PDF annotated completed answer sheets to the students\&. Email addresses are taken from the students list file\&.
.PP
\fB\-\-project \fR\fB\fIproject\-dir\fR\fR
.RS 4
Gives the project directory\&.
.RE
.PP
\fB\-\-students\-list \fR\fB\fIstudents\-list\&.csv\fR\fR
.RS 4
sets the students list file name\&.
.RE
.PP
\fB\-\-list\-encoding \fR\fB\fIencoding\fR\fR
.RS 4
selects an encoding for file
\fIstudents\-list\&.csv\fR
(default is utf\-8)\&.
.RE
.PP
\fB\-\-email\-column \fR\fB\fIcol\fR\fR
.RS 4
sets the name of the column containing the email addresses of the students in the students list file\&.
.RE
.PP
\fB\-\-sender \fR\fB\fIsender\-email\fR\fR
.RS 4
sets the sender email\&.
.RE
.PP
\fB\-\-cc \fR\fB\fIcc\-email\-address\fR\fR
.RS 4
sets the carbon copy email address\&.
.RE
.PP
\fB\-\-bcc \fR\fB\fIbcc\-email\-address\fR\fR
.RS 4
sets the blind carbon copy email address\&.
.RE
.PP
\fB\-\-subject \fR\fB\fIsubject\fR\fR
.RS 4
sets the subject of the emails to send\&.
.RE
.PP
\fB\-\-text \fR\fB\fIemail\-body\fR\fR
.RS 4
sets the body text of the emails to send\&.
.RE
.PP
\fB\-\-text\-content\-type \fR\fB\fIcontent\-type\fR\fR
.RS 4
sets the content\-type of email text\&.
\fIcontent\-type\fR
may be
\fBtext/plain\fR
or
\fBtext/html\fR\&.
.RE
.PP
\fB\-\-attach \fR\fB\fIfilename\fR\fR
.RS 4
adds file
\fIfilename\fR
as an attachment to all emails sent\&. Use this option several times to attach multiple files\&.
.RE
.PP
\fB\-\-transport \fR\fB\fItransport\fR\fR
.RS 4
sets the transport to use\&.
\fItransport\fR
may be
\fBsendmail\fR
or
\fBSMTP\fR\&.
.RE
.PP
\fB\-\-debug \fR\fB\fIfile\&.log\fR\fR
.RS 4
gives a file to fill with debugging information\&.
.RE
.PP
\fB\-\-delay \fR\fB\fItime\fR\fR
.RS 4
sets a delay of
\fItime\fR
seconds between each sending\&.
.RE
.SH "TRANSPORT ARGUMENTS"
.PP
Depending on the value used for argument
\fItransport\fR, the following arguments can be added:
.SS "Transport sendmail"
.PP
\fB\-\-sendmail\-path \fR\fB\fIpath\fR\fR
.RS 4
sets the path to the
\fBsendmail\fR
command (defaults to
/usr/sbin/sendmail)\&.
.RE
.SS "Transport SMTP"
.PP
\fB\-\-smtp\-host \fR\fB\fIhost\fR\fR
.RS 4
sets the SMTP hostname (defaults to
\fBsmtp\fR)\&.
.RE
.PP
\fB\-\-smtp\-port \fR\fB\fIport\fR\fR
.RS 4
sets the port to use (default value is 25)\&.
.RE
.PP
\fB\-\-smtp\-ssl \fR\fB\fImode\fR\fR
.RS 4
sets the security mode for the SMTP connection\&. The option
\fImode\fR
can be
ssl,
starttls, or
0
(unsecured)\&.
.RE
.PP
\fB\-\-smtp\-user \fR\fB\fIuser\fR\fR
.RS 4
sets the username for authenticated SMTP\&.
.RE
.PP
\fB\-\-smtp\-passwd\-file \fR\fB\fIfile\fR\fR
.RS 4
gives the path of a file containing the password (as the first line of the file) for authenticated SMTP\&.
.RE
.SH "ARGUMENTS IN A XML FILE"
.PP
To avoid encoding problems, one can place some arguments in a XML file and use the
\fB\-\-xmlargs \fR\fB\fIfile\&.xml\fR\fR
argument as the first command argument\&. Here is an example of such a file:
.sp
.if n \{\
.RS 4
.\}
.nf
<?xml version="1\&.0" encoding="UTF\-8"?>
<arguments>
  <arg>\-\-sender</arg><arg>Bienven\(:ue &lt;paamc@passoire\&.fr&gt;</arg>
  <arg>\-\-text</arg><arg>Voil\(`a votre copie corrig\('ee</arg>
  <arg>\-\-subject</arg><arg>QCM</arg>
</arguments>
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBAlexis Bienven\(:ue\fR <\&paamc@passoire.fr\&>
.RS 4
Main author
.RE
.PP
\fBAnirvan Sarkar\fR
.RS 4
Author and Editor
.RE
.PP
\fBHiroto Kagotani\fR
.RS 4
Editor
.RE
.PP
\fBFr\('ed\('eric Br\('eal\fR
.RS 4
Author and Editor
.RE
.PP
\fBJean B\('erard\fR
.RS 4
Translation from French
.RE
.PP
\fBGeorges Khaznadar\fR
.RS 4
Translation from French
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2008-2018 Alexis Bienven\(:ue
.br
.PP
This document can be used according to the terms of the GNU General Public License, version 2 or later.
.sp