curlsmtpsink: add comment describing function

Fixes https://bugzilla.gnome.org/show_bug.cgi?id=686774
This commit is contained in:
Sebastian Rasmussen 2012-10-24 11:34:32 +02:00 committed by Tim-Philipp Müller
parent 1d710ad13a
commit 1c71fd351a

View file

@ -580,6 +580,12 @@ generate_encoded_word (gchar * str)
return encoded_word; return encoded_word;
} }
/* Setup header fields (From:/To:/Date: etc) and message body for the e-mail.
* This data is supposed to be sent to libcurl just before any media data.
* This function is called once for each e-mail:
* 1. we are about the send the first attachment
* 2. we have sent all the attachments and continue sending new ones within
* a new e-mail (transfer options have been reset). */
static gboolean static gboolean
gst_curl_smtp_sink_set_transfer_options_unlocked (GstCurlBaseSink * bcsink) gst_curl_smtp_sink_set_transfer_options_unlocked (GstCurlBaseSink * bcsink)
{ {