diff options
| -rw-r--r-- | vmime/header.hpp | 11 | ||||
| -rw-r--r-- | vmime/parameterizedHeaderField.hpp | 7 |
2 files changed, 16 insertions, 2 deletions
diff --git a/vmime/header.hpp b/vmime/header.hpp index 96548b48..4490e5d6 100644 --- a/vmime/header.hpp +++ b/vmime/header.hpp @@ -101,6 +101,8 @@ public: * Field name is case-insensitive. * If no field is found, NULL is returned. * + * @param fieldName name of field to return (eg: "X-Mailer" or "From", + * common field names are available in the vmime::fields namespace) * @return first field with the specified name, or NULL if no field * with this name was found */ @@ -111,6 +113,9 @@ public: * If no field is found, or the field is not of the specified type, * NULL is returned. * + * @param fieldName name of field whose value is to be returned + * (eg: "X-Mailer" or "From", common field names are available in + * the vmime::fields namespace) * @return first field with the specified name, or NULL if no field * with this name was found */ @@ -125,6 +130,8 @@ public: * If no field is found, or the field value is not of the specified * type, NULL is returned. * + * @param fieldName name of field to return (eg: "X-Mailer" or "From", + * common field names are available in the vmime::fields namespace) * @return value of the first field with the specified name, or NULL * if no field with this name was found, or the value is not of the * specified type @@ -143,6 +150,8 @@ public: /** Find all fields that match the specified name. * If no field is found, an empty vector is returned. * + * @param fieldName name of field to return (eg: "X-Mailer" or "From", + * common field names are available in the vmime::fields namespace) * @return list of fields with the specified name */ std::vector <shared_ptr <headerField> > findAllFields(const string& fieldName); @@ -151,6 +160,8 @@ public: * If no field is found, one will be created and inserted into * the header. * + * @param fieldName name of field to return (eg: "X-Mailer" or "From", + * common field names are available in the vmime::fields namespace) * @return first field with the specified name or a new field * if no field is found */ diff --git a/vmime/parameterizedHeaderField.hpp b/vmime/parameterizedHeaderField.hpp index 7a8e8b7d..cc24ccf0 100644 --- a/vmime/parameterizedHeaderField.hpp +++ b/vmime/parameterizedHeaderField.hpp @@ -57,14 +57,16 @@ public: parameterizedHeaderField& operator=(const parameterizedHeaderField& other); /** Checks whether (at least) one parameter with this name exists. + * Parameter name is case-insensitive. * + * @param paramName parameter name * @return true if at least one parameter with the specified name * exists, or false otherwise */ bool hasParameter(const string& paramName) const; - /** Find the first parameter that matches the specified name. - * If no parameter is found, NULL is returned. + /** Find the first parameter that matches the specified name. Parameter name + * is case-insensitive. If no parameter is found, NULL is returned. * * @param paramName parameter name * @return first parameter with the specified name, or NULL if @@ -73,6 +75,7 @@ public: shared_ptr <parameter> findParameter(const string& paramName) const; /** Find the first parameter that matches the specified name. + * Parameter name is case-insensitive. * If no parameter is found, one will be created and inserted into * the parameter list. * |