Skip to content

Commit cffc0e0

Browse files
committed
📚 Use standard www.rfc-editor.org links for RFCs
1 parent e6d6c1d commit cffc0e0

16 files changed

+163
-163
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Net::IMAP
22

33
Net::IMAP implements Internet Message Access Protocol (IMAP) client
4-
functionality. The protocol is described in [IMAP](https://tools.ietf.org/html/rfc3501).
4+
functionality. The protocol is described in [RFC3501](https://www.rfc-editor.org/rfc/rfc3501).
55

66
## Installation
77

lib/net/imap.rb

Lines changed: 72 additions & 72 deletions
Large diffs are not rendered by default.

lib/net/imap/fetch_data.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ def flags; attr["FLAGS"] end
313313
# :call-seq: internaldate -> Time or nil
314314
#
315315
# The internal date and time of the message on the server. This is not
316-
# the date and time in the [RFC5322[https://tools.ietf.org/html/rfc5322]]
316+
# the date and time in the [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]]
317317
# header, but rather a date and time which reflects when the message was
318318
# received.
319319
#
@@ -341,7 +341,7 @@ def rfc822; attr["RFC822"] end
341341

342342
# :call-seq: rfc822_size -> Integer or nil
343343
#
344-
# A number expressing the [RFC5322[https://tools.ietf.org/html/rfc5322]]
344+
# A number expressing the [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]]
345345
# size of the message.
346346
#
347347
# This is the same as getting the value for <tt>"RFC822.SIZE"</tt> from

lib/net/imap/response_data.rb

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -469,7 +469,7 @@ class MailboxQuotaRoot < Struct.new(:mailbox, :quotaroots)
469469
# Net::IMAP#getacl returns an array of MailboxACLItem objects.
470470
#
471471
# ==== Required capability
472-
# +ACL+ - described in [ACL[https://tools.ietf.org/html/rfc4314]]
472+
# +ACL+ - described in [ACL[https://www.rfc-editor.org/rfc/rfc4314]]
473473
class MailboxACLItem < Struct.new(:user, :rights, :mailbox)
474474
##
475475
# method: mailbox
@@ -565,11 +565,11 @@ class StatusData < Struct.new(:mailbox, :attr)
565565
# [Note]
566566
# When the #sender and #reply_to fields are absent or empty, they will
567567
# return the same value as #from. Also, fields may return values that are
568-
# invalid for well-formed [RFC5322[https://tools.ietf.org/html/rfc5322]]
568+
# invalid for well-formed [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]]
569569
# messages when the message is malformed or a draft message.
570570
#
571-
# See [{IMAP4rev1 §7.4.2}[https://www.rfc-editor.org/rfc/rfc3501.html#section-7.4.2]]
572-
# and [{IMAP4rev2 §7.5.2}[https://www.rfc-editor.org/rfc/rfc9051.html#section-7.5.2]]
571+
# See [{IMAP4rev1 §7.4.2}[https://www.rfc-editor.org/rfc/rfc3501#section-7.4.2]]
572+
# and [{IMAP4rev2 §7.5.2}[https://www.rfc-editor.org/rfc/rfc9051#section-7.5.2]]
573573
# for full description of the envelope fields, and
574574
# Net::IMAP@Message+envelope+and+body+structure for other relevant RFCs.
575575
#
@@ -583,7 +583,7 @@ class Envelope < Struct.new(:date, :subject, :from, :sender, :reply_to,
583583
# Returns a string that represents the +Date+ header.
584584
#
585585
# [Note]
586-
# For a well-formed [RFC5322[https://tools.ietf.org/html/rfc5322]]
586+
# For a well-formed [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]]
587587
# message, the #date field must not be +nil+. However it can be +nil+
588588
# for a malformed or draft message.
589589

@@ -609,7 +609,7 @@ class Envelope < Struct.new(:date, :subject, :from, :sender, :reply_to,
609609
# returns +nil+ for this envelope field.
610610
#
611611
# [Note]
612-
# For a well-formed [RFC5322[https://tools.ietf.org/html/rfc5322]]
612+
# For a well-formed [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]]
613613
# message, the #from field must not be +nil+. However it can be +nil+
614614
# for a malformed or draft message.
615615

@@ -622,7 +622,7 @@ class Envelope < Struct.new(:date, :subject, :from, :sender, :reply_to,
622622
# [Note]
623623
# If the <tt>Sender</tt> header is absent, or is present but empty, the
624624
# server sets this field to be the same value as #from. Therefore, in a
625-
# well-formed [RFC5322[https://tools.ietf.org/html/rfc5322]] message,
625+
# well-formed [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]] message,
626626
# the #sender envelope field must not be +nil+. However it can be
627627
# +nil+ for a malformed or draft message.
628628

@@ -636,7 +636,7 @@ class Envelope < Struct.new(:date, :subject, :from, :sender, :reply_to,
636636
# [Note]
637637
# If the <tt>Reply-To</tt> header is absent, or is present but empty,
638638
# the server sets this field to be the same value as #from. Therefore,
639-
# in a well-formed [RFC5322[https://tools.ietf.org/html/rfc5322]]
639+
# in a well-formed [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]]
640640
# message, the #reply_to envelope field must not be +nil+. However it
641641
# can be +nil+ for a malformed or draft message.
642642

@@ -665,7 +665,7 @@ class Envelope < Struct.new(:date, :subject, :from, :sender, :reply_to,
665665
# Returns a string that represents the <tt>In-Reply-To</tt> header.
666666
#
667667
# [Note]
668-
# For a well-formed [RFC5322[https://tools.ietf.org/html/rfc5322]]
668+
# For a well-formed [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]]
669669
# message, the #in_reply_to field, if present, must not be empty. But
670670
# it can still return an empty string for malformed messages.
671671
#
@@ -681,7 +681,7 @@ class Envelope < Struct.new(:date, :subject, :from, :sender, :reply_to,
681681
# Returns a string that represents the <tt>Message-ID</tt>.
682682
#
683683
# [Note]
684-
# For a well-formed [RFC5322[https://tools.ietf.org/html/rfc5322]]
684+
# For a well-formed [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]]
685685
# message, the #message_id field, if present, must not be empty. But it
686686
# can still return an empty string for malformed messages.
687687
#
@@ -698,7 +698,7 @@ class Envelope < Struct.new(:date, :subject, :from, :sender, :reply_to,
698698
# === Group syntax
699699
#
700700
# When the #host field is +nil+, this is a special form of address structure
701-
# that indicates the [RFC5322[https://tools.ietf.org/html/rfc5322]] group
701+
# that indicates the [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]] group
702702
# syntax. If the #mailbox name field is also +nil+, this is an end-of-group
703703
# marker (semicolon in RFC-822 syntax). If the #mailbox name field is
704704
# non-+NIL+, this is the start of a group marker, and the mailbox #name
@@ -708,7 +708,7 @@ class Address < Struct.new(:name, :route, :mailbox, :host)
708708
# method: name
709709
# :call-seq: name -> string or nil
710710
#
711-
# Returns the [RFC5322[https://tools.ietf.org/html/rfc5322]] address
711+
# Returns the [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]] address
712712
# +display-name+ (or the mailbox +phrase+ in the RFC-822 grammar).
713713

714714
##
@@ -718,28 +718,28 @@ class Address < Struct.new(:name, :route, :mailbox, :host)
718718
# Returns the route from RFC-822 route-addr.
719719
#
720720
# Note:: Generating this obsolete route addressing syntax is not allowed
721-
# by [RFC5322[https://tools.ietf.org/html/rfc5322]]. However,
721+
# by [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]]. However,
722722
# addresses with this syntax must still be accepted and parsed.
723723

724724
##
725725
# method: mailbox
726726
# :call-seq: mailbox -> string or nil
727727
#
728-
# Returns the [RFC5322[https://tools.ietf.org/html/rfc5322]] address
728+
# Returns the [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]] address
729729
# +local-part+, if #host is not +nil+.
730730
#
731731
# When #host is +nil+, this returns
732-
# an [RFC5322[https://tools.ietf.org/html/rfc5322]] group name and a +nil+
732+
# an [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]] group name and a +nil+
733733
# mailbox indicates the end of a group.
734734

735735
##
736736
# method: host
737737
# :call-seq: host -> string or nil
738738
#
739-
# Returns the [RFC5322[https://tools.ietf.org/html/rfc5322]] addr-spec
739+
# Returns the [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]] addr-spec
740740
# +domain+ name.
741741
#
742-
# +nil+ indicates [RFC5322[https://tools.ietf.org/html/rfc5322]] group
742+
# +nil+ indicates [RFC5322[https://www.rfc-editor.org/rfc/rfc5322]] group
743743
# syntax.
744744
end
745745

@@ -751,14 +751,14 @@ class ContentDisposition < Struct.new(:dsp_type, :param)
751751
# :call-seq: dsp_type -> string
752752
#
753753
# Returns the content disposition type, as defined by
754-
# [DISPOSITION[https://tools.ietf.org/html/rfc2183]].
754+
# [DISPOSITION[https://www.rfc-editor.org/rfc/rfc2183]].
755755

756756
##
757757
# method: param
758758
# :call-seq: param -> hash
759759
#
760760
# Returns a hash representing parameters of the Content-Disposition
761-
# field, as defined by [DISPOSITION[https://tools.ietf.org/html/rfc2183]].
761+
# field, as defined by [DISPOSITION[https://www.rfc-editor.org/rfc/rfc2183]].
762762
end
763763

764764
# Net::IMAP::ThreadMember represents a thread-node returned
@@ -797,8 +797,8 @@ def all_seqnos(node = self)
797797
# FetchData#attr value. Although these classes don't share a base class,
798798
# this module can be used to pattern match all of them.
799799
#
800-
# See {[IMAP4rev1] §7.4.2}[https://www.rfc-editor.org/rfc/rfc3501.html#section-7.4.2]
801-
# and {[IMAP4rev2] §7.5.2}[https://www.rfc-editor.org/rfc/rfc9051.html#section-7.5.2-4.9]
800+
# See {[IMAP4rev1] §7.4.2}[https://www.rfc-editor.org/rfc/rfc3501#section-7.4.2]
801+
# and {[IMAP4rev2] §7.5.2}[https://www.rfc-editor.org/rfc/rfc9051#section-7.5.2-4.9]
802802
# for full description of all +BODYSTRUCTURE+ fields, and also
803803
# Net::IMAP@Message+envelope+and+body+structure for other relevant RFCs.
804804
#
@@ -820,8 +820,8 @@ module BodyStructure
820820
# message parts, unless they have a <tt>Content-Type</tt> that is handled by
821821
# BodyTypeText, BodyTypeMessage, or BodyTypeMultipart.
822822
#
823-
# See {[IMAP4rev1] §7.4.2}[https://www.rfc-editor.org/rfc/rfc3501.html#section-7.4.2]
824-
# and {[IMAP4rev2] §7.5.2}[https://www.rfc-editor.org/rfc/rfc9051.html#section-7.5.2-4.9]
823+
# See {[IMAP4rev1] §7.4.2}[https://www.rfc-editor.org/rfc/rfc3501#section-7.4.2]
824+
# and {[IMAP4rev2] §7.5.2}[https://www.rfc-editor.org/rfc/rfc9051#section-7.5.2-4.9]
825825
# for full description of all +BODYSTRUCTURE+ fields, and also
826826
# Net::IMAP@Message+envelope+and+body+structure for other relevant RFCs.
827827
#
@@ -838,45 +838,45 @@ class BodyTypeBasic < Struct.new(:media_type, :subtype,
838838
# :call-seq: media_type -> string
839839
#
840840
# The top-level media type as defined in
841-
# [MIME-IMB[https://tools.ietf.org/html/rfc2045]].
841+
# [MIME-IMB[https://www.rfc-editor.org/rfc/rfc2045]].
842842

843843
##
844844
# method: subtype
845845
# :call-seq: subtype -> string
846846
#
847847
# The media subtype name as defined in
848-
# [MIME-IMB[https://tools.ietf.org/html/rfc2045]].
848+
# [MIME-IMB[https://www.rfc-editor.org/rfc/rfc2045]].
849849

850850
##
851851
# method: param
852852
# :call-seq: param -> string
853853
#
854854
# Returns a hash that represents parameters as defined in
855-
# [MIME-IMB[https://tools.ietf.org/html/rfc2045]].
855+
# [MIME-IMB[https://www.rfc-editor.org/rfc/rfc2045]].
856856

857857
##
858858
# method: content_id
859859
# :call-seq: content_id -> string
860860
#
861861
# Returns a string giving the content id as defined
862-
# in [MIME-IMB[https://tools.ietf.org/html/rfc2045]]
863-
# {§7}[https://tools.ietf.org/html/rfc2045#section-7].
862+
# in [MIME-IMB[https://www.rfc-editor.org/rfc/rfc2045]]
863+
# {§7}[https://www.rfc-editor.org/rfc/rfc2045#section-7].
864864

865865
##
866866
# method: description
867867
# :call-seq: description -> string
868868
#
869869
# Returns a string giving the content description as defined
870-
# in [MIME-IMB[https://tools.ietf.org/html/rfc2045]]
871-
# {§8}[https://tools.ietf.org/html/rfc2045#section-8].
870+
# in [MIME-IMB[https://www.rfc-editor.org/rfc/rfc2045]]
871+
# {§8}[https://www.rfc-editor.org/rfc/rfc2045#section-8].
872872

873873
##
874874
# method: encoding
875875
# :call-seq: encoding -> string
876876
#
877877
# Returns a string giving the content transfer encoding as defined
878-
# in [MIME-IMB[https://tools.ietf.org/html/rfc2045]]
879-
# {§6}[https://tools.ietf.org/html/rfc2045#section-6].
878+
# in [MIME-IMB[https://www.rfc-editor.org/rfc/rfc2045]]
879+
# {§6}[https://www.rfc-editor.org/rfc/rfc2045#section-6].
880880

881881
##
882882
# method: size
@@ -889,15 +889,15 @@ class BodyTypeBasic < Struct.new(:media_type, :subtype,
889889
# :call-seq: md5 -> string
890890
#
891891
# Returns a string giving the body MD5 value as defined in
892-
# [MD5[https://tools.ietf.org/html/rfc1864]].
892+
# [MD5[https://www.rfc-editor.org/rfc/rfc1864]].
893893

894894
##
895895
# method: disposition
896896
# :call-seq: disposition -> ContentDisposition
897897
#
898898
# Returns a ContentDisposition object giving the content
899899
# disposition, as defined by
900-
# [DISPOSITION[https://tools.ietf.org/html/rfc2183]].
900+
# [DISPOSITION[https://www.rfc-editor.org/rfc/rfc2183]].
901901

902902
##
903903
# method: language
@@ -1065,7 +1065,7 @@ class BodyTypeMultipart < Struct.new(:media_type, :subtype,
10651065
# call-seq: subtype -> string
10661066
#
10671067
# Returns the content subtype name
1068-
# as defined in [MIME-IMB[https://tools.ietf.org/html/rfc2045]].
1068+
# as defined in [MIME-IMB[https://www.rfc-editor.org/rfc/rfc2045]].
10691069

10701070
##
10711071
# method: parts
@@ -1079,7 +1079,7 @@ class BodyTypeMultipart < Struct.new(:media_type, :subtype,
10791079
# call-seq: param -> hash
10801080
#
10811081
# Returns a hash that represents parameters
1082-
# as defined in [MIME-IMB[https://tools.ietf.org/html/rfc2045]].
1082+
# as defined in [MIME-IMB[https://www.rfc-editor.org/rfc/rfc2045]].
10831083

10841084
##
10851085
# method: disposition

lib/net/imap/sasl.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ class IMAP
55

66
# Pluggable authentication mechanisms for protocols which support SASL
77
# (Simple Authentication and Security Layer), such as IMAP4, SMTP, LDAP, and
8-
# XMPP. {RFC-4422}[https://tools.ietf.org/html/rfc4422] specifies the
8+
# XMPP. {RFC-4422}[https://www.rfc-editor.org/rfc/rfc4422] specifies the
99
# common \SASL framework:
1010
# >>>
1111
# SASL is conceptually a framework that provides an abstraction layer

lib/net/imap/sasl/anonymous_authenticator.rb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ class IMAP < Protocol
55
module SASL
66

77
# Authenticator for the "+ANONYMOUS+" SASL mechanism, as specified by
8-
# RFC-4505[https://tools.ietf.org/html/rfc4505]. See
8+
# RFC-4505[https://www.rfc-editor.org/rfc/rfc4505]. See
99
# Net::IMAP#authenticate.
1010
class AnonymousAuthenticator
1111

1212
# An optional token sent for the +ANONYMOUS+ mechanism., up to 255 UTF-8
1313
# characters in length.
1414
#
1515
# If it contains an "@" sign, the message must be a valid email address
16-
# (+addr-spec+ from RFC-2822[https://tools.ietf.org/html/rfc2822]).
16+
# (+addr-spec+ from RFC-2822[https://www.rfc-editor.org/rfc/rfc2822]).
1717
# Email syntax is _not_ validated by AnonymousAuthenticator.
1818
#
1919
# Otherwise, it can be any UTF8 string which is permitted by the
@@ -25,7 +25,7 @@ class AnonymousAuthenticator
2525
# new(anonymous_message: "", **) -> authenticator
2626
#
2727
# Creates an Authenticator for the "+ANONYMOUS+" SASL mechanism, as
28-
# specified in RFC-4505[https://tools.ietf.org/html/rfc4505]. To use
28+
# specified in RFC-4505[https://www.rfc-editor.org/rfc/rfc4505]. To use
2929
# this, see Net::IMAP#authenticate or your client's authentication
3030
# method.
3131
#

lib/net/imap/sasl/cram_md5_authenticator.rb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# frozen_string_literal: true
22

33
# Authenticator for the "+CRAM-MD5+" SASL mechanism, specified in
4-
# RFC2195[https://tools.ietf.org/html/rfc2195]. See Net::IMAP#authenticate.
4+
# RFC2195[https://www.rfc-editor.org/rfc/rfc2195]. See Net::IMAP#authenticate.
55
#
66
# == Deprecated
77
#
88
# +CRAM-MD5+ is obsolete and insecure. It is included for compatibility with
99
# existing servers.
10-
# {draft-ietf-sasl-crammd5-to-historic}[https://tools.ietf.org/html/draft-ietf-sasl-crammd5-to-historic-00.html]
10+
# {draft-ietf-sasl-crammd5-to-historic}[https://www.rfc-editor.org/rfc/draft-ietf-sasl-crammd5-to-historic-00.html]
1111
# recommends using +SCRAM-*+ or +PLAIN+ protected by TLS instead.
1212
#
13-
# Additionally, RFC8314[https://tools.ietf.org/html/rfc8314] discourage the use
13+
# Additionally, RFC8314[https://www.rfc-editor.org/rfc/rfc8314] discourage the use
1414
# of cleartext and recommends TLS version 1.2 or greater be used for all
1515
# traffic. With TLS +CRAM-MD5+ is okay, but so is +PLAIN+
1616
class Net::IMAP::SASL::CramMD5Authenticator

lib/net/imap/sasl/digest_md5_authenticator.rb

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# frozen_string_literal: true
22

33
# Net::IMAP authenticator for the +DIGEST-MD5+ SASL mechanism type, specified
4-
# in RFC-2831[https://tools.ietf.org/html/rfc2831]. See Net::IMAP#authenticate.
4+
# in RFC-2831[https://www.rfc-editor.org/rfc/rfc2831]. See Net::IMAP#authenticate.
55
#
66
# == Deprecated
77
#
88
# "+DIGEST-MD5+" has been deprecated by
9-
# RFC-6331[https://tools.ietf.org/html/rfc6331] and should not be relied on for
9+
# RFC-6331[https://www.rfc-editor.org/rfc/rfc6331] and should not be relied on for
1010
# security. It is included for compatibility with existing servers.
1111
class Net::IMAP::SASL::DigestMD5Authenticator
1212
DataFormatError = Net::IMAP::DataFormatError
@@ -37,10 +37,10 @@ class Net::IMAP::SASL::DigestMD5Authenticator
3737

3838
# Authentication identity: the identity that matches the #password.
3939
#
40-
# RFC-2831[https://tools.ietf.org/html/rfc2831] uses the term +username+.
40+
# RFC-2831[https://www.rfc-editor.org/rfc/rfc2831] uses the term +username+.
4141
# "Authentication identity" is the generic term used by
42-
# RFC-4422[https://tools.ietf.org/html/rfc4422].
43-
# RFC-4616[https://tools.ietf.org/html/rfc4616] and many later RFCs abbreviate
42+
# RFC-4422[https://www.rfc-editor.org/rfc/rfc4422].
43+
# RFC-4616[https://www.rfc-editor.org/rfc/rfc4616] and many later RFCs abbreviate
4444
# this to +authcid+.
4545
attr_reader :username
4646
alias authcid username
@@ -85,15 +85,15 @@ class Net::IMAP::SASL::DigestMD5Authenticator
8585
# must be set appropriately to use authenticators in other protocols.
8686
#
8787
# If an IANA-registered name isn't available, GSS-API
88-
# (RFC-2743[https://tools.ietf.org/html/rfc2743]) allows the generic name
88+
# (RFC-2743[https://www.rfc-editor.org/rfc/rfc2743]) allows the generic name
8989
# "host".
9090
attr_reader :service
9191

9292
# The generic server name when the server is replicated.
9393
#
9494
# +service_name+ will be ignored when it is +nil+ or identical to +host+.
9595
#
96-
# From RFC-2831[https://tools.ietf.org/html/rfc2831]:
96+
# From RFC-2831[https://www.rfc-editor.org/rfc/rfc2831]:
9797
# >>>
9898
# The service is considered to be replicated if the client's
9999
# service-location process involves resolution using standard DNS lookup
@@ -176,7 +176,7 @@ def initialize(user = nil, pass = nil, authz = nil,
176176
@nc, @stage = {}, STAGE_ONE
177177
end
178178

179-
# From RFC-2831[https://tools.ietf.org/html/rfc2831]:
179+
# From RFC-2831[https://www.rfc-editor.org/rfc/rfc2831]:
180180
# >>>
181181
# Indicates the principal name of the service with which the client wishes
182182
# to connect, formed from the serv-type, host, and serv-name. For

0 commit comments

Comments
 (0)