Fix L<> content in manpages
[openssl.git] / doc / crypto / SMIME_write_CMS.pod
1 =pod
2
3 =head1 NAME
4
5  SMIME_write_CMS - convert CMS structure to S/MIME format.
6
7 =head1 SYNOPSIS
8
9  #include <openssl/cms.h>
10
11  int SMIME_write_CMS(BIO *out, CMS_ContentInfo *cms, BIO *data, int flags);
12
13 =head1 DESCRIPTION
14
15 SMIME_write_CMS() adds the appropriate MIME headers to a CMS
16 structure to produce an S/MIME message.
17
18 B<out> is the BIO to write the data to. B<cms> is the appropriate
19 B<CMS_ContentInfo> structure. If streaming is enabled then the content must be
20 supplied in the B<data> argument. B<flags> is an optional set of flags.
21
22 =head1 NOTES
23
24 The following flags can be passed in the B<flags> parameter.
25
26 If B<CMS_DETACHED> is set then cleartext signing will be used, this option only
27 makes sense for SignedData where B<CMS_DETACHED> is also set when CMS_sign() is
28 called.
29
30 If the B<CMS_TEXT> flag is set MIME headers for type B<text/plain> are added to
31 the content, this only makes sense if B<CMS_DETACHED> is also set.
32
33 If the B<CMS_STREAM> flag is set streaming is performed. This flag should only
34 be set if B<CMS_STREAM> was also set in the previous call to a CMS_ContentInfo
35 creation function.
36
37 If cleartext signing is being used and B<CMS_STREAM> not set then the data must
38 be read twice: once to compute the signature in CMS_sign() and once to output
39 the S/MIME message.
40
41 If streaming is performed the content is output in BER format using indefinite
42 length constructed encoding except in the case of signed data with detached
43 content where the content is absent and DER format is used.
44
45 =head1 BUGS
46
47 SMIME_write_CMS() always base64 encodes CMS structures, there should be an
48 option to disable this.
49
50 =head1 RETURN VALUES
51
52 SMIME_write_CMS() returns 1 for success or 0 for failure.
53
54 =head1 SEE ALSO
55
56 L<ERR_get_error(3)>, L<CMS_sign(3)>,
57 L<CMS_verify(3)>, L<CMS_encrypt(3)>
58 L<CMS_decrypt(3)>
59
60 =head1 HISTORY
61
62 SMIME_write_CMS() was added to OpenSSL 0.9.8
63
64 =cut