org.simplejavamail.mailer.internal.util.TransportConnectionHelper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of simple-java-mail Show documentation

Simple API, Complex Emails. A light weight wrapper for the JavaMail SMTP API

There is a newer version: 8.12.4

/*
 * Copyright © 2009 Benny Bottema ([email protected])
 *
 * Licensed 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.
 */
package org.simplejavamail.mailer.internal.util;

import jakarta.mail.MessagingException;
import jakarta.mail.Session;
import jakarta.mail.Transport;
import lombok.val;
import org.simplejavamail.api.mailer.config.TransportStrategy;

/**
 * @see #connectTransport(Transport, Session)
 */
public class TransportConnectionHelper {

    /**
     * To connect using OAuth2 authentication, we need to connect slightly differently as we can't use only Session properties and the traditional Authenticator class for
     * providing password. Instead, mail.smtp.auth.mechanisms is set to {@code "XOAUTH2"} and the built-in OAuth2 Security Provider should take over and use the
     * token as the password, and that is only possible using the alternative {@link Transport#connect(String, String)}.
     *
     * @see https://eclipse-ee4j.github.io/angus-mail/OAuth2
     */
    public static void connectTransport(Transport transport, Session session) throws MessagingException {
        if (session.getProperties().containsKey(TransportStrategy.OAUTH2_TOKEN_PROPERTY)) {
            val username = session.getProperties().getProperty(TransportStrategy.SMTP_TLS.propertyNameUsername());
            val oauth2Token = session.getProperties().getProperty(TransportStrategy.OAUTH2_TOKEN_PROPERTY);
            transport.connect(username, oauth2Token);
        } else {
            transport.connect();
        }
    }
}