Module: Devise::Models::Confirmable

Extended by:
ActiveSupport::Concern
Defined in:
lib/devise/models/confirmable.rb

Overview

Confirmable is responsible to verify if an account is already confirmed to sign in, and to send emails with confirmation instructions. Confirmation instructions are sent to the user email after creating a record, after updating it’s email and also when manually requested by a new confirmation instruction request. Whenever the user update it’s email, his account is automatically unconfirmed, it means it won’t be able to sign in again without confirming the account again through the email that was sent.

Configuration:

confirm_within: the time you want the user will have to confirm it's account
                without blocking his access. When confirm_within is zero, the
                user won't be able to sign in without confirming. You can
                use this to let your user access some features of your
                application without confirming the account, but blocking it
                after a certain period (ie 7 days). By default confirm_within is
                zero, it means users always have to confirm to sign in.

Examples:

User.find(1).confirm!      # returns true unless it's already confirmed
User.find(1).confirmed?    # true/false
User.find(1).send_confirmation_instructions # manually send instructions
User.find(1).resend_confirmation! # generates a new token and resent it

Defined Under Namespace

Modules: ClassMethods

Instance Method Summary collapse

Instance Method Details

#active? ⇒ Boolean

Overwrites active? from Devise::Models::Activatable for confirmation by verifying whether an user is active to sign in or not. If the user is already confirmed, it should never be blocked. Otherwise we need to calculate if the confirm time has not expired for this user.

Returns:

  • (Boolean) 


66
67
68
 
# File 'lib/devise/models/confirmable.rb', line 66

def active?
  super && (!confirmation_required? || confirmed? || confirmation_period_valid?)
end

#confirm! ⇒ Object

Confirm a user by setting it’s confirmed_at to actual time. If the user is already confirmed, add en error to email field



38
39
40
41
42
43
44
 
# File 'lib/devise/models/confirmable.rb', line 38

def confirm!
  unless_confirmed do
    self.confirmation_token = nil
    self.confirmed_at = Time.now
    save(:validate => false)
  end
end

#confirmed? ⇒ Boolean

Verifies whether a user is confirmed or not

Returns:

  • (Boolean) 


47
48
49
 
# File 'lib/devise/models/confirmable.rb', line 47

def confirmed?
  !!confirmed_at
end

#inactive_message ⇒ Object

The message to be shown if the account is inactive.



71
72
73
 
# File 'lib/devise/models/confirmable.rb', line 71

def inactive_message
  !confirmed? ? :unconfirmed : super
end

#resend_confirmation_token ⇒ Object

Resend confirmation token. This method does not need to generate a new token.



58
59
60
 
# File 'lib/devise/models/confirmable.rb', line 58

def resend_confirmation_token
  unless_confirmed { send_confirmation_instructions }
end

#send_confirmation_instructions ⇒ Object

Send confirmation instructions by email



52
53
54
55
 
# File 'lib/devise/models/confirmable.rb', line 52

def send_confirmation_instructions
  generate_confirmation_token! if self.confirmation_token.nil?
  ::Devise.mailer.confirmation_instructions(self).deliver
end

#skip_confirmation! ⇒ Object

If you don’t want confirmation to be sent on create, neither a code to be generated, call skip_confirmation!



77
78
79
 
# File 'lib/devise/models/confirmable.rb', line 77

def skip_confirmation!
  self.confirmed_at = Time.now
end