EmailAddress

@objcMembers
public final class EmailAddress : NSObject

Email address model.

Properties

  • Email address string value.

    Declaration

    Swift

    public let value: String

Methods

  • Initializes email address with a string value.

    Throws

    error in case if email address is invalid.

    Declaration

    Swift

    public required init(emailAddressString: String) throws

    Parameters

    emailAddressString

    Email address string.

  • Creates and returns an instance of EmailAddress with a given email address string.

    Declaration

    Swift

    @objc(withEmailAddressString:)
public static func with(_ emailAddressString: String) -> EmailAddress?

    Parameters

    emailAddressString

    Email address string.

    Return Value

    An instance of EmailAddress or nil if email address is not valid.

  • Checks if the receiver is equal to object.

    Declaration

    Swift

    public override func isEqual(_ object: Any?) -> Bool

    Parameters

    object

    Object to test equality with.

    Return Value

    true if the receiver is equal to object, false otherwise.

  • Checks if 2 objects are equal.

    Declaration

    Swift

    public static func == (lhs: EmailAddress, rhs: EmailAddress) -> Bool

    Parameters

    lhs

    First object.
    rhs

    Second object.

    Return Value

    true if 2 objects are equal, fale otherwise.

Encodable

  • Encodes the contents of the receiver.

    Throws

    EncodingError

    Declaration

    Swift

    public func encode(to encoder: Encoder) throws

    Parameters

    encoder

    Encoder.

Decodable

  • Declaration

    Swift

    public convenience init(from decoder: Decoder) throws

NSCopying

  • Copies the receiver.

    Declaration

    Swift

    public func copy(with zone: NSZone? = nil) -> Any

    Parameters

    zone

    Zone.

    Return Value

    Copy of the receiver.