1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.mail2.jakarta;
18
19 import jakarta.mail.Authenticator;
20 import jakarta.mail.PasswordAuthentication;
21
22 /**
23 * This is a very simple authentication object that can be used for any transport needing basic userName and password type authentication.
24 *
25 * @since 1.0
26 */
27 public class DefaultAuthenticator extends Authenticator {
28
29 /** Stores the login information for authentication. */
30 private final PasswordAuthentication authentication;
31
32 /**
33 * Default constructor.
34 *
35 * @param userName user name to use when authentication is requested
36 * @param password password to use when authentication is requested
37 * @since 1.0
38 */
39 public DefaultAuthenticator(final String userName, final String password) {
40 this.authentication = new PasswordAuthentication(userName, password);
41 }
42
43 /**
44 * Gets the authentication object that will be used to login to the mail server.
45 *
46 * @return A {@code PasswordAuthentication} object containing the login information.
47 * @since 1.0
48 */
49 @Override
50 protected PasswordAuthentication getPasswordAuthentication() {
51 return authentication;
52 }
53 }