Package com.github.akunzai.log4j

Class SendGridAppender.Builder

  • All Implemented Interfaces:
    org.apache.logging.log4j.core.util.Builder<SendGridAppender>
    Enclosing class:
    SendGridAppender
    public static class SendGridAppender.Builder
extends org.apache.logging.log4j.core.appender.AbstractAppender.Builder<SendGridAppender.Builder>
implements org.apache.logging.log4j.core.util.Builder<SendGridAppender>
    The Plugin Builder for SendGridAppender

    • Constructor Detail

      • Builder

        public Builder()
        The Plugin Builder for SendGridAppender

    • Method Detail

      • setTo

        public SendGridAppender.Builder setTo​(java.lang.String to)
        Set the recipient email addresses
        Parameters:
        to - Comma-separated list of recipient email addresses.
        Returns:
        Builder

      • setCc

        public SendGridAppender.Builder setCc​(java.lang.String cc)
        Set the CC email addresses
        Parameters:
        cc - Comma-separated list of CC email addresses.
        Returns:
        Builder

      • setBcc

        public SendGridAppender.Builder setBcc​(java.lang.String bcc)
        Set the BCC email addresses
        Parameters:
        bcc - Comma-separated list of BCC email addresses.
        Returns:
        Builder

      • setFrom

        public SendGridAppender.Builder setFrom​(java.lang.String from)
        Set the email address of the sender
        Parameters:
        from - Email address of the sender.
        Returns:
        Builder

      • setReplyTo

        public SendGridAppender.Builder setReplyTo​(java.lang.String replyTo)
        Set the Reply-To email addresses
        Parameters:
        replyTo - Comma-separated list of Reply-To email addresses.
        Returns:
        Builder

      • setSubject

        public SendGridAppender.Builder setSubject​(java.lang.String subject)
        Set the email subject
        Parameters:
        subject - Subject template for the email messages.
        Returns:
        Builder
        See Also:
        PatternLayout

      • setHost

        public SendGridAppender.Builder setHost​(java.lang.String host)
        Set the SendGrid host
        Parameters:
        host - The SendGrid host. By defaults, use api.sendgrid.com.
        Returns:
        Builder

      • setApiKey

        public SendGridAppender.Builder setApiKey​(java.lang.String apiKey)
        Set the SendGrid API Key
        Parameters:
        apiKey - The SendGrid API Key
        Returns:
        Builder

      • setSandboxMode

        public SendGridAppender.Builder setSandboxMode​(boolean sandboxMode)
        Set the SendGrid Sandbox mode
        Parameters:
        sandboxMode - Enable the SendGrid Sandbox mode?
        Returns:
        Builder

      • setFactory

        public SendGridAppender.Builder setFactory​(org.apache.logging.log4j.core.appender.ManagerFactory<com.github.akunzai.log4j.SendGridManager,​com.github.akunzai.log4j.SendGridManager.FactoryData> factory)
        Set the customized SendGridManager factory for testing
        Parameters:
        factory - The SendGridManager factory
        Returns:
        Builder

      • setBufferSize

        public SendGridAppender.Builder setBufferSize​(int bufferSize)
        Set the buffer size before sending an email
        Parameters:
        bufferSize - Number of log events to buffer before sending an email. Defaults to 512.
        Returns:
        Builder

      • setLayout

        public SendGridAppender.Builder setLayout​(org.apache.logging.log4j.core.Layout<? extends java.io.Serializable> layout)
        Set the email body layout
        Overrides:
        setLayout in class org.apache.logging.log4j.core.appender.AbstractAppender.Builder<SendGridAppender.Builder>
        Parameters:
        layout - Specifies the layout used for the email message body. By default, this uses the default HTML layout.
        Returns:
        Builder

      • setFilter

        public SendGridAppender.Builder setFilter​(org.apache.logging.log4j.core.Filter filter)
        Set the filter for this appender
        Overrides:
        setFilter in class org.apache.logging.log4j.core.filter.AbstractFilterable.Builder<SendGridAppender.Builder>
        Parameters:
        filter - Specifies the filter used for this appender. By default, uses a ThresholdFilter with a level of ERROR.
        Returns:
        Builder