vmime/vmime/contentTypeField.hpp

115 lines
3.2 KiB
C++

//
// VMime library (http://www.vmime.org)
// Copyright (C) 2002-2013 Vincent Richard <vincent@vmime.org>
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 3 of
// the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// Linking this library statically or dynamically with other modules is making
// a combined work based on this library. Thus, the terms and conditions of
// the GNU General Public License cover the whole combination.
//
#ifndef VMIME_CONTENTTYPEFIELD_HPP_INCLUDED
#define VMIME_CONTENTTYPEFIELD_HPP_INCLUDED
#include "vmime/parameterizedHeaderField.hpp"
#include "vmime/mediaType.hpp"
#include "vmime/charset.hpp"
namespace vmime
{
class VMIME_EXPORT contentTypeField : public parameterizedHeaderField
{
friend class headerFieldFactory;
protected:
contentTypeField();
contentTypeField(contentTypeField&);
public:
/** Test whether the "boundary" parameter is set.
*
* @return true if the "boundary" parameter is set, or false otherwise
*/
bool hasBoundary() const;
/** Return the value of the "boundary" parameter. Boundary is a
* random string used to separate body parts.
*
* @return value of the "boundary" parameter
*/
const string getBoundary() const;
/** Set the value of the "boundary" parameter. Boundary is a
* random string used to separate body parts. Normally, the
* boundary is generated automatically by VMime, you should
* not need to call this.
*
* @param boundary new value for the "boundary" parameter
*/
void setBoundary(const string& boundary);
/** Test whether the "charset" parameter is set.
*
* @return true if the "charset" parameter is set, or false otherwise
*/
bool hasCharset() const;
/** Return the value of the "charset" parameter. It specifies the
* charset used in the body part contents.
*
* @return value of the "charset" parameter
*/
const charset getCharset() const;
/** Set the value of the "charset" parameter. It specifies the
* charset used in the body part contents.
*
* @param ch new value for the "charset" parameter
*/
void setCharset(const charset& ch);
/** Test whether the "report-type" parameter is set.
*
* @return true if the "report-type" parameter is set, or false otherwise
*/
bool hasReportType() const;
/** Return the value of the "report-type" parameter (RFC-1892).
*
* @return value of the "report-type" parameter
*/
const string getReportType() const;
/** Set the value of the "report-type" parameter (RFC-1892).
*
* @param reportType new value for the "report-type" parameter
*/
void setReportType(const string& reportType);
};
} // vmime
#endif // VMIME_CONTENTTYPEFIELD_HPP_INCLUDED