Widen support of auth methods #9
Conversation
ucomah
commented
Oct 14, 2023
ucomah
commented
- Added a support for PLAIN with method.
- If desired (forced) auth method is not set by user - most preferable one will be used from server's response.
| @@ -43,3 +43,28 @@ public enum SMTPResponseCode: Int { | |||
| case startMailInput = 354 | |||
| case commandNotRecognized = 502 | |||
| } | |||
|
|
|||
| /// SMTP Authentication method. | |||
| public enum SMTPAuthMethod: String, CaseIterable { | |||
There was a problem hiding this comment.
I can add this myself, but feel that this should be a struct, in case we add more auth methods
There was a problem hiding this comment.
We shouldn't use a public enum for SMTPAuthMethod, because it doesn't allow us to expand the auth methods in the future. Adding this would force us to "freeze" the enums cases, so we'd be stuck supporting only these auth methods.
The solution is to make a public struct around the same enum, that's instead an internal enum. By adding static let's for each enum case, we can have the same API but without worrying about API compatibility.
There was a problem hiding this comment.
See this PR for a related implementation: hummingbird-project/hummingbird#361
|
Sorry for missing your PR. I didn't see this because I wasn't marked for review |
|
No worries, hope you'll have a time to take a look )) |
|
|
||
|
|
||
| if line.contains("AUTH"), auth.isEmpty { | ||
| auth = Set(line.components(separatedBy: " ").compactMap { SMTPAuthMethod(rawValue: $0) }) |
There was a problem hiding this comment.
Nit:
| auth = Set(line.components(separatedBy: " ").compactMap { SMTPAuthMethod(rawValue: $0) }) | |
| auth = Set(line.components(separatedBy: " ").compactMap(SMTPAuthMethod.init) |
| @@ -43,3 +43,28 @@ public enum SMTPResponseCode: Int { | |||
| case startMailInput = 354 | |||
| case commandNotRecognized = 502 | |||
| } | |||
|
|
|||
| /// SMTP Authentication method. | |||
| public enum SMTPAuthMethod: String, CaseIterable { | |||
There was a problem hiding this comment.
We shouldn't use a public enum for SMTPAuthMethod, because it doesn't allow us to expand the auth methods in the future. Adding this would force us to "freeze" the enums cases, so we'd be stuck supporting only these auth methods.
The solution is to make a public struct around the same enum, that's instead an internal enum. By adding static let's for each enum case, we can have the same API but without worrying about API compatibility.
| @@ -43,3 +43,28 @@ public enum SMTPResponseCode: Int { | |||
| case startMailInput = 354 | |||
| case commandNotRecognized = 502 | |||
| } | |||
|
|
|||
| /// SMTP Authentication method. | |||
| public enum SMTPAuthMethod: String, CaseIterable { | |||
There was a problem hiding this comment.
See this PR for a related implementation: hummingbird-project/hummingbird#361
| /// Type for building a correct credentials for PLAIN SMTP auth. | ||
| public struct SMTPPlainCreds: SMTPClientRequest { | ||
| public let user: String | ||
| public let password: String | ||
|
|
||
| public var text: String { | ||
| "\0\(user)\0\(password)" | ||
| } | ||
| } |
There was a problem hiding this comment.
Do we need this to be public?
| /// Type for building a correct credentials for PLAIN SMTP auth. | |
| public struct SMTPPlainCreds: SMTPClientRequest { | |
| public let user: String | |
| public let password: String | |
| public var text: String { | |
| "\0\(user)\0\(password)" | |
| } | |
| } | |
| /// Type for building a correct credentials for PLAIN SMTP auth. | |
| struct SMTPPlainCreds: SMTPClientRequest { | |
| let user: String | |
| let password: String | |
| var text: String { | |
| "\0\(user)\0\(password)" | |
| } | |
| } |
|
|
||
| try await self.send(.authenticatePassword(password)) | ||
| .status(.authSucceeded, or: SMTPError.loginFailure) | ||
| public func login(user: String, password: String, force method: SMTPAuthMethod? = nil) async throws { |
There was a problem hiding this comment.
| public func login(user: String, password: String, force method: SMTPAuthMethod? = nil) async throws { | |
| /// Authenticates to the SMTP server. If `method` is `nil`, the method will be chosen automatically. Otherwise | |
| /// the requested method will be used | |
| public func login(user: String, password: String, method: SMTPAuthMethod? = nil) async throws { |
|
I'm going to add these changes into #14 |
|
My apologies for the silence for so long. II'll try to push requested changes this week. |
