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 and when manually requested by a new confirmation instruction request.

Options

Confirmable adds the following options to devise_for:

* +allow_unconfirmed_access_for+: the time you want to allow the user to access his 
  before confirming it. After this period, the user access is denied. You can
  use this to let your user access some features of your application without
  confirming the , but blocking it after a certain period (ie 7 days).
  By default allow_unconfirmed_access_for is zero, it means users always have to confirm to sign in.
* +reconfirmable+: requires any email changes to be confirmed (exactly the same way as
  initial  confirmation) to be applied. Requires additional unconfirmed_email
  db field to be setup (t.reconfirmable in migrations). Until confirmed new email is
  stored in unconfirmed email column, and copied to email column on successful
  confirmation.

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

Defined Under Namespace

Modules: ClassMethods

Instance Method Summary collapse

Instance Method Details

#active_for_authentication? ⇒ Boolean

Overwrites active_for_authentication? for confirmation by verifying whether a 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) 


87
88
89
 
# File 'lib/devise/models/confirmable.rb', line 87

def active_for_authentication?
  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 an error to email field. If the user is invalid add errors



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/devise/models/confirmable.rb', line 42

def confirm!
  pending_any_confirmation do
    self.confirmation_token = nil
    self.confirmed_at = Time.now.utc

    if self.class.reconfirmable && unconfirmed_email.present?
      @bypass_postpone = true
      self.email = unconfirmed_email
      self.unconfirmed_email = nil

      # We need to validate in such cases to enforce e-mail uniqueness
      save(:validate => true)
    else
      save(:validate => false)
    end
  end
end

#confirmed? ⇒ Boolean

Verifies whether a user is confirmed or not

Returns:

  • (Boolean) 


61
62
63
 
# File 'lib/devise/models/confirmable.rb', line 61

def confirmed?
  !!confirmed_at
end

#headers_for(action) ⇒ Object 



102
103
104
105
106
107
108
 
# File 'lib/devise/models/confirmable.rb', line 102

def headers_for(action)
  headers = super
  if action == :confirmation_instructions && pending_reconfirmation?
    headers[:to] = unconfirmed_email
  end
  headers
end

#inactive_message ⇒ Object

The message to be shown if the account is inactive.



92
93
94
 
# File 'lib/devise/models/confirmable.rb', line 92

def inactive_message
  !confirmed? ? :unconfirmed : super
end

#pending_reconfirmation? ⇒ Boolean

Returns:

  • (Boolean) 


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

def pending_reconfirmation?
  self.class.reconfirmable && unconfirmed_email.present?
end

#resend_confirmation_token ⇒ Object

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



79
80
81
 
# File 'lib/devise/models/confirmable.rb', line 79

def resend_confirmation_token
  pending_any_confirmation { send_confirmation_instructions }
end

#send_confirmation_instructions ⇒ Object

Send confirmation instructions by email



70
71
72
73
74
75
76
 
# File 'lib/devise/models/confirmable.rb', line 70

def send_confirmation_instructions
  self.confirmation_token = nil if reconfirmation_required?
  @reconfirmation_required = false

  generate_confirmation_token! if self.confirmation_token.blank?
  self.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!



98
99
100
 
# File 'lib/devise/models/confirmable.rb', line 98

def skip_confirmation!
  self.confirmed_at = Time.now.utc
end