1=pod
2
3=head1 NAME
4
5SMIME_write_PKCS7 - convert PKCS#7 structure to S/MIME format.
6
7=head1 SYNOPSIS
8
9 #include <openssl/pkcs7.h>
10
11 int SMIME_write_PKCS7(BIO *out, PKCS7 *p7, BIO *data, int flags);
12
13=head1 DESCRIPTION
14
15SMIME_write_PKCS7() adds the appropriate MIME headers to a PKCS#7
16structure to produce an S/MIME message.
17
18B<out> is the BIO to write the data to. B<p7> is the appropriate
19B<PKCS7> structure. If cleartext signing (B<multipart/signed>) is
20being used then the signed data must be supplied in the B<data> 
21argument. B<flags> is an optional set of flags.
22
23=head1 NOTES
24
25The following flags can be passed in the B<flags> parameter.
26
27If B<PKCS7_DETACHED> is set then cleartext signing will be used,
28this option only makes sense for signedData where B<PKCS7_DETACHED>
29is also set when PKCS7_sign() is also called.
30
31If the B<PKCS7_TEXT> flag is set MIME headers for type B<text/plain>
32are added to the content, this only makes sense if B<PKCS7_DETACHED>
33is also set.
34
35If the B<PKCS7_PARTSIGN> flag is set the signed data is finalized
36and output along with the content. This flag should only be set
37if B<PKCS7_DETACHED> is also set and the previous call to PKCS7_sign()
38also set these flags.
39
40If cleartext signing is being used and B<PKCS7_PARTSIGN> not set then
41the data must be read twice: once to compute the signature in PKCS7_sign()
42and once to output the S/MIME message.
43
44=head1 BUGS
45
46SMIME_write_PKCS7() always base64 encodes PKCS#7 structures, there
47should be an option to disable this.
48
49=head1 RETURN VALUES
50
51SMIME_write_PKCS7() returns 1 for success or 0 for failure.
52
53=head1 SEE ALSO
54
55L<ERR_get_error(3)|ERR_get_error(3)>, L<PKCS7_sign(3)|PKCS7_sign(3)>,
56L<PKCS7_verify(3)|PKCS7_verify(3)>, L<PKCS7_encrypt(3)|PKCS7_encrypt(3)>
57L<PKCS7_decrypt(3)|PKCS7_decrypt(3)>
58
59=head1 HISTORY
60
61SMIME_write_PKCS7() was added to OpenSSL 0.9.5
62
63=cut
64