smtpappender.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _LOG4CXX_NET_SMTP_H
#define _LOG4CXX_NET_SMTP_H


#include <log4cxx/appenderskeleton.h>
#include <log4cxx/helpers/cyclicbuffer.h>
#include <log4cxx/spi/triggeringeventevaluator.h>

#if defined(_MSC_VER)
    #pragma warning ( push )
    #pragma warning ( disable: 4251 )
#endif

namespace log4cxx
{
namespace net
{
class LOG4CXX_EXPORT SMTPAppender : public AppenderSkeleton
{
    private:

    private:
        SMTPAppender(const SMTPAppender&);
        SMTPAppender& operator=(const SMTPAppender&);
        static bool asciiCheck(const LogString& value, const LogString& label);
        bool checkEntryConditions();

        LogString to;
        LogString cc;
        LogString bcc;
        LogString from;
        LogString subject;
        LogString smtpHost;
        LogString smtpUsername;
        LogString smtpPassword;
        int smtpPort;
        int bufferSize; // 512
        bool locationInfo;
        helpers::CyclicBuffer cb;
        spi::TriggeringEventEvaluatorPtr evaluator;

    public:
        DECLARE_LOG4CXX_OBJECT(SMTPAppender)
        BEGIN_LOG4CXX_CAST_MAP()
        LOG4CXX_CAST_ENTRY(SMTPAppender)
        LOG4CXX_CAST_ENTRY_CHAIN(AppenderSkeleton)
        END_LOG4CXX_CAST_MAP()

        SMTPAppender();
        SMTPAppender(log4cxx::helpers::Pool& p);

        SMTPAppender(spi::TriggeringEventEvaluatorPtr evaluator);

        ~SMTPAppender();

        virtual void setOption(const LogString& option, const LogString& value);

        virtual void activateOptions(log4cxx::helpers::Pool& p);

        virtual void append(const spi::LoggingEventPtr& event, log4cxx::helpers::Pool& p);


        virtual void close();

        LogString getTo() const;

        LogString getCc() const;

        LogString getBcc() const;


        virtual bool requiresLayout() const;

        void sendBuffer(log4cxx::helpers::Pool& p);


        LogString getEvaluatorClass();

        LogString getFrom() const;

        LogString getSubject() const;


        void setFrom(const LogString& from);

        void setSubject(const LogString& subject);

        void setBufferSize(int bufferSize);

        void setSMTPHost(const LogString& smtpHost);

        LogString getSMTPHost() const;

        void setSMTPPort(int port);

        int getSMTPPort() const;

        void setTo(const LogString& to);

        void setCc(const LogString& to);

        void setBcc(const LogString& to);


        void setSMTPUsername(const LogString& newVal);

        LogString getSMTPUsername() const;

        void setSMTPPassword(const LogString& newVal);

        LogString getSMTPPassword() const;

        inline int getBufferSize() const
        {
            return bufferSize;
        }


        log4cxx::spi::TriggeringEventEvaluatorPtr getEvaluator() const;

        void setEvaluator(log4cxx::spi::TriggeringEventEvaluatorPtr& trigger);

        void setEvaluatorClass(const LogString& value);

        void setLocationInfo(bool locationInfo);

        bool getLocationInfo() const;
}; // class SMTPAppender

LOG4CXX_PTR_DEF(SMTPAppender);

}  // namespace net
} // namespace log4cxx

#if defined(_MSC_VER)
    #pragma warning (pop)
#endif

#endif // _LOG4CXX_NET_SMTP_H