diff --git a/gems/actionmailer/8.1/_test/metadata.yaml b/gems/actionmailer/8.1/_test/metadata.yaml new file mode 100644 index 000000000..00be5669a --- /dev/null +++ b/gems/actionmailer/8.1/_test/metadata.yaml @@ -0,0 +1,2 @@ +additional_gems: + - railties diff --git a/gems/actionmailer/8.1/_test/railsguides.rb b/gems/actionmailer/8.1/_test/railsguides.rb new file mode 100644 index 000000000..36b7587b4 --- /dev/null +++ b/gems/actionmailer/8.1/_test/railsguides.rb @@ -0,0 +1,83 @@ +module RailsGuides + class ApplicationMailer < ActionMailer::Base + default from: 'from@example.com' + layout 'mailer' + + before_deliver :log_delivery + rescue_from(ArgumentError) { |exception| exception.message } + self.raise_delivery_errors = true + + private + + def log_delivery + end + end + + class NotifierMailer < ApplicationMailer + default from: 'no-reply@example.com', + return_path: 'system@example.com' + + def welcome(recipient) + @account = recipient + mail(to: recipient, + bcc: ["bcc@example.com", "Order Watcher "]) + end + + # @dynamic self.welcome + end + + class UserMailer < ApplicationMailer + default from: 'notifications@example.com' + + def welcome_email + @user = params[:user] + @url = 'http://example.com/login' + mail(to: "@user", subject: 'Welcome to My Awesome Site') + end + end + + class I18nUserMailer < ActionMailer::Base + def welcome(email, username) + mail(to: email, subject: default_i18n_subject(user: username)) + end + end + + NotifierMailer.welcome("first user").deliver_now + NotifierMailer.welcome("first user").message + NotifierMailer.welcome("first user").deliver_later +end + +delivery = RailsGuides::NotifierMailer.welcome("first user") +delivery.deliver_now unless delivery.processed? + +class NotifierMailerTest < ActionMailer::TestCase + tests RailsGuides::NotifierMailer + + def test_welcome + assert_no_emails + assert_no_enqueued_emails + RailsGuides::NotifierMailer.welcome("first user").deliver_later + assert_enqueued_emails 1 + assert_enqueued_email_with RailsGuides::NotifierMailer, :welcome, args: ["first user"] + deliver_enqueued_emails + end +end + +RailsGuides::ApplicationMailer.deliver_later_queue_name = :low +RailsGuides::ApplicationMailer.delivery_job = ActionMailer::MailDeliveryJob + +if (job = RailsGuides::NotifierMailer.welcome("first user").deliver_later(wait: 1.hour)) + job.job_id.upcase +end +if (job = RailsGuides::NotifierMailer.welcome("first user").deliver_later!) + job.job_id.upcase +end +ActionMailer::Base.deliveries.last&.subject +ActionMailer::Base.deliveries.clear + +class NotifierMailerTest + def test_capture + emails = capture_emails { RailsGuides::NotifierMailer.welcome("first user").deliver_later } + emails.first&.to + end +end diff --git a/gems/actionmailer/8.1/_test/railsguides.rbs b/gems/actionmailer/8.1/_test/railsguides.rbs new file mode 100644 index 000000000..58f066bb3 --- /dev/null +++ b/gems/actionmailer/8.1/_test/railsguides.rbs @@ -0,0 +1,34 @@ +module RailsGuides + class ApplicationMailer < ActionMailer::Base + private + + def log_delivery: () -> void + end + + class NotifierMailer < ApplicationMailer + @account: untyped + + def welcome: (untyped) -> Mail::Message + + def self.welcome: (untyped) -> ActionMailer::MessageDelivery + end + + class UserMailer < ApplicationMailer + @user: untyped + @url: String + + def welcome_email: () -> Mail::Message + end + + class I18nUserMailer < ApplicationMailer + def welcome: (String email, String username) -> Mail::Message + end +end + +class NotifierMailerTest < ActionMailer::TestCase + def test_welcome: () -> void +end + +class NotifierMailerTest + def test_capture: () -> void +end diff --git a/gems/actionmailer/8.1/_test/test.rb b/gems/actionmailer/8.1/_test/test.rb new file mode 100644 index 000000000..fcef0c60a --- /dev/null +++ b/gems/actionmailer/8.1/_test/test.rb @@ -0,0 +1,4 @@ +# Write Ruby code to test the RBS. +# It is type checked by `steep check` command. + +require "actionmailer" diff --git a/gems/actionmailer/8.1/actionmailer-generated.rbs b/gems/actionmailer/8.1/actionmailer-generated.rbs new file mode 100644 index 000000000..dbc9ab6b5 --- /dev/null +++ b/gems/actionmailer/8.1/actionmailer-generated.rbs @@ -0,0 +1,1572 @@ +# The generated code is based on Ruby on Rails source code +# You can find the license of Ruby on Rails from following. + +#Copyright (c) David Heinemeier Hansson +# +#Permission is hereby granted, free of charge, to any person obtaining +#a copy of this software and associated documentation files (the +#"Software"), to deal in the Software without restriction, including +#without limitation the rights to use, copy, modify, merge, publish, +#distribute, sublicense, and/or sell copies of the Software, and to +#permit persons to whom the Software is furnished to do so, subject to +#the following conditions: +# +#The above copyright notice and this permission notice shall be +#included in all copies or substantial portions of the Software. +# +#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +#EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +#MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +#NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +#LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +#OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +#WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +# + +# :include: ../README.rdoc +module ActionMailer + extend ::ActiveSupport::Autoload + + # Enqueue many emails at once to be delivered through Active Job. + # When the individual job runs, it will send the email using +deliver_now+. + def self.deliver_all_later: (*untyped deliveries, **untyped options) -> untyped + + # Enqueue many emails at once to be delivered through Active Job. + # When the individual 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. + def self.deliver_all_later!: (*untyped deliveries, **untyped options) -> untyped + + def self.eager_load!: () -> untyped + + def self._deliver_all_later: (untyped delivery_method, *untyped deliveries, **untyped options) -> untyped +end + +module ActionMailer + # = Action Mailer \Base + # + # 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.text(content_transfer_encoding: "base64") + # 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, + # and using before_deliver and after_deliver for wrapping the delivery process. + # For example, when you want to add default inline attachments and log delivery for all messages + # sent out by a certain mailer class: + # + # class NotifierMailer < ApplicationMailer + # before_action :add_inline_attachment! + # after_deliver :log_delivery + # + # def welcome + # mail + # end + # + # private + # def add_inline_attachment! + # attachments.inline["footer.jpg"] = File.read('/path/to/filename.jpg') + # end + # + # def log_delivery + # Rails.logger.info "Sent email with message id '#{message.message_id}' at #{Time.current}." + # end + # end + # + # Action 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_paths. 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 preview directories can be configured using the preview_paths option which has a default + # of test/mailers/previews: + # + # config.action_mailer.preview_paths << "#{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. Requires at least version 2.7 of the Mail gem. + # * :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 %w[ -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. Mailers can set this to use a + # custom delivery job. Defaults to +ActionMailer::MailDeliveryJob+. + # + # * deliver_later_queue_name - The queue name used by deliver_later with the default + # delivery_job. Mailers can set this to use a custom queue name. + class Base + def self.default_params: () -> untyped + def self.default_params=: (untyped value) -> untyped + def self.default_params?: () -> bool + def default_params: () -> untyped + def default_params?: () -> bool + def default_params=: (untyped value) -> untyped + + include ::ActionMailer::Callbacks + + include ::ActionMailer::DeliveryMethods + + include ::ActionMailer::QueuedDelivery + + include ::ActionMailer::Rescuable + + include ::ActionMailer::Parameterized + + include ::ActionMailer::Previews + + include ::ActionMailer::FormBuilder + + include ::AbstractController::Rendering + + include ::AbstractController::Logger + + include ::AbstractController::Helpers + + include ::AbstractController::Translation + + include ::AbstractController::AssetPaths + + include ::AbstractController::Callbacks + + include ::AbstractController::Caching + + include ::ActionView::Layouts + + PROTECTED_IVARS: untyped + + # Register one or more Observers which will be notified when mail is delivered. + def self.register_observers: (*untyped observers) -> untyped + + # Unregister one or more previously registered Observers. + def self.unregister_observers: (*untyped observers) -> untyped + + # Register one or more Interceptors which will be called before mail is sent. + def self.register_interceptors: (*untyped interceptors) -> untyped + + # Unregister one or more previously registered Interceptors. + def self.unregister_interceptors: (*untyped interceptors) -> untyped + + # 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. + def self.register_observer: (untyped observer) -> untyped + + # 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. + def self.unregister_observer: (untyped observer) -> untyped + + # 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. + def self.register_interceptor: (untyped interceptor) -> untyped + + # 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. + def self.unregister_interceptor: (untyped interceptor) -> untyped + + def self.observer_class_for: (untyped value) -> untyped + + # 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. + def self.mailer_name: () -> untyped + + # Allows to set the name of current mailer. + attr_writer self.mailer_name: untyped + + alias self.controller_path self.mailer_name + + alias self.default_options= self.default + + # 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. + def self.deliver_mail: (untyped mail) { () -> untyped } -> untyped + + def self.mail: (*untyped, **untyped) ?{ (?) -> untyped } -> untyped + + def self.action_methods: () -> untyped + + def self.set_payload_for_mail: (untyped payload, untyped mail) -> untyped + + def self.method_missing: (untyped method_name, *untyped, **untyped) ?{ (?) -> untyped } -> untyped + + def self.respond_to_missing?: (untyped method, ?bool include_all) -> untyped + + def initialize: () -> void + + def process: (untyped method_name, *untyped args) -> untyped + + class NullMail + def body: () -> "" + + def header: () -> ::Hash[untyped, untyped] + + def respond_to?: (untyped string, ?bool include_all) -> true + + def method_missing: (*untyped, **untyped) ?{ (?) -> untyped } -> nil + end + + # Returns the name of the mailer object. + def mailer_name: () -> untyped + + # 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+, and +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', + # encoding: 'SpecialEncoding', + # 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) + # + def attachments: () -> untyped + + class LateAttachmentsProxy < ::SimpleDelegator + def inline: () -> self + + def []=: (untyped _name, untyped _content) -> untyped + + private + + def _raise_error: () -> untyped + end + + private + + # 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. + def set_content_type: (untyped m, untyped user_content_type, untyped class_default) -> untyped + + # Emails do not support relative path links. + def self.supports_path?: () -> false + + def apply_defaults: (untyped headers) -> untyped + + def compute_default: (untyped value) -> untyped + + def assign_headers_to_message: (untyped message, untyped headers) -> untyped + + def collect_responses: (untyped headers) ?{ (?) -> untyped } -> untyped + + def collect_responses_from_block: (untyped headers) { (untyped) -> untyped } -> untyped + + def collect_responses_from_text: (untyped headers) -> ::Array[{ body: untyped, content_type: untyped }] + + def collect_responses_from_templates: (untyped headers) -> untyped + + def each_template: (untyped paths, untyped name) { (?) -> untyped } -> untyped + + def wrap_inline_attachments: (untyped message) -> (untyped | nil) + + def create_parts_from_responses: (untyped m, untyped responses) -> untyped + + def insert_part: (untyped container, untyped response, untyped charset) -> untyped + + # This and #instrument_name is for caching instrument + def instrument_payload: (untyped key) -> { mailer: untyped, key: untyped } + + def instrument_name: () -> "action_mailer" + + def _protected_ivars: () -> untyped + end +end + +module ActionMailer + module Callbacks + include ::ActiveSupport::Callbacks + + extend ::ActiveSupport::Concern + + DEFAULT_INTERNAL_METHODS: ::Array[:_run_deliver_callbacks] + + module ClassMethods + # Defines a callback that will get called right before the + # message is sent to the delivery method. + def before_deliver: (*untyped filters) ?{ (?) -> untyped } -> untyped + + # Defines a callback that will get called right after the + # message's delivery method is finished. + def after_deliver: (*untyped filters) ?{ (?) -> untyped } -> untyped + + # Defines a callback that will get called around the message's deliver method. + def around_deliver: (*untyped filters) ?{ (?) -> untyped } -> untyped + + def internal_methods: () -> untyped + end + end +end + +module ActionMailer + class Collector + include ::AbstractController::Collector + + attr_reader responses: untyped + + def initialize: (untyped context) ?{ (?) -> untyped } -> void + + def any: (*untyped args) ?{ (?) -> untyped } -> untyped + + alias all any + + def custom: (untyped mime, ?::Hash[untyped, untyped] options) ?{ () -> untyped } -> untyped + end +end + +module ActionMailer + # = Action Mailer \DeliveryMethods + # + # This module handles everything related to mail delivery, from registering + # new delivery methods to configuring the mail object to be sent. + module DeliveryMethods + def raise_delivery_errors: () -> untyped + + def raise_delivery_errors=: (untyped value) -> untyped + + def perform_deliveries: () -> untyped + + def perform_deliveries=: (untyped value) -> untyped + + def delivery_methods: () -> untyped + + def delivery_methods?: () -> bool + + def delivery_methods=: (untyped value) -> untyped + + def delivery_method: () -> untyped + + def delivery_method?: () -> bool + + def delivery_method=: (untyped value) -> untyped + + extend ::ActiveSupport::Concern + + # Helpers for creating and wrapping delivery behavior, used by DeliveryMethods. + module ClassMethods + def raise_delivery_errors: () -> untyped + + def raise_delivery_errors=: (untyped value) -> untyped + + def perform_deliveries: () -> untyped + + def perform_deliveries=: (untyped value) -> untyped + + def delivery_methods: () -> untyped + + def delivery_methods=: (untyped value) -> untyped + + def delivery_methods?: () -> bool + + def delivery_method: () -> untyped + + def delivery_method=: (untyped value) -> untyped + + def delivery_method?: () -> bool + + # 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: %w[ -i ] + def add_delivery_method: (untyped symbol, untyped klass, ?::Hash[untyped, untyped] default_options) -> untyped + + def wrap_delivery_behavior: (untyped mail, ?untyped? method, ?untyped? options) -> untyped + end + + def wrap_delivery_behavior!: (*untyped args) -> untyped + end +end + +module ActionMailer + def self.deprecator: () -> untyped +end + +module ActionMailer + # = Action Mailer Form Builder + # + # Override the default form builder for all views rendered by this + # mailer and any of its descendants. Accepts a subclass of + # ActionView::Helpers::FormBuilder. + # + # While emails typically will not include forms, this can be used + # by views that are shared between controllers and mailers. + # + # For more information, see +ActionController::FormBuilder+. + module FormBuilder + extend ::ActiveSupport::Concern + + module ClassMethods + def _default_form_builder: () -> untyped + + def _default_form_builder=: (untyped value) -> untyped + + def _default_form_builder?: () -> bool + + # Set the form builder to be used as the default for all forms + # in the views rendered by this mailer and its subclasses. + # + # ==== Parameters + # * builder - Default form builder. Accepts a subclass of ActionView::Helpers::FormBuilder + def default_form_builder: (untyped builder) -> untyped + end + + # Default form builder for the mailer + def default_form_builder: () -> untyped + end +end + +module ActionMailer + # Returns the currently loaded version of Action Mailer as a +Gem::Version+. + def self.gem_version: () -> untyped + + module VERSION + MAJOR: 8 + + MINOR: 1 + + TINY: 4 + + PRE: nil + + STRING: untyped + end +end + +module ActionMailer + # = Action Mailer \InlinePreviewInterceptor + # + # 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) + # + class InlinePreviewInterceptor + PATTERN: ::Regexp + + include ::Base64 + + def self.previewing_email: (untyped message) -> untyped + + def initialize: (untyped message) -> void + + def transform!: () -> untyped + + private + + attr_reader message: untyped + + def html_part: () -> untyped + + def data_url: (untyped part) -> ::String + + def find_part: (untyped cid) -> untyped + end +end + +module ActionMailer + class LogSubscriber < ::ActiveSupport::LogSubscriber + # An email was delivered. + def deliver: (untyped event) -> untyped + + # An email was generated. + def process: (untyped event) -> untyped + + # Use the logger configured for ActionMailer::Base. + def logger: () -> untyped + end +end + +module ActionMailer + # = Action Mailer \MailDeliveryJob + # + # 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. + class MailDeliveryJob < ::ActiveJob::Base + def perform: (untyped mailer, untyped mail_method, untyped delivery_method, args: untyped, ?kwargs: untyped?, ?params: untyped?) -> untyped + + private + + # "Deserialize" the mailer class name by hand in case another argument + # (like a Global ID reference) raised DeserializationError. + def mailer_class: () -> (untyped | nil) + + def handle_exception_with_mailer_class: (untyped exception) -> untyped + end +end + +module ActionMailer + # = Action Mailer \MailHelper + # + # Provides helper methods for ActionMailer::Base that can be used for easily + # formatting messages, accessing mailer or message instances, and the + # attachments list. + module MailHelper + # 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" + def block_format: (untyped text) -> untyped + + # Access the mailer instance. + def mailer: () -> untyped + + # Access the message instance. + def message: () -> untyped + + # Access the message attachments list. + def attachments: () -> untyped + + # 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\n with more than 40\n characters" + def format_paragraph: (untyped text, ?::Integer len, ?::Integer indent) -> untyped + end +end + +module ActionMailer + # = Action Mailer \MessageDelivery + # + # 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 + class MessageDelivery < ::Delegator + attr_reader mailer_class: untyped + + attr_reader action: untyped + + attr_reader params: untyped + + attr_reader args: untyped + + def initialize: (untyped mailer_class, untyped action, *untyped args) -> void + + # Method calls are delegated to the Mail::Message that's ready to deliver. + def __getobj__: () -> untyped + + # Unused except for delegator internals (dup, marshalling). + def __setobj__: (untyped mail_message) -> untyped + + private + + # Returns the processed Mailer instance. We keep this instance + # on hand so we can run callbacks and delegate exception handling to it. + def processed_mailer: () -> untyped + + def enqueue_delivery: (untyped delivery_method, ?::Hash[untyped, untyped] options) -> untyped + end +end + +module ActionMailer + # = Action Mailer \Parameterized + # + # 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 + module Parameterized + extend ::ActiveSupport::Concern + + module 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. + def with: (untyped params) -> untyped + end + + class Mailer + def initialize: (untyped mailer, untyped params) -> void + + private + + def method_missing: (untyped method_name, *untyped, **untyped) ?{ (?) -> untyped } -> untyped + + def respond_to_missing?: (untyped method, ?bool include_all) -> untyped + end + + class MessageDelivery < ::ActionMailer::MessageDelivery + def initialize: (untyped mailer_class, untyped action, untyped params, *untyped, **untyped) ?{ (?) -> untyped } -> void + + private + + def processed_mailer: () -> untyped + + def enqueue_delivery: (untyped delivery_method, ?::Hash[untyped, untyped] options) -> untyped + end + end +end + +module ActionMailer + module Previews + def preview_paths: () -> untyped + + def show_previews: () -> untyped + + def preview_interceptors: () -> untyped + + extend ::ActiveSupport::Concern + + module ClassMethods + def preview_paths: () -> untyped + + def preview_paths=: (untyped value) -> untyped + + def show_previews: () -> untyped + + def show_previews=: (untyped value) -> untyped + + def preview_interceptors: () -> untyped + + def preview_interceptors=: (untyped value) -> untyped + + # Register one or more Interceptors which will be called before mail is previewed. + def register_preview_interceptors: (*untyped interceptors) -> untyped + + # Unregister one or more previously registered Interceptors. + def unregister_preview_interceptors: (*untyped interceptors) -> untyped + + # 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. + def register_preview_interceptor: (untyped interceptor) -> untyped + + # 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. + def unregister_preview_interceptor: (untyped interceptor) -> untyped + + private + + def interceptor_class_for: (untyped interceptor) -> untyped + end + end + + class Preview + extend ::ActiveSupport::DescendantsTracker + + attr_reader params: untyped + + def initialize: (?::Hash[untyped, untyped] params) -> void + + # Returns all mailer preview classes. + def self.all: () -> untyped + + # 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. + def self.call: (untyped email, ?::Hash[untyped, untyped] params) -> untyped + + # Returns all of the available email previews. + def self.emails: () -> untyped + + # Returns +true+ if the email exists. + def self.email_exists?: (untyped email) -> untyped + + # Returns +true+ if the preview exists. + def self.exists?: (untyped preview) -> untyped + + # Find a mailer preview by its underscored class name. + def self.find: (untyped preview) -> untyped + + # Returns the underscored name of the mailer preview without the suffix. + def self.preview_name: () -> untyped + + def self.load_previews: () -> untyped + + def self.preview_paths: () -> untyped + + def self.show_previews: () -> untyped + + def self.inform_preview_interceptors: (untyped message) -> untyped + end +end + +module ActionMailer + module QueuedDelivery + def delivery_job: () -> untyped + + def delivery_job?: () -> bool + + def delivery_job=: (untyped value) -> untyped + + def deliver_later_queue_name: () -> untyped + + def deliver_later_queue_name?: () -> bool + + def deliver_later_queue_name=: (untyped value) -> untyped + + extend ::ActiveSupport::Concern + end +end + +module ActionMailer + class Railtie < ::Rails::Railtie + end +end + +module ActionMailer + # = Action Mailer \Rescuable + # + # Provides + # {rescue_from}[rdoc-ref:ActiveSupport::Rescuable::ClassMethods#rescue_from] + # for mailers. Wraps mailer action processing, mail job processing, and mail + # delivery to handle configured errors. + module Rescuable + extend ::ActiveSupport::Concern + + include ::ActiveSupport::Rescuable + + def handle_exceptions: () { () -> untyped } -> untyped + + private + + def process: (*untyped, **untyped) ?{ (?) -> untyped } -> untyped + end +end + +module ActionMailer + class StructuredEventSubscriber < ::ActiveSupport::StructuredEventSubscriber + # An email was delivered. + def deliver: (untyped event) -> untyped + + # An email was generated. + def process: (untyped event) -> untyped + end +end + +module ActionMailer + class NonInferrableMailerError < ::StandardError + def initialize: (untyped name) -> void + end + + class TestCase < ::ActiveSupport::TestCase + extend ::ActionMailer::TestCase::Behavior::ClassMethods + + extend ::ActiveSupport::Testing::ConstantLookup::ClassMethods + + module ClearTestDeliveries + extend ::ActiveSupport::Concern + + private + + def clear_test_deliveries: () -> (untyped | nil) + end + + module Behavior + def _mailer_class: () -> untyped + + def _mailer_class?: () -> bool + + def _mailer_class=: (untyped value) -> untyped + + extend ::ActiveSupport::Concern + + include ::ActiveSupport::Testing::ConstantLookup + + include ::ActionMailer::TestHelper + + include ::Rails::Dom::Testing::Assertions::SelectorAssertions + + include ::Rails::Dom::Testing::Assertions::DomAssertions + + module ClassMethods + def _mailer_class: () -> untyped + + def _mailer_class=: (untyped value) -> untyped + + def _mailer_class?: () -> bool + + def tests: (untyped mailer) -> untyped + + def mailer_class: () -> untyped + + def determine_default_mailer: (untyped name) -> untyped + end + + # Reads the fixture file for the given mailer. + # + # This is useful when testing mailers by being able to write the body of + # an email inside a fixture. See the testing guide for a concrete example: + # https://guides.rubyonrails.org/testing.html#revenge-of-the-fixtures + def read_fixture: (untyped action) -> untyped + + private + + def initialize_test_deliveries: () -> untyped + + def restore_test_deliveries: () -> untyped + + def set_delivery_method: (untyped method) -> untyped + + def restore_delivery_method: () -> untyped + + def set_expected_mail: () -> untyped + + def charset: () -> "UTF-8" + + def encode: (untyped subject) -> untyped + end + + include ::ActionMailer::TestCase::Behavior + end +end + +module ActionMailer + # Provides helper methods for testing Action Mailer, including #assert_emails + # and #assert_no_emails. + module TestHelper + 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 + def assert_emails: (untyped number) ?{ (?) -> untyped } -> untyped + + # 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 + def assert_no_emails: () ?{ (?) -> untyped } -> untyped + + # 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 + def assert_enqueued_emails: (untyped number) ?{ (?) -> untyped } -> untyped + + # Asserts that a specific email has been enqueued, optionally + # matching arguments and/or params. + # + # def test_email + # ContactMailer.welcome.deliver_later + # assert_enqueued_email_with ContactMailer, :welcome + # end + # + # def test_email_with_parameters + # ContactMailer.with(greeting: "Hello").welcome.deliver_later + # assert_enqueued_email_with ContactMailer, :welcome, params: { greeting: "Hello" } + # end + # + # def test_email_with_arguments + # ContactMailer.welcome("Hello", "Goodbye").deliver_later + # assert_enqueued_email_with ContactMailer, :welcome, args: ["Hello", "Goodbye"] + # end + # + # def test_email_with_named_arguments + # ContactMailer.welcome(greeting: "Hello", farewell: "Goodbye").deliver_later + # assert_enqueued_email_with ContactMailer, :welcome, args: [{ greeting: "Hello", farewell: "Goodbye" }] + # end + # + # def test_email_with_parameters_and_arguments + # ContactMailer.with(greeting: "Hello").welcome("Cheers", "Goodbye").deliver_later + # assert_enqueued_email_with ContactMailer, :welcome, params: { greeting: "Hello" }, args: ["Cheers", "Goodbye"] + # end + # + # def test_email_with_parameters_and_named_arguments + # ContactMailer.with(greeting: "Hello").welcome(farewell: "Goodbye").deliver_later + # assert_enqueued_email_with ContactMailer, :welcome, params: { greeting: "Hello" }, args: [{farewell: "Goodbye"}] + # end + # + # def test_email_with_parameterized_mailer + # ContactMailer.with(greeting: "Hello").welcome.deliver_later + # assert_enqueued_email_with ContactMailer.with(greeting: "Hello"), :welcome + # end + # + # def test_email_with_matchers + # ContactMailer.with(greeting: "Hello").welcome("Cheers", "Goodbye").deliver_later + # assert_enqueued_email_with ContactMailer, :welcome, + # params: ->(params) { /hello/i.match?(params[:greeting]) }, + # args: ->(args) { /cheers/i.match?(args[0]) } + # 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 + def assert_enqueued_email_with: (untyped mailer, untyped method, ?params: untyped?, ?args: untyped?, ?queue: untyped?) ?{ (?) -> untyped } -> untyped + + # 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 + def assert_no_enqueued_emails: () ?{ (?) -> untyped } -> untyped + + # Delivers all enqueued emails. If a block is given, delivers all of the emails + # that were enqueued throughout the duration of the block. If a block is + # not given, delivers all the enqueued emails up to this point in the test. + # + # def test_deliver_enqueued_emails + # deliver_enqueued_emails do + # ContactMailer.welcome.deliver_later + # end + # + # assert_emails 1 + # end + # + # def test_deliver_enqueued_emails_without_block + # ContactMailer.welcome.deliver_later + # + # deliver_enqueued_emails + # + # assert_emails 1 + # end + # + # If the +:queue+ option is specified, + # then only the emails(s) enqueued to a specific queue will be performed. + # + # def test_deliver_enqueued_emails_with_queue + # deliver_enqueued_emails queue: :external_mailers do + # CustomerMailer.deliver_later_queue_name = :external_mailers + # CustomerMailer.welcome.deliver_later # will be performed + # EmployeeMailer.deliver_later_queue_name = :internal_mailers + # EmployeeMailer.welcome.deliver_later # will not be performed + # end + # + # assert_emails 1 + # end + # + # If the +:at+ option is specified, then only delivers emails enqueued to deliver + # immediately or before the given time. + def deliver_enqueued_emails: (?queue: untyped?, ?at: untyped?) ?{ (?) -> untyped } -> untyped + + private + + def delivery_job_filter: (untyped job) -> untyped + end +end + +module ActionMailer + # Returns the currently loaded version of Action Mailer as a + # +Gem::Version+. + def self.version: () -> untyped +end + +module ActionMailer + module Rescuable + module ClassMethods + def handle_exception: (untyped exception) -> untyped + end + end +end diff --git a/gems/actionmailer/8.1/actionmailer.rbs b/gems/actionmailer/8.1/actionmailer.rbs new file mode 100644 index 000000000..c9ef2d8a6 --- /dev/null +++ b/gems/actionmailer/8.1/actionmailer.rbs @@ -0,0 +1,98 @@ +module ActionMailer + class Base < AbstractController::Base + include AbstractController::Rendering + include AbstractController::Helpers + extend AbstractController::Helpers::ClassMethods + include AbstractController::Translation + include AbstractController::AssetPaths + include AbstractController::Callbacks + extend AbstractController::Callbacks::ClassMethods + include AbstractController::Caching + extend AbstractController::Caching::ClassMethods + + include ActionView::Layouts + extend ActionView::Layouts::ClassMethods + + # ClassMethods of the concerns included in ActionMailer::Base and the ones they include + extend ActionMailer::Callbacks::ClassMethods + extend ActionMailer::DeliveryMethods::ClassMethods + extend ActionMailer::Rescuable::ClassMethods + extend ActionMailer::Parameterized::ClassMethods + extend ActionMailer::Previews::ClassMethods + extend ActionMailer::FormBuilder::ClassMethods + extend ActiveSupport::Callbacks::ClassMethods + extend ActiveSupport::Rescuable::ClassMethods + extend AbstractController::Caching::Fragments::ClassMethods + extend ActionView::Rendering::ClassMethods + extend ActionView::ViewPaths::ClassMethods + + def self.default: (**untyped) -> void + + def self.layout: (String) -> void + + def mail: (**untyped) ?{ (untyped) -> void } -> Mail::Message + + def self.with: (**untyped) -> untyped + + def params: () -> Hash[untyped, untyped] + + def self?.email_address_with_name: (String, String) -> String + + def headers: () -> Mail::Message + | (Hash[untyped, untyped]) -> untyped + + private + + def default_i18n_subject: (?Hash[untyped, untyped] interpolations) -> String + end + + class MessageDelivery + # The enqueued job, or false if it couldn't be enqueued + def deliver_later: (?wait: untyped, ?wait_until: untyped, ?queue: untyped, ?priority: Integer) -> (ActiveJob::Base | false) + + def deliver_later!: (?wait: untyped, ?wait_until: untyped, ?queue: untyped, ?priority: Integer) -> (ActiveJob::Base | false) + + def deliver_now: () -> void + + def deliver_now!: () -> void + + def message: () -> Mail::Message + + def processed?: () -> boolish + end +end + +# Methods rbs prototype doesn't see, which aren't generated from the source +module ActionMailer + class Base + # class_attribute in QueuedDelivery's included block + def self.delivery_job: () -> untyped + def self.delivery_job=: (untyped value) -> untyped + def self.delivery_job?: () -> bool + def delivery_job: () -> untyped + def delivery_job=: (untyped value) -> untyped + def delivery_job?: () -> bool + + def self.deliver_later_queue_name: () -> untyped + def self.deliver_later_queue_name=: (untyped value) -> untyped + def self.deliver_later_queue_name?: () -> bool + def deliver_later_queue_name: () -> untyped + def deliver_later_queue_name=: (untyped value) -> untyped + def deliver_later_queue_name?: () -> bool + end +end + +# Return types of commonly used methods +module ActionMailer + module DeliveryMethods + module ClassMethods + # Delegated to Mail::TestMailer + def deliveries: () -> Array[Mail::Message] + def deliveries=: (Array[Mail::Message] deliveries) -> Array[Mail::Message] + end + end + + module TestHelper + def capture_emails: () { () -> void } -> Array[Mail::Message] + end +end diff --git a/gems/actionmailer/8.1/manifest.yaml b/gems/actionmailer/8.1/manifest.yaml new file mode 100644 index 000000000..aac4d14e4 --- /dev/null +++ b/gems/actionmailer/8.1/manifest.yaml @@ -0,0 +1,13 @@ +# manifest.yaml describes dependencies which do not appear in the gemspec. +# If this gem includes such dependencies, comment-out the following lines and +# declare the dependencies. +# If all dependencies appear in the gemspec, you should remove this file. +# +dependencies: + - name: cgi + - name: date + - name: logger + - name: monitor + - name: singleton + - name: time + - name: tsort