# typed: true
# DO NOT EDIT MANUALLY
# This is an autogenerated file for types exported from the `actionmailer` gem.
# Please instead update this file by running `bin/tapioca gem actionmailer`.
# source://actionmailer-7.0.3.1/lib/action_mailer/gem_version.rb:3
module ActionMailer
extend ::ActiveSupport::Autoload
class << self
# source://actionmailer-7.0.3.1/lib/action_mailer.rb:56
def eager_load!; end
# Returns the currently loaded version of Action Mailer as a Gem::Version.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/gem_version.rb:5
def gem_version; end
# Returns the currently loaded version of Action Mailer as a
# Gem::Version.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/version.rb:8
def version; end
end
end
# Action Mailer allows you to send email from your application using a mailer model and views.
#
# = Mailer Models
#
# To use Action Mailer, you need to create a mailer model.
#
# $ bin/rails generate mailer Notifier
#
# The generated model inherits from ApplicationMailer which in turn
# inherits from ActionMailer::Base. A mailer model defines methods
# used to generate an email message. In these methods, you can set up variables to be used in
# the mailer views, options on the mail itself such as the :from address, and attachments.
#
# class ApplicationMailer < ActionMailer::Base
# default from: 'from@example.com'
# layout 'mailer'
# end
#
# class NotifierMailer < ApplicationMailer
# default from: 'no-reply@example.com',
# return_path: 'system@example.com'
#
# def welcome(recipient)
# @account = recipient
# mail(to: recipient.email_address_with_name,
# bcc: ["bcc@example.com", "Order Watcher "])
# end
# end
#
# Within the mailer method, you have access to the following methods:
#
# * attachments[]= - Allows you to add attachments to your email in an intuitive
# manner; attachments['filename.png'] = File.read('path/to/filename.png')
#
# * attachments.inline[]= - Allows you to add an inline attachment to your email
# in the same manner as attachments[]=
#
# * headers[]= - Allows you to specify any header field in your email such
# as headers['X-No-Spam'] = 'True'. Note that declaring a header multiple times
# will add many fields of the same name. Read #headers doc for more information.
#
# * headers(hash) - Allows you to specify multiple headers in your email such
# as headers({'X-No-Spam' => 'True', 'In-Reply-To' => '1234@message.id'})
#
# * mail - Allows you to specify email to be sent.
#
# The hash passed to the mail method allows you to specify any header that a Mail::Message
# will accept (any valid email header including optional fields).
#
# The +mail+ method, if not passed a block, will inspect your views and send all the views with
# the same name as the method, so the above action would send the +welcome.text.erb+ view
# file as well as the +welcome.html.erb+ view file in a +multipart/alternative+ email.
#
# If you want to explicitly render only certain templates, pass a block:
#
# mail(to: user.email) do |format|
# format.text
# format.html
# end
#
# The block syntax is also useful in providing information specific to a part:
#
# mail(to: user.email) do |format|
# format.html
# end
#
# Or even to render a special view:
#
# mail(to: user.email) do |format|
# format.text
# format.html { render "some_other_template" }
# end
#
# = Mailer views
#
# Like Action Controller, each mailer class has a corresponding view directory in which each
# method of the class looks for a template with its name.
#
# To define a template to be used with a mailer, create an .erb file with the same
# name as the method in your mailer model. For example, in the mailer defined above, the template at
# app/views/notifier_mailer/welcome.text.erb would be used to generate the email.
#
# Variables defined in the methods of your mailer model are accessible as instance variables in their
# corresponding view.
#
# Emails by default are sent in plain text, so a sample view for our model example might look like this:
#
# Hi <%= @account.name %>,
# Thanks for joining our service! Please check back often.
#
# You can even use Action View helpers in these views. For example:
#
# You got a new note!
# <%= truncate(@note.body, length: 25) %>
#
# If you need to access the subject, from, or the recipients in the view, you can do that through message object:
#
# You got a new note from <%= message.from %>!
# <%= truncate(@note.body, length: 25) %>
#
#
# = Generating URLs
#
# URLs can be generated in mailer views using url_for or named routes. Unlike controllers from
# Action Pack, the mailer instance doesn't have any context about the incoming request, so you'll need
# to provide all of the details needed to generate a URL.
#
# When using url_for you'll need to provide the :host, :controller, and :action:
#
# <%= url_for(host: "example.com", controller: "welcome", action: "greeting") %>
#
# When using named routes you only need to supply the :host:
#
# <%= users_url(host: "example.com") %>
#
# You should use the named_route_url style (which generates absolute URLs) and avoid using the
# named_route_path style (which generates relative URLs), since clients reading the mail will
# have no concept of a current URL from which to determine a relative path.
#
# It is also possible to set a default host that will be used in all mailers by setting the :host
# option as a configuration option in config/application.rb:
#
# config.action_mailer.default_url_options = { host: "example.com" }
#
# You can also define a default_url_options method on individual mailers to override these
# default settings per-mailer.
#
# By default when config.force_ssl is +true+, URLs generated for hosts will use the HTTPS protocol.
#
# = Sending mail
#
# Once a mailer action and template are defined, you can deliver your message or defer its creation and
# delivery for later:
#
# NotifierMailer.welcome(User.first).deliver_now # sends the email
# mail = NotifierMailer.welcome(User.first) # => an ActionMailer::MessageDelivery object
# mail.deliver_now # generates and sends the email now
#
# The ActionMailer::MessageDelivery class is a wrapper around a delegate that will call
# your method to generate the mail. If you want direct access to the delegator, or Mail::Message,
# you can call the message method on the ActionMailer::MessageDelivery object.
#
# NotifierMailer.welcome(User.first).message # => a Mail::Message object
#
# Action Mailer is nicely integrated with Active Job so you can generate and send emails in the background
# (example: outside of the request-response cycle, so the user doesn't have to wait on it):
#
# NotifierMailer.welcome(User.first).deliver_later # enqueue the email sending to Active Job
#
# Note that deliver_later will execute your method from the background job.
#
# You never instantiate your mailer class. Rather, you just call the method you defined on the class itself.
# All instance methods are expected to return a message object to be sent.
#
# = Multipart Emails
#
# Multipart messages can also be used implicitly because Action Mailer will automatically detect and use
# multipart templates, where each template is named after the name of the action, followed by the content
# type. Each such detected template will be added to the message, as a separate part.
#
# For example, if the following templates exist:
# * signup_notification.text.erb
# * signup_notification.html.erb
# * signup_notification.xml.builder
# * signup_notification.yml.erb
#
# Each would be rendered and added as a separate part to the message, with the corresponding content
# type. The content type for the entire message is automatically set to multipart/alternative,
# which indicates that the email contains multiple different representations of the same email
# body. The same instance variables defined in the action are passed to all email templates.
#
# Implicit template rendering is not performed if any attachments or parts have been added to the email.
# This means that you'll have to manually add each part to the email and set the content type of the email
# to multipart/alternative.
#
# = Attachments
#
# Sending attachment in emails is easy:
#
# class NotifierMailer < ApplicationMailer
# def welcome(recipient)
# attachments['free_book.pdf'] = File.read('path/to/file.pdf')
# mail(to: recipient, subject: "New account information")
# end
# end
#
# Which will (if it had both a welcome.text.erb and welcome.html.erb
# template in the view directory), send a complete multipart/mixed email with two parts,
# the first part being a multipart/alternative with the text and HTML email parts inside,
# and the second being a application/pdf with a Base64 encoded copy of the file.pdf book
# with the filename +free_book.pdf+.
#
# If you need to send attachments with no content, you need to create an empty view for it,
# or add an empty body parameter like this:
#
# class NotifierMailer < ApplicationMailer
# def welcome(recipient)
# attachments['free_book.pdf'] = File.read('path/to/file.pdf')
# mail(to: recipient, subject: "New account information", body: "")
# end
# end
#
# You can also send attachments with html template, in this case you need to add body, attachments,
# and custom content type like this:
#
# class NotifierMailer < ApplicationMailer
# def welcome(recipient)
# attachments["free_book.pdf"] = File.read("path/to/file.pdf")
# mail(to: recipient,
# subject: "New account information",
# content_type: "text/html",
# body: "Hello there")
# end
# end
#
# = Inline Attachments
#
# You can also specify that a file should be displayed inline with other HTML. This is useful
# if you want to display a corporate logo or a photo.
#
# class NotifierMailer < ApplicationMailer
# def welcome(recipient)
# attachments.inline['photo.png'] = File.read('path/to/photo.png')
# mail(to: recipient, subject: "Here is what we look like")
# end
# end
#
# And then to reference the image in the view, you create a welcome.html.erb file and
# make a call to +image_tag+ passing in the attachment you want to display and then call
# +url+ on the attachment to get the relative content id path for the image source:
#
# Please Don't Cringe
#
# <%= image_tag attachments['photo.png'].url -%>
#
# As we are using Action View's +image_tag+ method, you can pass in any other options you want:
#
# Please Don't Cringe
#
# <%= image_tag attachments['photo.png'].url, alt: 'Our Photo', class: 'photo' -%>
#
# = Observing and Intercepting Mails
#
# Action Mailer provides hooks into the Mail observer and interceptor methods. These allow you to
# register classes that are called during the mail delivery life cycle.
#
# An observer class must implement the :delivered_email(message) method which will be
# called once for every email sent after the email has been sent.
#
# An interceptor class must implement the :delivering_email(message) method which will be
# called before the email is sent, allowing you to make modifications to the email before it hits
# the delivery agents. Your class should make any needed modifications directly to the passed
# in Mail::Message instance.
#
# = Default Hash
#
# Action Mailer provides some intelligent defaults for your emails, these are usually specified in a
# default method inside the class definition:
#
# class NotifierMailer < ApplicationMailer
# default sender: 'system@example.com'
# end
#
# You can pass in any header value that a Mail::Message accepts. Out of the box,
# ActionMailer::Base sets the following:
#
# * mime_version: "1.0"
# * charset: "UTF-8"
# * content_type: "text/plain"
# * parts_order: [ "text/plain", "text/enriched", "text/html" ]
#
# parts_order and charset are not actually valid Mail::Message header fields,
# but Action Mailer translates them appropriately and sets the correct values.
#
# As you can pass in any header, you need to either quote the header as a string, or pass it in as
# an underscored symbol, so the following will work:
#
# class NotifierMailer < ApplicationMailer
# default 'Content-Transfer-Encoding' => '7bit',
# content_description: 'This is a description'
# end
#
# Finally, Action Mailer also supports passing Proc and Lambda objects into the default hash,
# so you can define methods that evaluate as the message is being generated:
#
# class NotifierMailer < ApplicationMailer
# default 'X-Special-Header' => Proc.new { my_method }, to: -> { @inviter.email_address }
#
# private
# def my_method
# 'some complex call'
# end
# end
#
# Note that the proc/lambda is evaluated right at the start of the mail message generation, so if you
# set something in the default hash using a proc, and then set the same thing inside of your
# mailer method, it will get overwritten by the mailer method.
#
# It is also possible to set these default options that will be used in all mailers through
# the default_options= configuration in config/application.rb:
#
# config.action_mailer.default_options = { from: "no-reply@example.org" }
#
# = Callbacks
#
# You can specify callbacks using before_action and after_action for configuring your messages.
# This may be useful, for example, when you want to add default inline attachments for all
# messages sent out by a certain mailer class:
#
# class NotifierMailer < ApplicationMailer
# before_action :add_inline_attachment!
#
# def welcome
# mail
# end
#
# private
# def add_inline_attachment!
# attachments.inline["footer.jpg"] = File.read('/path/to/filename.jpg')
# end
# end
#
# Callbacks in Action Mailer are implemented using
# AbstractController::Callbacks, so you can define and configure
# callbacks in the same manner that you would use callbacks in classes that
# inherit from ActionController::Base.
#
# Note that unless you have a specific reason to do so, you should prefer
# using before_action rather than after_action in your
# Action Mailer classes so that headers are parsed properly.
#
# = Rescuing Errors
#
# +rescue+ blocks inside of a mailer method cannot rescue errors that occur
# outside of rendering -- for example, record deserialization errors in a
# background job, or errors from a third-party mail delivery service.
#
# To rescue errors that occur during any part of the mailing process, use
# {rescue_from}[rdoc-ref:ActiveSupport::Rescuable::ClassMethods#rescue_from]:
#
# class NotifierMailer < ApplicationMailer
# rescue_from ActiveJob::DeserializationError do
# # ...
# end
#
# rescue_from "SomeThirdPartyService::ApiError" do
# # ...
# end
#
# def notify(recipient)
# mail(to: recipient, subject: "Notification")
# end
# end
#
# = Previewing emails
#
# You can preview your email templates visually by adding a mailer preview file to the
# ActionMailer::Base.preview_path. Since most emails do something interesting
# with database data, you'll need to write some scenarios to load messages with fake data:
#
# class NotifierMailerPreview < ActionMailer::Preview
# def welcome
# NotifierMailer.welcome(User.first)
# end
# end
#
# Methods must return a Mail::Message object which can be generated by calling the mailer
# method without the additional deliver_now / deliver_later. The location of the
# mailer previews directory can be configured using the preview_path option which has a default
# of test/mailers/previews:
#
# config.action_mailer.preview_path = "#{Rails.root}/lib/mailer_previews"
#
# An overview of all previews is accessible at http://localhost:3000/rails/mailers
# on a running development server instance.
#
# Previews can also be intercepted in a similar manner as deliveries can be by registering
# a preview interceptor that has a previewing_email method:
#
# class CssInlineStyler
# def self.previewing_email(message)
# # inline CSS styles
# end
# end
#
# config.action_mailer.preview_interceptors :css_inline_styler
#
# Note that interceptors need to be registered both with register_interceptor
# and register_preview_interceptor if they should operate on both sending and
# previewing emails.
#
# = Configuration options
#
# These options are specified on the class level, like
# ActionMailer::Base.raise_delivery_errors = true
#
# * default_options - You can pass this in at a class level as well as within the class itself as
# per the above section.
#
# * logger - the logger is used for generating information on the mailing run if available.
# Can be set to +nil+ for no logging. Compatible with both Ruby's own +Logger+ and Log4r loggers.
#
# * smtp_settings - Allows detailed configuration for :smtp delivery method:
# * :address - Allows you to use a remote mail server. Just change it from its default
# "localhost" setting.
# * :port - On the off chance that your mail server doesn't run on port 25, you can change it.
# * :domain - If you need to specify a HELO domain, you can do it here.
# * :user_name - If your mail server requires authentication, set the username in this setting.
# * :password - If your mail server requires authentication, set the password in this setting.
# * :authentication - If your mail server requires authentication, you need to specify the
# authentication type here.
# This is a symbol and one of :plain (will send the password Base64 encoded), :login (will
# send the password Base64 encoded) or :cram_md5 (combines a Challenge/Response mechanism to exchange
# information and a cryptographic Message Digest 5 algorithm to hash important information)
# * :enable_starttls - Use STARTTLS when connecting to your SMTP server and fail if unsupported. Defaults to false.
# * :enable_starttls_auto - Detects if STARTTLS is enabled in your SMTP server and starts
# to use it. Defaults to true.
# * :openssl_verify_mode - When using TLS, you can set how OpenSSL checks the certificate. This is
# really useful if you need to validate a self-signed and/or a wildcard certificate. You can use the name
# of an OpenSSL verify constant ('none' or 'peer') or directly the constant
# (OpenSSL::SSL::VERIFY_NONE or OpenSSL::SSL::VERIFY_PEER).
# * :ssl/:tls Enables the SMTP connection to use SMTP/TLS (SMTPS: SMTP over direct TLS connection)
# * :open_timeout Number of seconds to wait while attempting to open a connection.
# * :read_timeout Number of seconds to wait until timing-out a read(2) call.
#
# * sendmail_settings - Allows you to override options for the :sendmail delivery method.
# * :location - The location of the sendmail executable. Defaults to /usr/sbin/sendmail.
# * :arguments - The command line arguments. Defaults to -i with -f sender@address
# added automatically before the message is sent.
#
# * file_settings - Allows you to override options for the :file delivery method.
# * :location - The directory into which emails will be written. Defaults to the application
# tmp/mails.
#
# * raise_delivery_errors - Whether or not errors should be raised if the email fails to be delivered.
#
# * delivery_method - Defines a delivery method. Possible values are :smtp (default),
# :sendmail, :test, and :file. Or you may provide a custom delivery method
# object e.g. +MyOwnDeliveryMethodClass+. See the Mail gem documentation on the interface you need to
# implement for a custom delivery agent.
#
# * perform_deliveries - Determines whether emails are actually sent from Action Mailer when you
# call .deliver on an email message or on an Action Mailer method. This is on by default but can
# be turned off to aid in functional testing.
#
# * deliveries - Keeps an array of all the emails sent out through the Action Mailer with
# delivery_method :test. Most useful for unit and functional testing.
#
# * delivery_job - The job class used with deliver_later. Defaults to
# +ActionMailer::MailDeliveryJob+.
#
# * deliver_later_queue_name - The name of the queue used with deliver_later.
#
# @abstract It cannont be directly instantiated. Subclasses must implement the `abstract` methods below.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:466
class ActionMailer::Base < ::AbstractController::Base
include ::ActionMailer::DeliveryMethods
include ::ActiveSupport::Rescuable
include ::ActionMailer::Rescuable
include ::ActionMailer::Parameterized
include ::ActionMailer::Previews
include ::ActionView::ViewPaths
include ::AbstractController::Rendering
include ::AbstractController::Logger
include ::ActiveSupport::Benchmarkable
include ::AbstractController::Helpers
include ::AbstractController::Translation
include ::AbstractController::AssetPaths
include ::ActiveSupport::Callbacks
include ::AbstractController::Callbacks
include ::AbstractController::Caching::Fragments
include ::AbstractController::Caching::ConfigMethods
include ::AbstractController::Caching
include ::ActionView::Rendering
include ::ActionView::Layouts
extend ::ActionMailer::DeliveryMethods::ClassMethods
extend ::ActiveSupport::Rescuable::ClassMethods
extend ::ActionMailer::Rescuable::ClassMethods
extend ::ActionMailer::Parameterized::ClassMethods
extend ::ActionMailer::Previews::ClassMethods
extend ::ActionView::ViewPaths::ClassMethods
extend ::AbstractController::Helpers::ClassMethods
extend ::ActiveSupport::Callbacks::ClassMethods
extend ::AbstractController::Callbacks::ClassMethods
extend ::AbstractController::Caching::Fragments::ClassMethods
extend ::AbstractController::Caching::ClassMethods
extend ::AbstractController::Caching::ConfigMethods
extend ::ActionView::Rendering::ClassMethods
extend ::ActionView::Layouts::ClassMethods
# @return [Base] a new instance of Base
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:632
def initialize; end
# source://activesupport-7.0.3.1/lib/active_support/callbacks.rb:68
def __callbacks; end
# source://activesupport-7.0.3.1/lib/active_support/callbacks.rb:68
def __callbacks?; end
# source://actionpack-7.0.3.1/lib/abstract_controller/helpers.rb:11
def _helper_methods; end
# source://actionpack-7.0.3.1/lib/abstract_controller/helpers.rb:11
def _helper_methods=(_arg0); end
# source://actionpack-7.0.3.1/lib/abstract_controller/helpers.rb:11
def _helper_methods?; end
# source://activesupport-7.0.3.1/lib/active_support/callbacks.rb:940
def _process_action_callbacks; end
# source://activesupport-7.0.3.1/lib/active_support/callbacks.rb:928
def _run_process_action_callbacks(&block); end
# source://actionpack-7.0.3.1/lib/abstract_controller/caching.rb:42
def _view_cache_dependencies; end
# source://actionpack-7.0.3.1/lib/abstract_controller/caching.rb:42
def _view_cache_dependencies=(_arg0); end
# source://actionpack-7.0.3.1/lib/abstract_controller/caching.rb:42
def _view_cache_dependencies?; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:113
def asset_host; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:114
def asset_host=(value); end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:113
def assets_dir; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:114
def assets_dir=(value); end
# Allows you to add attachments to an email, like so:
#
# mail.attachments['filename.jpg'] = File.read('/path/to/filename.jpg')
#
# If you do this, then Mail will take the file name and work out the mime type.
# It will also set the Content-Type, Content-Disposition, Content-Transfer-Encoding
# and encode the contents of the attachment in Base64.
#
# You can also specify overrides if you want by passing a hash instead of a string:
#
# mail.attachments['filename.jpg'] = {mime_type: 'application/gzip',
# content: File.read('/path/to/filename.jpg')}
#
# If you want to use encoding other than Base64 then you will need to pass encoding
# type along with the pre-encoded content as Mail doesn't know how to decode the
# data:
#
# file_content = SpecialEncode(File.read('/path/to/filename.jpg'))
# mail.attachments['filename.jpg'] = {mime_type: 'application/gzip',
# content: file_content }
#
# You can also search for specific attachments:
#
# # By Filename
# mail.attachments['filename.jpg'] # => Mail::Part object or nil
#
# # or by index
# mail.attachments[0] # => Mail::Part (first attachment)
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:749
def attachments; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:113
def default_asset_host_protocol; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:114
def default_asset_host_protocol=(value); end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:490
def default_params; end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:490
def default_params=(_arg0); end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:490
def default_params?; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:113
def default_static_extension; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:114
def default_static_extension=(value); end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:15
def deliver_later_queue_name; end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:15
def deliver_later_queue_name=(val); end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:489
def delivery_job; end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:489
def delivery_job=(_arg0); end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:489
def delivery_job?; end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:18
def delivery_method; end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:18
def delivery_method=(_arg0); end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:18
def delivery_method?; end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:17
def delivery_methods; end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:17
def delivery_methods=(_arg0); end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:17
def delivery_methods?; end
# Returns an email in the format "Name ".
#
# If the name is a blank string, it returns just the address.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:673
def email_address_with_name(address, name); end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:113
def enable_fragment_cache_logging; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:114
def enable_fragment_cache_logging=(value); end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:51
def file_settings; end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:51
def file_settings=(_arg0); end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:51
def file_settings?; end
# source://actionpack-7.0.3.1/lib/abstract_controller/caching/fragments.rb:23
def fragment_cache_keys; end
# source://actionpack-7.0.3.1/lib/abstract_controller/caching/fragments.rb:23
def fragment_cache_keys=(_arg0); end
# source://actionpack-7.0.3.1/lib/abstract_controller/caching/fragments.rb:23
def fragment_cache_keys?; end
# Allows you to pass random and unusual headers to the new Mail::Message
# object which will add them to itself.
#
# headers['X-Special-Domain-Specific-Header'] = "SecretValue"
#
# You can also pass a hash into headers of header field names and values,
# which will then be set on the Mail::Message object:
#
# headers 'X-Special-Domain-Specific-Header' => "SecretValue",
# 'In-Reply-To' => incoming.message_id
#
# The resulting Mail::Message will have the following in its header:
#
# X-Special-Domain-Specific-Header: SecretValue
#
# Note about replacing already defined headers:
#
# * +subject+
# * +sender+
# * +from+
# * +to+
# * +cc+
# * +bcc+
# * +reply-to+
# * +orig-date+
# * +message-id+
# * +references+
#
# Fields can only appear once in email headers while other fields such as
# X-Anything can appear multiple times.
#
# If you want to replace any header which already exists, first set it to
# +nil+ in order to reset the value otherwise another field will be added
# for the same header.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:711
def headers(args = T.unsafe(nil)); end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:113
def javascripts_dir; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:114
def javascripts_dir=(value); end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:113
def logger; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:114
def logger=(value); end
# The main method that creates the message and renders the email templates. There are
# two ways to call this method, with a block, or without a block.
#
# It accepts a headers hash. This hash allows you to specify
# the most used headers in an email message, these are:
#
# * +:subject+ - The subject of the message, if this is omitted, Action Mailer will
# ask the Rails I18n class for a translated +:subject+ in the scope of
# [mailer_scope, action_name] or if this is missing, will translate the
# humanized version of the +action_name+
# * +:to+ - Who the message is destined for, can be a string of addresses, or an array
# of addresses.
# * +:from+ - Who the message is from
# * +:cc+ - Who you would like to Carbon-Copy on this email, can be a string of addresses,
# or an array of addresses.
# * +:bcc+ - Who you would like to Blind-Carbon-Copy on this email, can be a string of
# addresses, or an array of addresses.
# * +:reply_to+ - Who to set the Reply-To header of the email to.
# * +:date+ - The date to say the email was sent on.
#
# You can set default values for any of the above headers (except +:date+)
# by using the ::default class method:
#
# class Notifier < ActionMailer::Base
# default from: 'no-reply@test.lindsaar.net',
# bcc: 'email_logger@test.lindsaar.net',
# reply_to: 'bounces@test.lindsaar.net'
# end
#
# If you need other headers not listed above, you can either pass them in
# as part of the headers hash or use the headers['name'] = value
# method.
#
# When a +:return_path+ is specified as header, that value will be used as
# the 'envelope from' address for the Mail message. Setting this is useful
# when you want delivery notifications sent to a different address than the
# one in +:from+. Mail will actually use the +:return_path+ in preference
# to the +:sender+ in preference to the +:from+ field for the 'envelope
# from' value.
#
# If you do not pass a block to the +mail+ method, it will find all
# templates in the view paths using by default the mailer name and the
# method name that it is being called from, it will then create parts for
# each of these templates intelligently, making educated guesses on correct
# content type and sequence, and return a fully prepared Mail::Message
# ready to call :deliver on to send.
#
# For example:
#
# class Notifier < ActionMailer::Base
# default from: 'no-reply@test.lindsaar.net'
#
# def welcome
# mail(to: 'mikel@test.lindsaar.net')
# end
# end
#
# Will look for all templates at "app/views/notifier" with name "welcome".
# If no welcome template exists, it will raise an ActionView::MissingTemplate error.
#
# However, those can be customized:
#
# mail(template_path: 'notifications', template_name: 'another')
#
# And now it will look for all templates at "app/views/notifications" with name "another".
#
# If you do pass a block, you can render specific templates of your choice:
#
# mail(to: 'mikel@test.lindsaar.net') do |format|
# format.text
# format.html
# end
#
# You can even render plain text directly without using a template:
#
# mail(to: 'mikel@test.lindsaar.net') do |format|
# format.text { render plain: "Hello Mikel!" }
# format.html { render html: "Hello Mikel!
".html_safe }
# end
#
# Which will render a +multipart/alternative+ email with +text/plain+ and
# +text/html+ parts.
#
# The block syntax also allows you to customize the part headers if desired:
#
# mail(to: 'mikel@test.lindsaar.net') do |format|
# format.html
# end
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:858
def mail(headers = T.unsafe(nil), &block); end
# Returns the name of the mailer object.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:666
def mailer_name; end
# source://activesupport-7.0.3.1/lib/active_support/core_ext/module/attr_internal.rb:33
def message; end
# source://activesupport-7.0.3.1/lib/active_support/core_ext/module/attr_internal.rb:33
def message=(_arg0); end
# source://actionmailer-7.0.3.1/lib/action_mailer/parameterized.rb:91
def params; end
# source://actionmailer-7.0.3.1/lib/action_mailer/parameterized.rb:91
def params=(_arg0); end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:113
def perform_caching; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:114
def perform_caching=(value); end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:14
def perform_deliveries; end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:14
def perform_deliveries=(val); end
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:25
def preview_interceptors; end
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:14
def preview_path; end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:638
def process(method_name, *args); end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:13
def raise_delivery_errors; end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:13
def raise_delivery_errors=(val); end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:113
def relative_url_root; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:114
def relative_url_root=(value); end
# source://activesupport-7.0.3.1/lib/active_support/rescuable.rb:13
def rescue_handlers; end
# source://activesupport-7.0.3.1/lib/active_support/rescuable.rb:13
def rescue_handlers=(_arg0); end
# source://activesupport-7.0.3.1/lib/active_support/rescuable.rb:13
def rescue_handlers?; end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:51
def sendmail_settings; end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:51
def sendmail_settings=(_arg0); end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:51
def sendmail_settings?; end
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:22
def show_previews; end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:51
def smtp_settings; end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:51
def smtp_settings=(_arg0); end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:51
def smtp_settings?; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:113
def stylesheets_dir; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:114
def stylesheets_dir=(value); end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:51
def test_settings; end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:51
def test_settings=(_arg0); end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:51
def test_settings?; end
private
# source://actionview-7.0.3.1/lib/action_view/layouts.rb:328
def _layout(lookup_context, formats); end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:1059
def _protected_ivars; end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:935
def apply_defaults(headers); end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:955
def assign_headers_to_message(message, headers); end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:961
def collect_responses(headers, &block); end
# @yield [collector]
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:971
def collect_responses_from_block(headers); end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:985
def collect_responses_from_templates(headers); end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:978
def collect_responses_from_text(headers); end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:945
def compute_default(value); end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:1028
def create_parts_from_responses(m, responses); end
# Translates the +subject+ using Rails I18n class under [mailer_scope, action_name] scope.
# If it does not find a translation for the +subject+ under the specified scope it will default to a
# humanized version of the action_name.
# If the subject has interpolations, you can pass them through the +interpolations+ parameter.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:925
def default_i18n_subject(interpolations = T.unsafe(nil)); end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:998
def each_template(paths, name, &block); end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:1041
def insert_part(container, response, charset); end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:1055
def instrument_name; end
# This and #instrument_name is for caching instrument
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:1048
def instrument_payload(key); end
# Used by #mail to set the content type of the message.
#
# It will use the given +user_content_type+, or multipart if the mail
# message has any attachments. If the attachments are inline, the content
# type will be "multipart/related", otherwise "multipart/mixed".
#
# If there is no content type passed in via headers, and there are no
# attachments, or the message is multipart, then the default content type is
# used.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:903
def set_content_type(m, user_content_type, class_default); end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:1007
def wrap_inline_attachments(message); end
class << self
# source://activesupport-7.0.3.1/lib/active_support/callbacks.rb:68
def __callbacks; end
# source://activesupport-7.0.3.1/lib/active_support/callbacks.rb:68
def __callbacks=(value); end
# source://activesupport-7.0.3.1/lib/active_support/callbacks.rb:68
def __callbacks?; end
# source://actionpack-7.0.3.1/lib/abstract_controller/helpers.rb:11
def _helper_methods; end
# source://actionpack-7.0.3.1/lib/abstract_controller/helpers.rb:11
def _helper_methods=(value); end
# source://actionpack-7.0.3.1/lib/abstract_controller/helpers.rb:11
def _helper_methods?; end
# source://actionpack-7.0.3.1/lib/abstract_controller/helpers.rb:15
def _helpers; end
# source://actionview-7.0.3.1/lib/action_view/layouts.rb:209
def _layout; end
# source://actionview-7.0.3.1/lib/action_view/layouts.rb:209
def _layout=(value); end
# source://actionview-7.0.3.1/lib/action_view/layouts.rb:209
def _layout?; end
# source://actionview-7.0.3.1/lib/action_view/layouts.rb:210
def _layout_conditions; end
# source://actionview-7.0.3.1/lib/action_view/layouts.rb:210
def _layout_conditions=(value); end
# source://actionview-7.0.3.1/lib/action_view/layouts.rb:210
def _layout_conditions?; end
# source://activesupport-7.0.3.1/lib/active_support/callbacks.rb:932
def _process_action_callbacks; end
# source://activesupport-7.0.3.1/lib/active_support/callbacks.rb:936
def _process_action_callbacks=(value); end
# source://actionpack-7.0.3.1/lib/abstract_controller/caching.rb:42
def _view_cache_dependencies; end
# source://actionpack-7.0.3.1/lib/abstract_controller/caching.rb:42
def _view_cache_dependencies=(value); end
# source://actionpack-7.0.3.1/lib/abstract_controller/caching.rb:42
def _view_cache_dependencies?; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:113
def asset_host; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:114
def asset_host=(value); end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:113
def assets_dir; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:114
def assets_dir=(value); end
# Returns the name of the current mailer. This method is also being used as a path for a view lookup.
# If this is an anonymous mailer, this method will return +anonymous+ instead.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:558
def controller_path; end
# Sets the defaults through app configuration:
#
# config.action_mailer.default(from: "no-reply@example.org")
#
# Aliased by ::default_options=
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:570
def default(value = T.unsafe(nil)); end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:113
def default_asset_host_protocol; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:114
def default_asset_host_protocol=(value); end
# Sets the defaults through app configuration:
#
# config.action_mailer.default(from: "no-reply@example.org")
#
# Aliased by ::default_options=
# Allows to set defaults through app configuration:
#
# config.action_mailer.default_options = { from: "no-reply@example.org" }
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:570
def default_options=(value = T.unsafe(nil)); end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:490
def default_params; end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:490
def default_params=(value); end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:490
def default_params?; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:113
def default_static_extension; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:114
def default_static_extension=(value); end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:15
def deliver_later_queue_name; end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:15
def deliver_later_queue_name=(val); end
# Wraps an email delivery inside of ActiveSupport::Notifications instrumentation.
#
# This method is actually called by the Mail::Message object itself
# through a callback when you call :deliver on the Mail::Message,
# calling +deliver_mail+ directly and passing a Mail::Message will do
# nothing except tell the logger you sent the email.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:585
def deliver_mail(mail); end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:489
def delivery_job; end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:489
def delivery_job=(value); end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:489
def delivery_job?; end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:18
def delivery_method; end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:18
def delivery_method=(value); end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:18
def delivery_method?; end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:17
def delivery_methods; end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:17
def delivery_methods=(value); end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:17
def delivery_methods?; end
# Returns an email in the format "Name ".
#
# If the name is a blank string, it returns just the address.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:595
def email_address_with_name(address, name); end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:113
def enable_fragment_cache_logging; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:114
def enable_fragment_cache_logging=(value); end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:51
def file_settings; end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:51
def file_settings=(value); end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:51
def file_settings?; end
# source://actionpack-7.0.3.1/lib/abstract_controller/caching/fragments.rb:23
def fragment_cache_keys; end
# source://actionpack-7.0.3.1/lib/abstract_controller/caching/fragments.rb:23
def fragment_cache_keys=(value); end
# source://actionpack-7.0.3.1/lib/abstract_controller/caching/fragments.rb:23
def fragment_cache_keys?; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:113
def javascripts_dir; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:114
def javascripts_dir=(value); end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:113
def logger; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:114
def logger=(value); end
# Returns the name of the current mailer. This method is also being used as a path for a view lookup.
# If this is an anonymous mailer, this method will return +anonymous+ instead.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:558
def mailer_name; end
# Allows to set the name of current mailer.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:562
def mailer_name=(_arg0); end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:113
def perform_caching; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:114
def perform_caching=(value); end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:14
def perform_deliveries; end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:14
def perform_deliveries=(val); end
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:25
def preview_interceptors; end
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:25
def preview_interceptors=(val); end
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:14
def preview_path; end
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:14
def preview_path=(val); end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:13
def raise_delivery_errors; end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:13
def raise_delivery_errors=(val); end
# Register an Interceptor which will be called before mail is sent.
# Either a class, string, or symbol can be passed in as the Interceptor.
# If a string or symbol is passed in it will be camelized and constantized.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:535
def register_interceptor(interceptor); end
# Register one or more Interceptors which will be called before mail is sent.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:509
def register_interceptors(*interceptors); end
# Register an Observer which will be notified when mail is delivered.
# Either a class, string, or symbol can be passed in as the Observer.
# If a string or symbol is passed in it will be camelized and constantized.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:521
def register_observer(observer); end
# Register one or more Observers which will be notified when mail is delivered.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:499
def register_observers(*observers); end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:113
def relative_url_root; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:114
def relative_url_root=(value); end
# source://activesupport-7.0.3.1/lib/active_support/rescuable.rb:13
def rescue_handlers; end
# source://activesupport-7.0.3.1/lib/active_support/rescuable.rb:13
def rescue_handlers=(value); end
# source://activesupport-7.0.3.1/lib/active_support/rescuable.rb:13
def rescue_handlers?; end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:51
def sendmail_settings; end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:51
def sendmail_settings=(value); end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:51
def sendmail_settings?; end
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:22
def show_previews; end
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:22
def show_previews=(val); end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:51
def smtp_settings; end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:51
def smtp_settings=(value); end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:51
def smtp_settings?; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:113
def stylesheets_dir; end
# source://activesupport-7.0.3.1/lib/active_support/configurable.rb:114
def stylesheets_dir=(value); end
# Emails do not support relative path links.
#
# @return [Boolean]
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:931
def supports_path?; end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:51
def test_settings; end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:51
def test_settings=(value); end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:51
def test_settings?; end
# Unregister a previously registered Interceptor.
# Either a class, string, or symbol can be passed in as the Interceptor.
# If a string or symbol is passed in it will be camelized and constantized.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:542
def unregister_interceptor(interceptor); end
# Unregister one or more previously registered Interceptors.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:514
def unregister_interceptors(*interceptors); end
# Unregister a previously registered Observer.
# Either a class, string, or symbol can be passed in as the Observer.
# If a string or symbol is passed in it will be camelized and constantized.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:528
def unregister_observer(observer); end
# Unregister one or more previously registered Observers.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:504
def unregister_observers(*observers); end
private
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:616
def method_missing(method_name, *args); end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:546
def observer_class_for(value); end
# @return [Boolean]
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:625
def respond_to_missing?(method, include_all = T.unsafe(nil)); end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:603
def set_payload_for_mail(payload, mail); end
end
end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:0
module ActionMailer::Base::HelperMethods
include ::ActionMailer::MailHelper
# source://actionpack-7.0.3.1/lib/abstract_controller/caching/fragments.rb:31
def combined_fragment_cache_key(*args, &block); end
# source://actionpack-7.0.3.1/lib/abstract_controller/caching.rb:43
def view_cache_dependencies(*args, &block); end
end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:757
class ActionMailer::Base::LateAttachmentsProxy < ::SimpleDelegator
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:759
def []=(_name, _content); end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:758
def inline; end
private
# @raise [RuntimeError]
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:762
def _raise_error; end
end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:652
class ActionMailer::Base::NullMail
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:653
def body; end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:654
def header; end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:660
def method_missing(*args); end
# @return [Boolean]
#
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:656
def respond_to?(string, include_all = T.unsafe(nil)); end
end
# source://actionmailer-7.0.3.1/lib/action_mailer/base.rb:485
ActionMailer::Base::PROTECTED_IVARS = T.let(T.unsafe(nil), Array)
# source://actionmailer-7.0.3.1/lib/action_mailer/collector.rb:8
class ActionMailer::Collector
include ::AbstractController::Collector
# @return [Collector] a new instance of Collector
#
# source://actionmailer-7.0.3.1/lib/action_mailer/collector.rb:12
def initialize(context, &block); end
# @raise [ArgumentError]
#
# source://actionmailer-7.0.3.1/lib/action_mailer/collector.rb:18
def all(*args, &block); end
# @raise [ArgumentError]
#
# source://actionmailer-7.0.3.1/lib/action_mailer/collector.rb:18
def any(*args, &block); end
# source://actionmailer-7.0.3.1/lib/action_mailer/collector.rb:25
def custom(mime, options = T.unsafe(nil)); end
# Returns the value of attribute responses.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/collector.rb:10
def responses; end
end
# This module handles everything related to mail delivery, from registering
# new delivery methods to configuring the mail object to be sent.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:8
module ActionMailer::DeliveryMethods
extend ::ActiveSupport::Concern
include GeneratedInstanceMethods
mixes_in_class_methods GeneratedClassMethods
mixes_in_class_methods ::ActionMailer::DeliveryMethods::ClassMethods
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:78
def wrap_delivery_behavior!(*args); end
module GeneratedClassMethods
def delivery_method; end
def delivery_method=(value); end
def delivery_method?; end
def delivery_methods; end
def delivery_methods=(value); end
def delivery_methods?; end
def file_settings; end
def file_settings=(value); end
def file_settings?; end
def sendmail_settings; end
def sendmail_settings=(value); end
def sendmail_settings?; end
def smtp_settings; end
def smtp_settings=(value); end
def smtp_settings?; end
def test_settings; end
def test_settings=(value); end
def test_settings?; end
end
module GeneratedInstanceMethods
def delivery_method; end
def delivery_method=(value); end
def delivery_method?; end
def delivery_methods; end
def delivery_methods=(value); end
def delivery_methods?; end
def file_settings; end
def file_settings=(value); end
def file_settings?; end
def sendmail_settings; end
def sendmail_settings=(value); end
def sendmail_settings?; end
def smtp_settings; end
def smtp_settings=(value); end
def smtp_settings?; end
def test_settings; end
def test_settings=(value); end
def test_settings?; end
end
end
# Helpers for creating and wrapping delivery behavior, used by DeliveryMethods.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:40
module ActionMailer::DeliveryMethods::ClassMethods
# Adds a new delivery method through the given class using the given
# symbol as alias and the default options supplied.
#
# add_delivery_method :sendmail, Mail::Sendmail,
# location: '/usr/sbin/sendmail',
# arguments: '-i'
#
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:50
def add_delivery_method(symbol, klass, default_options = T.unsafe(nil)); end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:42
def deliveries(*_arg0, &_arg1); end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:42
def deliveries=(arg); end
# source://actionmailer-7.0.3.1/lib/action_mailer/delivery_methods.rb:56
def wrap_delivery_behavior(mail, method = T.unsafe(nil), options = T.unsafe(nil)); end
end
# Implements a mailer preview interceptor that converts image tag src attributes
# that use inline cid: style URLs to data: style URLs so that they are visible
# when previewing an HTML email in a web browser.
#
# This interceptor is enabled by default. To disable it, delete it from the
# ActionMailer::Base.preview_interceptors array:
#
# ActionMailer::Base.preview_interceptors.delete(ActionMailer::InlinePreviewInterceptor)
#
# source://actionmailer-7.0.3.1/lib/action_mailer/inline_preview_interceptor.rb:15
class ActionMailer::InlinePreviewInterceptor
include ::Base64
# @return [InlinePreviewInterceptor] a new instance of InlinePreviewInterceptor
#
# source://actionmailer-7.0.3.1/lib/action_mailer/inline_preview_interceptor.rb:24
def initialize(message); end
# source://actionmailer-7.0.3.1/lib/action_mailer/inline_preview_interceptor.rb:28
def transform!; end
private
# source://actionmailer-7.0.3.1/lib/action_mailer/inline_preview_interceptor.rb:49
def data_url(part); end
# source://actionmailer-7.0.3.1/lib/action_mailer/inline_preview_interceptor.rb:53
def find_part(cid); end
# source://actionmailer-7.0.3.1/lib/action_mailer/inline_preview_interceptor.rb:45
def html_part; end
# Returns the value of attribute message.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/inline_preview_interceptor.rb:43
def message; end
class << self
# source://actionmailer-7.0.3.1/lib/action_mailer/inline_preview_interceptor.rb:20
def previewing_email(message); end
end
end
# source://actionmailer-7.0.3.1/lib/action_mailer/inline_preview_interceptor.rb:16
ActionMailer::InlinePreviewInterceptor::PATTERN = T.let(T.unsafe(nil), Regexp)
# Implements the ActiveSupport::LogSubscriber for logging notifications when
# email is delivered or received.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/log_subscriber.rb:9
class ActionMailer::LogSubscriber < ::ActiveSupport::LogSubscriber
# An email was delivered.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/log_subscriber.rb:10
def deliver(event); end
# Use the logger configured for ActionMailer::Base.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/log_subscriber.rb:33
def logger; end
# An email was generated.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/log_subscriber.rb:24
def process(event); end
end
# The ActionMailer::MailDeliveryJob class is used when you
# want to send emails outside of the request-response cycle. It supports
# sending either parameterized or normal mail.
#
# Exceptions are rescued and handled by the mailer class.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/mail_delivery_job.rb:11
class ActionMailer::MailDeliveryJob < ::ActiveJob::Base
# source://actionmailer-7.0.3.1/lib/action_mailer/mail_delivery_job.rb:16
def perform(mailer, mail_method, delivery_method, args:, kwargs: T.unsafe(nil), params: T.unsafe(nil)); end
private
# source://actionmailer-7.0.3.1/lib/action_mailer/mail_delivery_job.rb:35
def handle_exception_with_mailer_class(exception); end
# "Deserialize" the mailer class name by hand in case another argument
# (like a Global ID reference) raised DeserializationError.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/mail_delivery_job.rb:29
def mailer_class; end
class << self
# source://activejob-7.0.3.1/lib/active_job/queue_name.rb:56
def queue_name; end
# source://activesupport-7.0.3.1/lib/active_support/rescuable.rb:13
def rescue_handlers; end
end
end
# Provides helper methods for ActionMailer::Base that can be used for easily
# formatting messages, accessing mailer or message instances, and the
# attachments list.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/mail_helper.rb:7
module ActionMailer::MailHelper
# Access the message attachments list.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/mail_helper.rb:43
def attachments; end
# Take the text and format it, indented two spaces for each line, and
# wrapped at 72 columns:
#
# text = <<-TEXT
# This is
# the paragraph.
#
# * item1 * item2
# TEXT
#
# block_format text
# # => " This is the paragraph.\n\n * item1\n * item2\n"
#
# source://actionmailer-7.0.3.1/lib/action_mailer/mail_helper.rb:20
def block_format(text); end
# Returns +text+ wrapped at +len+ columns and indented +indent+ spaces.
# By default column length +len+ equals 72 characters and indent
# +indent+ equal two spaces.
#
# my_text = 'Here is a sample text with more than 40 characters'
#
# format_paragraph(my_text, 25, 4)
# # => " Here is a sample text with\n more than 40 characters"
#
# source://actionmailer-7.0.3.1/lib/action_mailer/mail_helper.rb:55
def format_paragraph(text, len = T.unsafe(nil), indent = T.unsafe(nil)); end
# Access the mailer instance.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/mail_helper.rb:33
def mailer; end
# Access the message instance.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/mail_helper.rb:38
def message; end
end
# The ActionMailer::MessageDelivery class is used by
# ActionMailer::Base when creating a new mailer.
# MessageDelivery is a wrapper (+Delegator+ subclass) around a lazy
# created Mail::Message. You can get direct access to the
# Mail::Message, deliver the email or schedule the email to be sent
# through Active Job.
#
# Notifier.welcome(User.first) # an ActionMailer::MessageDelivery object
# Notifier.welcome(User.first).deliver_now # sends the email
# Notifier.welcome(User.first).deliver_later # enqueue email delivery as a job through Active Job
# Notifier.welcome(User.first).message # a Mail::Message object
#
# source://actionmailer-7.0.3.1/lib/action_mailer/message_delivery.rb:17
class ActionMailer::MessageDelivery
# @return [MessageDelivery] a new instance of MessageDelivery
#
# source://actionmailer-7.0.3.1/lib/action_mailer/message_delivery.rb:18
def initialize(mailer_class, action, *args); end
# Method calls are delegated to the Mail::Message that's ready to deliver.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/message_delivery.rb:29
def __getobj__; end
# Unused except for delegator internals (dup, marshalling).
#
# source://actionmailer-7.0.3.1/lib/action_mailer/message_delivery.rb:34
def __setobj__(mail_message); end
# Enqueues the email to be delivered through Active Job. When the
# job runs it will send the email using +deliver_now+.
#
# Notifier.welcome(User.first).deliver_later
# Notifier.welcome(User.first).deliver_later(wait: 1.hour)
# Notifier.welcome(User.first).deliver_later(wait_until: 10.hours.from_now)
# Notifier.welcome(User.first).deliver_later(priority: 10)
#
# Options:
#
# * :wait - Enqueue the email to be delivered with a delay.
# * :wait_until - Enqueue the email to be delivered at (after) a specific date / time.
# * :queue - Enqueue the email on the specified queue.
# * :priority - Enqueues the email with the specified priority
#
# By default, the email will be enqueued using ActionMailer::MailDeliveryJob. Each
# ActionMailer::Base class can specify the job to use by setting the class variable
# +delivery_job+.
#
# class AccountRegistrationMailer < ApplicationMailer
# self.delivery_job = RegistrationDeliveryJob
# end
#
# source://actionmailer-7.0.3.1/lib/action_mailer/message_delivery.rb:98
def deliver_later(options = T.unsafe(nil)); end
# Enqueues the email to be delivered through Active Job. When the
# job runs it will send the email using +deliver_now!+. That means
# that the message will be sent bypassing checking +perform_deliveries+
# and +raise_delivery_errors+, so use with caution.
#
# Notifier.welcome(User.first).deliver_later!
# Notifier.welcome(User.first).deliver_later!(wait: 1.hour)
# Notifier.welcome(User.first).deliver_later!(wait_until: 10.hours.from_now)
# Notifier.welcome(User.first).deliver_later!(priority: 10)
#
# Options:
#
# * :wait - Enqueue the email to be delivered with a delay
# * :wait_until - Enqueue the email to be delivered at (after) a specific date / time
# * :queue - Enqueue the email on the specified queue
# * :priority - Enqueues the email with the specified priority
#
# By default, the email will be enqueued using ActionMailer::MailDeliveryJob. Each
# ActionMailer::Base class can specify the job to use by setting the class variable
# +delivery_job+.
#
# class AccountRegistrationMailer < ApplicationMailer
# self.delivery_job = RegistrationDeliveryJob
# end
#
# source://actionmailer-7.0.3.1/lib/action_mailer/message_delivery.rb:72
def deliver_later!(options = T.unsafe(nil)); end
# Delivers an email:
#
# Notifier.welcome(User.first).deliver_now
#
# source://actionmailer-7.0.3.1/lib/action_mailer/message_delivery.rb:117
def deliver_now; end
# Delivers an email without checking +perform_deliveries+ and +raise_delivery_errors+,
# so use with caution.
#
# Notifier.welcome(User.first).deliver_now!
#
# source://actionmailer-7.0.3.1/lib/action_mailer/message_delivery.rb:107
def deliver_now!; end
# Returns the resulting Mail::Message
#
# source://actionmailer-7.0.3.1/lib/action_mailer/message_delivery.rb:39
def message; end
# Was the delegate loaded, causing the mailer action to be processed?
#
# @return [Boolean]
#
# source://actionmailer-7.0.3.1/lib/action_mailer/message_delivery.rb:44
def processed?; end
private
# source://actionmailer-7.0.3.1/lib/action_mailer/message_delivery.rb:132
def enqueue_delivery(delivery_method, options = T.unsafe(nil)); end
# Returns the processed Mailer instance. We keep this instance
# on hand so we can delegate exception handling to it.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/message_delivery.rb:126
def processed_mailer; end
end
# source://actionmailer-7.0.3.1/lib/action_mailer/test_case.rb:7
class ActionMailer::NonInferrableMailerError < ::StandardError
# @return [NonInferrableMailerError] a new instance of NonInferrableMailerError
#
# source://actionmailer-7.0.3.1/lib/action_mailer/test_case.rb:8
def initialize(name); end
end
# Provides the option to parameterize mailers in order to share instance variable
# setup, processing, and common headers.
#
# Consider this example that does not use parameterization:
#
# class InvitationsMailer < ApplicationMailer
# def account_invitation(inviter, invitee)
# @account = inviter.account
# @inviter = inviter
# @invitee = invitee
#
# subject = "#{@inviter.name} invited you to their Basecamp (#{@account.name})"
#
# mail \
# subject: subject,
# to: invitee.email_address,
# from: common_address(inviter),
# reply_to: inviter.email_address_with_name
# end
#
# def project_invitation(project, inviter, invitee)
# @account = inviter.account
# @project = project
# @inviter = inviter
# @invitee = invitee
# @summarizer = ProjectInvitationSummarizer.new(@project.bucket)
#
# subject = "#{@inviter.name.familiar} added you to a project in Basecamp (#{@account.name})"
#
# mail \
# subject: subject,
# to: invitee.email_address,
# from: common_address(inviter),
# reply_to: inviter.email_address_with_name
# end
#
# def bulk_project_invitation(projects, inviter, invitee)
# @account = inviter.account
# @projects = projects.sort_by(&:name)
# @inviter = inviter
# @invitee = invitee
#
# subject = "#{@inviter.name.familiar} added you to some new stuff in Basecamp (#{@account.name})"
#
# mail \
# subject: subject,
# to: invitee.email_address,
# from: common_address(inviter),
# reply_to: inviter.email_address_with_name
# end
# end
#
# InvitationsMailer.account_invitation(person_a, person_b).deliver_later
#
# Using parameterized mailers, this can be rewritten as:
#
# class InvitationsMailer < ApplicationMailer
# before_action { @inviter, @invitee = params[:inviter], params[:invitee] }
# before_action { @account = params[:inviter].account }
#
# default to: -> { @invitee.email_address },
# from: -> { common_address(@inviter) },
# reply_to: -> { @inviter.email_address_with_name }
#
# def account_invitation
# mail subject: "#{@inviter.name} invited you to their Basecamp (#{@account.name})"
# end
#
# def project_invitation
# @project = params[:project]
# @summarizer = ProjectInvitationSummarizer.new(@project.bucket)
#
# mail subject: "#{@inviter.name.familiar} added you to a project in Basecamp (#{@account.name})"
# end
#
# def bulk_project_invitation
# @projects = params[:projects].sort_by(&:name)
#
# mail subject: "#{@inviter.name.familiar} added you to some new stuff in Basecamp (#{@account.name})"
# end
# end
#
# InvitationsMailer.with(inviter: person_a, invitee: person_b).account_invitation.deliver_later
#
# source://actionmailer-7.0.3.1/lib/action_mailer/parameterized.rb:87
module ActionMailer::Parameterized
extend ::ActiveSupport::Concern
mixes_in_class_methods ::ActionMailer::Parameterized::ClassMethods
end
# source://actionmailer-7.0.3.1/lib/action_mailer/parameterized.rb:94
module ActionMailer::Parameterized::ClassMethods
# Provide the parameters to the mailer in order to use them in the instance methods and callbacks.
#
# InvitationsMailer.with(inviter: person_a, invitee: person_b).account_invitation.deliver_later
#
# See Parameterized documentation for full example.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/parameterized.rb:100
def with(params); end
end
# source://actionmailer-7.0.3.1/lib/action_mailer/parameterized.rb:105
class ActionMailer::Parameterized::Mailer
# @return [Mailer] a new instance of Mailer
#
# source://actionmailer-7.0.3.1/lib/action_mailer/parameterized.rb:106
def initialize(mailer, params); end
private
# source://actionmailer-7.0.3.1/lib/action_mailer/parameterized.rb:111
def method_missing(method_name, *args); end
# @return [Boolean]
#
# source://actionmailer-7.0.3.1/lib/action_mailer/parameterized.rb:120
def respond_to_missing?(method, include_all = T.unsafe(nil)); end
end
# source://actionmailer-7.0.3.1/lib/action_mailer/parameterized.rb:125
class ActionMailer::Parameterized::MessageDelivery < ::ActionMailer::MessageDelivery
# @return [MessageDelivery] a new instance of MessageDelivery
#
# source://actionmailer-7.0.3.1/lib/action_mailer/parameterized.rb:126
def initialize(mailer_class, action, params, *args); end
private
# source://actionmailer-7.0.3.1/lib/action_mailer/parameterized.rb:140
def enqueue_delivery(delivery_method, options = T.unsafe(nil)); end
# source://actionmailer-7.0.3.1/lib/action_mailer/parameterized.rb:133
def processed_mailer; end
end
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:69
class ActionMailer::Preview
extend ::ActiveSupport::DescendantsTracker
# @return [Preview] a new instance of Preview
#
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:74
def initialize(params = T.unsafe(nil)); end
# Returns the value of attribute params.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:72
def params; end
class << self
# Returns all mailer preview classes.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:80
def all; end
# Returns the mail object for the given email name. The registered preview
# interceptors will be informed so that they can transform the message
# as they would if the mail was actually being delivered.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:88
def call(email, params = T.unsafe(nil)); end
# Returns +true+ if the email exists.
#
# @return [Boolean]
#
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:101
def email_exists?(email); end
# Returns all of the available email previews.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:96
def emails; end
# Returns +true+ if the preview exists.
#
# @return [Boolean]
#
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:106
def exists?(preview); end
# Find a mailer preview by its underscored class name.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:111
def find(preview); end
# Returns the underscored name of the mailer preview without the suffix.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:116
def preview_name; end
private
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:135
def inform_preview_interceptors(message); end
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:121
def load_previews; end
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:127
def preview_path; end
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:131
def show_previews; end
end
end
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:6
module ActionMailer::Previews
extend ::ActiveSupport::Concern
mixes_in_class_methods ::ActionMailer::Previews::ClassMethods
end
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:28
module ActionMailer::Previews::ClassMethods
# Register an Interceptor which will be called before mail is previewed.
# Either a class or a string can be passed in as the Interceptor. If a
# string is passed in it will be constantized.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:42
def register_preview_interceptor(interceptor); end
# Register one or more Interceptors which will be called before mail is previewed.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:30
def register_preview_interceptors(*interceptors); end
# Unregister a previously registered Interceptor.
# Either a class or a string can be passed in as the Interceptor. If a
# string is passed in it will be constantized.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:53
def unregister_preview_interceptor(interceptor); end
# Unregister one or more previously registered Interceptors.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:35
def unregister_preview_interceptors(*interceptors); end
private
# source://actionmailer-7.0.3.1/lib/action_mailer/preview.rb:58
def interceptor_class_for(interceptor); end
end
# source://actionmailer-7.0.3.1/lib/action_mailer/railtie.rb:9
class ActionMailer::Railtie < ::Rails::Railtie; end
# Provides +rescue_from+ for mailers. Wraps mailer action processing,
# mail job processing, and mail delivery.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/rescuable.rb:6
module ActionMailer::Rescuable
extend ::ActiveSupport::Concern
include GeneratedInstanceMethods
include ::ActiveSupport::Rescuable
mixes_in_class_methods GeneratedClassMethods
mixes_in_class_methods ::ActiveSupport::Rescuable::ClassMethods
mixes_in_class_methods ::ActionMailer::Rescuable::ClassMethods
# source://actionmailer-7.0.3.1/lib/action_mailer/rescuable.rb:16
def handle_exceptions; end
private
# source://actionmailer-7.0.3.1/lib/action_mailer/rescuable.rb:23
def process(*_arg0, &_arg1); end
module GeneratedClassMethods
def rescue_handlers; end
def rescue_handlers=(value); end
def rescue_handlers?; end
end
module GeneratedInstanceMethods
def rescue_handlers; end
def rescue_handlers=(value); end
def rescue_handlers?; end
end
end
# source://actionmailer-7.0.3.1/lib/action_mailer/rescuable.rb:0
module ActionMailer::Rescuable::ClassMethods
# source://actionmailer-7.0.3.1/lib/action_mailer/rescuable.rb:11
def handle_exception(exception); end
end
# source://actionmailer-7.0.3.1/lib/action_mailer/test_case.rb:15
class ActionMailer::TestCase < ::ActiveSupport::TestCase
include ::ActiveSupport::Testing::ConstantLookup
include ::ActiveJob::TestHelper
include ::ActionMailer::TestHelper
include ::Rails::Dom::Testing::Assertions::SelectorAssertions::CountDescribable
include ::Rails::Dom::Testing::Assertions::SelectorAssertions
include ::Rails::Dom::Testing::Assertions::DomAssertions
include ::ActionMailer::TestCase::Behavior
extend ::ActiveSupport::Testing::ConstantLookup::ClassMethods
extend ::ActionMailer::TestCase::Behavior::ClassMethods
# source://actionmailer-7.0.3.1/lib/action_mailer/test_case.rb:41
def _mailer_class; end
# source://actionmailer-7.0.3.1/lib/action_mailer/test_case.rb:41
def _mailer_class=(_arg0); end
# source://actionmailer-7.0.3.1/lib/action_mailer/test_case.rb:41
def _mailer_class?; end
class << self
# source://activesupport-7.0.3.1/lib/active_support/callbacks.rb:68
def __callbacks; end
# source://actionmailer-7.0.3.1/lib/action_mailer/test_case.rb:41
def _mailer_class; end
# source://actionmailer-7.0.3.1/lib/action_mailer/test_case.rb:41
def _mailer_class=(value); end
# source://actionmailer-7.0.3.1/lib/action_mailer/test_case.rb:41
def _mailer_class?; end
end
end
# source://actionmailer-7.0.3.1/lib/action_mailer/test_case.rb:32
module ActionMailer::TestCase::Behavior
include ::ActiveSupport::Testing::Assertions
include ::ActiveJob::TestHelper
include ::ActionMailer::TestHelper
include ::Rails::Dom::Testing::Assertions::SelectorAssertions::CountDescribable
include ::Rails::Dom::Testing::Assertions::SelectorAssertions
include ::Rails::Dom::Testing::Assertions::DomAssertions
extend ::ActiveSupport::Concern
include GeneratedInstanceMethods
include ::ActiveSupport::Testing::ConstantLookup
mixes_in_class_methods GeneratedClassMethods
mixes_in_class_methods ::ActiveSupport::Testing::ConstantLookup::ClassMethods
mixes_in_class_methods ::ActionMailer::TestCase::Behavior::ClassMethods
private
# source://actionmailer-7.0.3.1/lib/action_mailer/test_case.rb:106
def charset; end
# source://actionmailer-7.0.3.1/lib/action_mailer/test_case.rb:110
def encode(subject); end
# source://actionmailer-7.0.3.1/lib/action_mailer/test_case.rb:78
def initialize_test_deliveries; end
# source://actionmailer-7.0.3.1/lib/action_mailer/test_case.rb:114
def read_fixture(action); end
# source://actionmailer-7.0.3.1/lib/action_mailer/test_case.rb:95
def restore_delivery_method; end
# source://actionmailer-7.0.3.1/lib/action_mailer/test_case.rb:85
def restore_test_deliveries; end
# source://actionmailer-7.0.3.1/lib/action_mailer/test_case.rb:90
def set_delivery_method(method); end
# source://actionmailer-7.0.3.1/lib/action_mailer/test_case.rb:100
def set_expected_mail; end
module GeneratedClassMethods
def _mailer_class; end
def _mailer_class=(value); end
def _mailer_class?; end
end
module GeneratedInstanceMethods
def _mailer_class; end
def _mailer_class=(value); end
def _mailer_class?; end
end
end
# source://actionmailer-7.0.3.1/lib/action_mailer/test_case.rb:48
module ActionMailer::TestCase::Behavior::ClassMethods
# @raise [NonInferrableMailerError]
#
# source://actionmailer-7.0.3.1/lib/action_mailer/test_case.rb:68
def determine_default_mailer(name); end
# source://actionmailer-7.0.3.1/lib/action_mailer/test_case.rb:60
def mailer_class; end
# source://actionmailer-7.0.3.1/lib/action_mailer/test_case.rb:49
def tests(mailer); end
end
# source://actionmailer-7.0.3.1/lib/action_mailer/test_case.rb:16
module ActionMailer::TestCase::ClearTestDeliveries
extend ::ActiveSupport::Concern
private
# source://actionmailer-7.0.3.1/lib/action_mailer/test_case.rb:25
def clear_test_deliveries; end
end
# Provides helper methods for testing Action Mailer, including #assert_emails
# and #assert_no_emails.
#
# source://actionmailer-7.0.3.1/lib/action_mailer/test_helper.rb:8
module ActionMailer::TestHelper
include ::ActiveSupport::Testing::Assertions
include ::ActiveJob::TestHelper
# Asserts that the number of emails sent matches the given number.
#
# def test_emails
# assert_emails 0
# ContactMailer.welcome.deliver_now
# assert_emails 1
# ContactMailer.welcome.deliver_now
# assert_emails 2
# end
#
# If a block is passed, that block should cause the specified number of
# emails to be sent.
#
# def test_emails_again
# assert_emails 1 do
# ContactMailer.welcome.deliver_now
# end
#
# assert_emails 2 do
# ContactMailer.welcome.deliver_now
# ContactMailer.welcome.deliver_later
# end
# end
#
# source://actionmailer-7.0.3.1/lib/action_mailer/test_helper.rb:34
def assert_emails(number, &block); end
# Asserts that a specific email has been enqueued, optionally
# matching arguments.
#
# def test_email
# ContactMailer.welcome.deliver_later
# assert_enqueued_email_with ContactMailer, :welcome
# end
#
# def test_email_with_arguments
# ContactMailer.welcome("Hello", "Goodbye").deliver_later
# assert_enqueued_email_with ContactMailer, :welcome, args: ["Hello", "Goodbye"]
# end
#
# If a block is passed, that block should cause the specified email
# to be enqueued.
#
# def test_email_in_block
# assert_enqueued_email_with ContactMailer, :welcome do
# ContactMailer.welcome.deliver_later
# end
# end
#
# If +args+ is provided as a Hash, a parameterized email is matched.
#
# def test_parameterized_email
# assert_enqueued_email_with ContactMailer, :welcome,
# args: {email: 'user@example.com'} do
# ContactMailer.with(email: 'user@example.com').welcome.deliver_later
# end
# end
#
# source://actionmailer-7.0.3.1/lib/action_mailer/test_helper.rb:126
def assert_enqueued_email_with(mailer, method, args: T.unsafe(nil), queue: T.unsafe(nil), &block); end
# Asserts that the number of emails enqueued for later delivery matches
# the given number.
#
# def test_emails
# assert_enqueued_emails 0
# ContactMailer.welcome.deliver_later
# assert_enqueued_emails 1
# ContactMailer.welcome.deliver_later
# assert_enqueued_emails 2
# end
#
# If a block is passed, that block should cause the specified number of
# emails to be enqueued.
#
# def test_emails_again
# assert_enqueued_emails 1 do
# ContactMailer.welcome.deliver_later
# end
#
# assert_enqueued_emails 2 do
# ContactMailer.welcome.deliver_later
# ContactMailer.welcome.deliver_later
# end
# end
#
# source://actionmailer-7.0.3.1/lib/action_mailer/test_helper.rb:92
def assert_enqueued_emails(number, &block); end
# Asserts that no emails have been sent.
#
# def test_emails
# assert_no_emails
# ContactMailer.welcome.deliver_now
# assert_emails 1
# end
#
# If a block is passed, that block should not cause any emails to be sent.
#
# def test_emails_again
# assert_no_emails do
# # No emails should be sent from this block
# end
# end
#
# Note: This assertion is simply a shortcut for:
#
# assert_emails 0, &block
#
# source://actionmailer-7.0.3.1/lib/action_mailer/test_helper.rb:64
def assert_no_emails(&block); end
# Asserts that no emails are enqueued for later delivery.
#
# def test_no_emails
# assert_no_enqueued_emails
# ContactMailer.welcome.deliver_later
# assert_enqueued_emails 1
# end
#
# If a block is provided, it should not cause any emails to be enqueued.
#
# def test_no_emails
# assert_no_enqueued_emails do
# # No emails should be enqueued from this block
# end
# end
#
# source://actionmailer-7.0.3.1/lib/action_mailer/test_helper.rb:150
def assert_no_enqueued_emails(&block); end
private
# source://actionmailer-7.0.3.1/lib/action_mailer/test_helper.rb:155
def delivery_job_filter(job); end
end
# source://actionmailer-7.0.3.1/lib/action_mailer/gem_version.rb:9
module ActionMailer::VERSION; end
# source://actionmailer-7.0.3.1/lib/action_mailer/gem_version.rb:10
ActionMailer::VERSION::MAJOR = T.let(T.unsafe(nil), Integer)
# source://actionmailer-7.0.3.1/lib/action_mailer/gem_version.rb:11
ActionMailer::VERSION::MINOR = T.let(T.unsafe(nil), Integer)
# source://actionmailer-7.0.3.1/lib/action_mailer/gem_version.rb:13
ActionMailer::VERSION::PRE = T.let(T.unsafe(nil), String)
# source://actionmailer-7.0.3.1/lib/action_mailer/gem_version.rb:15
ActionMailer::VERSION::STRING = T.let(T.unsafe(nil), String)
# source://actionmailer-7.0.3.1/lib/action_mailer/gem_version.rb:12
ActionMailer::VERSION::TINY = T.let(T.unsafe(nil), Integer)